Transfers a thread from one agent to another one or to the routing queue. In the request, you must provide one of the following parameters for the transfer: userIds, skillIds, unitIds.
Request Parameters
| Parameter | Type | Description |
transferMode | string (enum) | One of the following transfer modes: • TO_FREE_SLOT – The system tries to find agents with free slots, fails if no agent with free slots is found.• TO_READY_OPERATOR – First, the system tries to find an agent with free slots.If not found, then it tries to find a “Ready” agent and use their extra slot if allowed, fails if no “Ready” agent is found. The thread is transferred to routing if no agent is found or using extra slots is not allowed. • TO_ROUTING – First, the system tries to find an agent with free slots. If it doesn’t, it tries to find a “Ready” agent and use their extra slot if allowed. The thread is transferred to routing if no agent is found or using extra slots is not allowed. |
userIds | array of longs | List of target agent IDs to transfer the thread to |
skillIds | array of longs | List of skill IDs of target agents to transfer the thread to |
unitIds | array of longs | List of department IDs to transfer the thread to |
comment | string (optional) | Additional information about the transfer for the target agent |
HTTP Request
PUT /api/v1/threads/2/transfer HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 130
Host: localhost: 8080
{
"transferMode": "TO_FREE_SLOT",
"userIds": [
1
],
"skillIds": null,
"unitIds": null,
"comment": "comment"
}
Example of a Successful HTTP Response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 187
{
"id": 2,
"type": "NORMAL",
"operator": {
"id": 1,
"name": null,
"alias": null,
"role": null,
"maxThreads": null,
"photoUrl": null
}
}