Sinch Contact Center Restful Task Interface (RTI) version v1

http://localhost:8080/RTI

Description

This interface implements RESTful version for task management for Sinch Contact Center. It requires that Task Management Interface is installed as well.

Request Header Data Requirements

To GET JSON response, the request must have "Accept = application/json" header.

To GET XML response, the request should have "Accept = application/xml" header.

To POST/PUT JSON data, the request must have "Content-Type = application/json" header.

To POST/PUT XML data, the request should have "Content-Type = application/xml" header.

POST should also have "Accept = text/html" header. It returns the ID of the created object.

PUT and DELETE do not have any response, instead they return code 201 (No Content).

/tasks

Collection of tasks.

/tasks get post

get

Get all open tasks.

post

Add new task. Returns the ID of the created task.

Get all open tasks.

Request
Response

Query Parameters

sort: (string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: taskItem

id: (string)
type: (string)
queue: (string)
queueName: (string)
responsible: (string)
status: (string)
rowVersion: (string)

Example:

[
  {
    "id": "C31EBB45D0FD49B983C307BF811DDFBA",
    "type": "XRI",
    "queue": "5283266B09B446F0B7957B1704C3A629",
    "queueName": "Task Queue",
    "responsible": "92BAC2A45BBC4CCFB62FD9EA9B413055",
    "status": "Handled",
    "rowVersion": "00000000017A26A7"
  },
  {
    "id": "853DAA4A58734DB9AA7D0D87B98D99A6",
    "type": "XRI",
    "queue": "5283266B09B446F0B7957B1704C3A629",
    "queueName": "Task Queue",
    "responsible": "92BAC2A45BBC4CCFB62FD9EA9B413055",
    "status": "Open",
    "rowVersion": "00000000017A24E8"
  },
  {
        "id": "95EDDA2434FBEE11AC250281A3237849",
        "type": "EMAIL",
        "queue": "7D1CF527B0A040BA98A2342F4657992F",
        "queueName": "SalesTaskQueue",
        "responsible": "26364A4DFA9F413AA5A5F99F96F38B8E",
        "status": "Handled",
        "rowVersion": "000000000173D0E2"
    }
]

Add new task. Returns the ID of the created task.

Request
Response

Body

Media type: application/json

Type: object

Properties

data: required(object)
- item: (object)
  - id: (string)
  - type: (string)
  - queue: (string)
  - queueName: (string)
  - responsible: (string)
  - status: (string)
  - rowVersion: (string)
- caseId: (string)
- cid: (string)
- subject: (string)
- created: required(any)
- creator: (string)
- priority: required(number)
- warningTime: required(any)
- criticalTime: required(any)
- fromAddress: (string)
- toAddress: (string)
- toAddressAnswer: (string)
- ccAddressAnswer: (string)
- bccAddressAnswer: (string)
- firstModifier: (string)
- firstModified: required(any)
- lastModifier: (string)
- lastModified: required(any)
- solutionDate: required(any)
- customer: (string)
- index: required(number)
- values: (object)
  - KV: (array of object)
    Items: items
    - K: (string)
    - v: (string)
- attachments: (object)
  - Attachment: (array of object)
    Items: items
    - id: (string)
    - filename: (string)
    - creator: (string)
    - created: required(datetime)
    - ext: (string)
    - size: (number)
    - path: (string)
    - data: (array of number)
- body: (string)
skills: (object)
- Skill: (array of object)
  Items: items
  - id: (string)
  - value: (string)
requiredAgents: (object)
- expiryTime: required(number)
- agents: (object)
  - RequiredAgent: (array of object)
    Items: items
    - id: (string)
    - login: (string)

Example:

{
  "data": {
    "item": {
      "type": "XRI",
      "queue": "task.queue@acme.com"
    },
    "subject": "Service request",
    "body": "Can be used for e-mail keyword routing by CEM",
    "fromAddress": "john.doe@work.corp",
    "toAddress": "task.queue@acme.com",
    "values": {
      "KV": [
        {
          "k": "XRI-body",
          "v": "Call customer and book service for customer John Doe. Including new winter tires"
        },
        {
          "k": "ticketId",
          "v": "1234"
        }
      ]
    }
  },
  "skills": {
    "Skill": [
      {
        "id": "EN",
        "value": "2"
      },
      {
        "id": "ExtSkill",
        "value": "3"
      }
    ]
  },
  "requiredAgents": {
    "expiryTime": 123,
    "agents": {
      "RequiredAgent": [
        {
          "login": "agent1"
        },
        {
          "login": "agent2"
        }
      ]
    }
  }
}

Media type: application/xml

Type: object

Properties

data: required(object)
- item: (object)
  - id: (string)
  - type: (string)
  - queue: (string)
  - queueName: (string)
  - responsible: (string)
  - status: (string)
  - rowVersion: (string)
- caseId: (string)
- cid: (string)
- subject: (string)
- created: required(any)
- creator: (string)
- priority: required(number)
- warningTime: required(any)
- criticalTime: required(any)
- fromAddress: (string)
- toAddress: (string)
- toAddressAnswer: (string)
- ccAddressAnswer: (string)
- bccAddressAnswer: (string)
- firstModifier: (string)
- firstModified: required(any)
- lastModifier: (string)
- lastModified: required(any)
- solutionDate: required(any)
- customer: (string)
- index: required(number)
- values: (object)
  - KV: (array of object)
    Items: items
    - K: (string)
    - v: (string)
- attachments: (object)
  - Attachment: (array of object)
    Items: items
    - id: (string)
    - filename: (string)
    - creator: (string)
    - created: required(datetime)
    - ext: (string)
    - size: (number)
    - path: (string)
    - data: (array of number)
- body: (string)
skills: (object)
- Skill: (array of object)
  Items: items
  - id: (string)
  - value: (string)
requiredAgents: (object)
- expiryTime: required(number)
- agents: (object)
  - RequiredAgent: (array of object)
    Items: items
    - id: (string)
    - login: (string)

Example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<createtask>
    <data>
        <item>
            <id>str1234</id>
            <type>str1234</type>
            <queue>str1234</queue>
            <queueName>str1234</queueName>
            <responsible>str1234</responsible>
            <status>str1234</status>
            <rowVersion>str1234</rowVersion>
            <_serverDate>str1234</_serverDate>
        </item>
        <caseId>str1234</caseId>
        <cid>str1234</cid>
        <subject>str1234</subject>
        <created>1991-01-24'PSL'13:05:33</created>
        <creator>str1234</creator>
        <priority>123</priority>
        <warningTime>1991-01-24'PSL'13:05:33</warningTime>
        <criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
        <fromAddress>str1234</fromAddress>
        <toAddress>str1234</toAddress>
        <toAddressAnswer>str1234</toAddressAnswer>
        <ccAddressAnswer>str1234</ccAddressAnswer>
        <bccAddressAnswer>str1234</bccAddressAnswer>
        <firstModifier>str1234</firstModifier>
        <firstModified>1991-01-24'PSL'13:05:33</firstModified>
        <lastModifier>str1234</lastModifier>
        <lastModified>1991-01-24'PSL'13:05:33</lastModified>
        <solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
        <customer>str1234</customer>
        <index>123</index>
        <values>
            <KV>
                <k>str1234</k>
                <v>str1234</v>
            </KV>
            <KV>
                <k>str1234</k>
                <v>str1234</v>
            </KV>
        </values>
        <attachments>
            <Attachment>
                <id>str1234</id>
                <filename>str1234</filename>
                <creator>str1234</creator>
                <created>1991-01-24'PSL'13:05:33</created>
                <ext>str1234</ext>
                <size>123</size>
                <path>str1234</path>
                <data>123</data>
                <data>123</data>
            </Attachment>
            <Attachment>
                <id>str1234</id>
                <filename>str1234</filename>
                <creator>str1234</creator>
                <created>1991-01-24'PSL'13:05:33</created>
                <ext>str1234</ext>
                <size>123</size>
                <path>str1234</path>
                <data>123</data>
                <data>123</data>
            </Attachment>
        </attachments>
        <body>str1234</body>
    </data>
    <skills>
        <Skill>
            <id>str1234</id>
            <value>123</value>
        </Skill>
        <Skill>
            <id>str1234</id>
            <value>123</value>
        </Skill>
    </skills>
    <requiredAgents>
        <expiryTime>123</expiryTime>
        <agents>
            <RequiredAgent>
                <id>str1234</id>
                <login>str1234</login>
            </RequiredAgent>
            <RequiredAgent>
                <id>str1234</id>
                <login>str1234</login>
            </RequiredAgent>
        </agents>
    </requiredAgents>
</createtask>

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

/tasks/{id} get put delete

Entity representing a task.

get

Get contents of one task.

put

Update one task.

delete

Delete one task. Task status is changed to Deleted.

Get contents of one task.

Request
Response

URI Parameters

id: required(string)

Query Parameters

filter: (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

item: (object)
- id: (string)
- type: (string)
- queue: (string)
- queueName: (string)
- responsible: (string)
- status: (string)
- rowVersion: (string)
caseId: (string)
cid: (string)
subject: (string)
created: required(any)
creator: (string)
priority: required(number)
warningTime: required(any)
criticalTime: required(any)
fromAddress: (string)
toAddress: (string)
toAddressAnswer: (string)
ccAddressAnswer: (string)
bccAddressAnswer: (string)
firstModifier: (string)
firstModified: required(any)
lastModifier: (string)
lastModified: required(any)
solutionDate: required(any)
customer: (string)
index: required(number)
values: (object)
- KV: (array of object)
  Items: items
  - K: (string)
  - v: (string)
attachments: (object)
- Attachment: (array of object)
  Items: items
  - id: (string)
  - filename: (string)
  - creator: (string)
  - created: required(datetime)
  - ext: (string)
  - size: (number)
  - path: (string)
  - data: (array of number)
body: (string)

Example:

{
  "item": {
    "type": "XRI",
    "queue": "Task Queue"
  },
  "subject": "Service request",
  "body": "Can be used for e-mail keyword routing by CEM",
  "fromAddress": "task.queue@acme.com",
  "toAddress": "task.queue@acme.com",
  "values": {
    "KV": [
      {
        "k": "XRI-body",
        "v": "Call customer and book service for customer John Doe. Including new winter tires"
      },
      {
        "k": "ticketId",
        "v": "1234"
      }
    ]
  }
}

Media type: application/xml

Type: object

Properties

item: (object)
- id: (string)
- type: (string)
- queue: (string)
- queueName: (string)
- responsible: (string)
- status: (string)
- rowVersion: (string)
caseId: (string)
cid: (string)
subject: (string)
created: required(any)
creator: (string)
priority: required(number)
warningTime: required(any)
criticalTime: required(any)
fromAddress: (string)
toAddress: (string)
toAddressAnswer: (string)
ccAddressAnswer: (string)
bccAddressAnswer: (string)
firstModifier: (string)
firstModified: required(any)
lastModifier: (string)
lastModified: required(any)
solutionDate: required(any)
customer: (string)
index: required(number)
values: (object)
- KV: (array of object)
  Items: items
  - K: (string)
  - v: (string)
attachments: (object)
- Attachment: (array of object)
  Items: items
  - id: (string)
  - filename: (string)
  - creator: (string)
  - created: required(datetime)
  - ext: (string)
  - size: (number)
  - path: (string)
  - data: (array of number)
body

Example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<taskdata>
    <item>
        <id>str1234</id>
        <type>str1234</type>
        <queue>str1234</queue>
        <queueName>str1234</queueName>
        <responsible>str1234</responsible>
        <status>str1234</status>
        <rowVersion>str1234</rowVersion>
        <_serverDate>str1234</_serverDate>
    </item>
    <caseId>str1234</caseId>
    <cid>str1234</cid>
    <subject>str1234</subject>
    <created>1991-01-24'PSL'13:05:33</created>
    <creator>str1234</creator>
    <priority>123</priority>
    <warningTime>1991-01-24'PSL'13:05:33</warningTime>
    <criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
    <fromAddress>str1234</fromAddress>
    <toAddress>str1234</toAddress>
    <toAddressAnswer>str1234</toAddressAnswer>
    <ccAddressAnswer>str1234</ccAddressAnswer>
    <bccAddressAnswer>str1234</bccAddressAnswer>
    <firstModifier>str1234</firstModifier>
    <firstModified>1991-01-24'PSL'13:05:33</firstModified>
    <lastModifier>str1234</lastModifier>
    <lastModified>1991-01-24'PSL'13:05:33</lastModified>
    <solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
    <customer>str1234</customer>
    <index>123</index>
    <values>
        <KV>
            <k>str1234</k>
            <v>str1234</v>
        </KV>
        <KV>
            <k>str1234</k>
            <v>str1234</v>
        </KV>
    </values>
    <attachments>
        <Attachment>
            <id>str1234</id>
            <filename>str1234</filename>
            <creator>str1234</creator>
            <created>1991-01-24'PSL'13:05:33</created>
            <ext>str1234</ext>
            <size>123</size>
            <path>str1234</path>
            <data>123</data>
            <data>123</data>
        </Attachment>
        <Attachment>
            <id>str1234</id>
            <filename>str1234</filename>
            <creator>str1234</creator>
            <created>1991-01-24'PSL'13:05:33</created>
            <ext>str1234</ext>
            <size>123</size>
            <path>str1234</path>
            <data>123</data>
            <data>123</data>
        </Attachment>
    </attachments>
    <body>str1234</body>
</taskdata>

Update one task.

Request
Response

URI Parameters

id: required(string)

Body

Media type: application/json

Type: object

Properties

item: (object)
- id: (string)
- type: (string)
- queue: (string)
- queueName: (string)
- responsible: (string)
- status: (string)
- rowVersion: (string)
caseId: (string)
cid: (string)
subject: (string)
created: required(any)
creator: (string)
priority: required(number)
warningTime: required(any)
criticalTime: required(any)
fromAddress: (string)
toAddress: (string)
toAddressAnswer: (string)
ccAddressAnswer: (string)
bccAddressAnswer: (string)
firstModifier: (string)
firstModified: required(any)
lastModifier: (string)
lastModified: required(any)
solutionDate: required(any)
customer: (string)
index: required(number)
values: (object)
- KV: (array of object)
  Items: items
  - K: (string)
  - v: (string)
attachments: (object)
- Attachment: (array of object)
  Items: items
  - id: (string)
  - filename: (string)
  - creator: (string)
  - created: required(datetime)
  - ext: (string)
  - size: (number)
  - path: (string)
  - data: (array of number)
body: (string)

Example:

{
  "item": {
    "type": "XRI",
    "queue": "Task Queue"
  },
  "subject": "Service request",
  "body": "Can be used for e-mail keyword routing by CEM",
  "fromAddress": "task.queue@acme.com",
  "toAddress": "task.queue@acme.com",
  "values": {
    "KV": [
      {
        "k": "XRI-body",
        "v": "Call customer and book service for customer John Doe. Including new winter tires"
      },
      {
        "k": "ticketId",
        "v": "1234"
      }
    ]
  }
}

Media type: application/xml

Type: object

Properties

item: (object)
- id: (string)
- type: (string)
- queue: (string)
- queueName: (string)
- responsible: (string)
- status: (string)
- rowVersion: (string)
caseId: (string)
cid: (string)
subject: (string)
created: required(any)
creator: (string)
priority: required(number)
warningTime: required(any)
criticalTime: required(any)
fromAddress: (string)
toAddress: (string)
toAddressAnswer: (string)
ccAddressAnswer: (string)
bccAddressAnswer: (string)
firstModifier: (string)
firstModified: required(any)
lastModifier: (string)
lastModified: required(any)
solutionDate: required(any)
customer: (string)
index: required(number)
values: (object)
- KV: (array of object)
  Items: items
  - K: (string)
  - v: (string)
attachments: (object)
- Attachment: (array of object)
  Items: items
  - id: (string)
  - filename: (string)
  - creator: (string)
  - created: required(datetime)
  - ext: (string)
  - size: (number)
  - path: (string)
  - data: (array of number)
body

Example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<taskdata>
    <item>
        <id>str1234</id>
        <type>str1234</type>
        <queue>str1234</queue>
        <queueName>str1234</queueName>
        <responsible>str1234</responsible>
        <status>str1234</status>
        <rowVersion>str1234</rowVersion>
        <_serverDate>str1234</_serverDate>
    </item>
    <caseId>str1234</caseId>
    <cid>str1234</cid>
    <subject>str1234</subject>
    <created>1991-01-24'PSL'13:05:33</created>
    <creator>str1234</creator>
    <priority>123</priority>
    <warningTime>1991-01-24'PSL'13:05:33</warningTime>
    <criticalTime>1991-01-24'PSL'13:05:33</criticalTime>
    <fromAddress>str1234</fromAddress>
    <toAddress>str1234</toAddress>
    <toAddressAnswer>str1234</toAddressAnswer>
    <ccAddressAnswer>str1234</ccAddressAnswer>
    <bccAddressAnswer>str1234</bccAddressAnswer>
    <firstModifier>str1234</firstModifier>
    <firstModified>1991-01-24'PSL'13:05:33</firstModified>
    <lastModifier>str1234</lastModifier>
    <lastModified>1991-01-24'PSL'13:05:33</lastModified>
    <solutionDate>1991-01-24'PSL'13:05:33</solutionDate>
    <customer>str1234</customer>
    <index>123</index>
    <values>
        <KV>
            <k>str1234</k>
            <v>str1234</v>
        </KV>
        <KV>
            <k>str1234</k>
            <v>str1234</v>
        </KV>
    </values>
    <attachments>
        <Attachment>
            <id>str1234</id>
            <filename>str1234</filename>
            <creator>str1234</creator>
            <created>1991-01-24'PSL'13:05:33</created>
            <ext>str1234</ext>
            <size>123</size>
            <path>str1234</path>
            <data>123</data>
            <data>123</data>
        </Attachment>
        <Attachment>
            <id>str1234</id>
            <filename>str1234</filename>
            <creator>str1234</creator>
            <created>1991-01-24'PSL'13:05:33</created>
            <ext>str1234</ext>
            <size>123</size>
            <path>str1234</path>
            <data>123</data>
            <data>123</data>
        </Attachment>
    </attachments>
    <body>str1234</body>
</taskdata>

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete one task. Task status is changed to Deleted.

Request
Response

URI Parameters

id: required(string)

HTTP status code 204

The request was successful.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

Sinch Contact Center Restful Task Interface (RTI) version v1

Description

Request Header Data Requirements

/tasks

/tasks get post

get /tasks

Query Parameters

HTTP status code 200

Body

post /tasks

Body

HTTP status code 201

Body

/tasks/count get

get /tasks/count

HTTP status code 200

Body

/tasks/{id} get put delete

get /tasks/{id}

URI Parameters

Query Parameters

HTTP status code 200

Body

put /tasks/{id}

URI Parameters

Body

HTTP status code 204

delete /tasks/{id}

URI Parameters

HTTP status code 204

HTTP status code 404

Body