POST callbacks

Purpose: Creates a new callback task request.

Most important parameters that can be provided:

Due Date when this task should be added to the Service Queue of the provided Service
Service this callback request will be executed on behalf
Target to be called
The priority of this task
The number of times an unsuccessful dial-out is retried and how long the system should wait in-between
A comment which will be displayed to the agent who accepts the dial-out (MAX LENGTH: 150 chars)
An ExternalTaskId that can be used as a unique identifier (f.e. a CRM customer interaction/task identifier from an external CRM system)

Request URI	/v1.0/callbacks
Method	POST

Parameters Description

callback *

(body)

Parameters for the new callback. See CreateCallbackDto description.

Example

{
  "Target": "string",
  "AlternativeTarget": "string",
  "MaxRetries": 0,
  "SecondsBetweenRetries": 0,
  "ServiceId": "string",
  "ServiceSip": "string",
  "IncomingServiceSipUri": "string",
  "Priority": "StrictPriority",
  "ContextUrl": "string",
  "DueDate": "2019-06-14 08:07:13",
  "Supervisor": "string",
  "Description": "string",
  "ExternalTaskId": "string",
  "CallerId": "string"
}

CODE

Responses

Code Description / Example

200


 {
  "Target": "string",
  "AlternativeTarget": "string",
  "MaxRetries": 0,
  "SecondsBetweenRetries": 0,
  "ServiceId": "string",
  "ServiceSip": "string",
  "IncomingServiceSipUri": "string",
  "Priority": "StrictPriority",
  "ContextUrl": "string",
  "DueDate": "2019-06-14 09:36:12",
  "Supervisor": "string",
  "Description": "string",
  "ExternalTaskId": "string",
  "CallerId": "string",
  "Id": "string",
  "Creator": "WfActivity",
  "LeftInQueueTimeInSeconds": 0,
  "AppPoolId": "string",
  "InitiatingSessionId": "string",
  "Initiator": "string",
  "State": "Pending",
  "RetryType": "SingleSession",
  "RetryCount": 0
}

CODE

500

{
  "Error": {
    "Code": "NotInitialized",
    "Message": "string"
  }
}

CODE