With the growing number of BOTS use-cases in the contact center industry, Webex Engage now exposes a transfer API that is currently in closed beta. If at all you intend to use this endpoint, please reach out to your Customer Success Representative / Account Manager. Although this endpoint is in private beta, it follows the same Authentication mechanism as mentioned in this doc above.
Below are the details of the API:
curl --location --request PATCH '<URL structure>' \
--header 'access_token: 0f66e2b7-1af0-4aa2-a4bb-777fdd72bd2c' \
--header 'Content-Type: application/json' \
--data-raw '{
"transfer": {
"teamid": "672",
"skill_name": "Electronics"
}
}'
Request Payload:
| Parameter | Data Type | Description |
|---|---|---|
| transfer | Transfer OBJECT | Contains details of the transfer request |
Transfer OBJECT:
| Parameter | Data Type | Description |
|---|---|---|
| teamid | integer | Unique identifier of the team the chat is to be transferred to |
| skill_name | string | Name of the skill within the team that the chat is to be mapped to (optional). If not passed, the chat will be assigned to the team's queue as usual. |
Note
Team IDs can be obtained using the GET /teams endpoints as a one-time request and stored/cached by the developer within their environment
HTTP status: 202 Accepted
{
"status_code": 4342,
"description": "Chat has been transferred successfully",
"response": ""
}