Purpose: Create new task in the system. 

Request URI/v1.0/tasks

Method

POST

ParametersDescription

parameters *

(body)

Object that contains new Task properties.

Example
{
  "ExternalTaskId": "string",
  "Service": "string",
  "Caller": "string",
  "PreferredAgents": [
    "string"
  ],
  "ConsiderPreferredAgentsOnly": true,
  "Required": {
    "Im": true,
    "Audio": true,
    "Video": true,
    "DesktopSharing": true,
    "ConversationContext": true
  },
  "DistributeToAgent": true,
  "DistributeToAgentRONATimeoutInSeconds": 0
}
CODE

Responses

CodeDescription / Example 
200
{
  "Id": "string",
  "ExternalTaskId": "string",
  "Type": "string",
  "State": "string",
  "CustomerIdentifier": "string",
  "Created": "2019-06-14T08:44:20.816Z",
  "QueueStarted": "2019-06-14T08:44:20.816Z",
  "Connected": "2019-06-14T08:44:20.816Z",
  "InitialModalityType": "string",
  "OriginType": "string",
  "OriginTypeCustom": "string",
  "ContextParameters": [
    {
      "Name": "string",
      "Value": "string"
    }
  ],
  "ReservedUserObject": {
    "Id": "string",
    "DisplayName": "string",
    "OrganizationUnitName": "string",
    "SipUri": "string",
    "UserPrincipalName": "string",
    "SecurityIdentifier": "string",
    "SamAccountName": "string",
    "AgentProfileName": "string",
    "ResponsibleSinceLevel": 0,
    "SelectionAlgorithm": "string"
  }
}
CODE
500
{
  "Error": {
    "Code": "NotInitialized",
    "Message": "string"
  }
}
CODE