Allows the bot to create new distribution threads.
Request Body Parameters
| Parameter | Type | Description |
messages | list<object> | List of distribution messages |
messages.client.extId | string | Target client external ID |
messages.client.phoneNumber | string | Target client phone number |
routing | object | Routing parameters for the client. It will apply to the next thread only |
routing.skillId | long | Agent’s skill ID for routing |
routing.priority | long | Priority in the distribution queue relative to other threads. Default: 100 |
routing.expiredAt | date | Routing parameters expiration date |
channel | object (optional) | Channel parameters for the client |
channel.channelType | string (optional) | Target client channel type (MOBILE by default) |
channel.appMarker | string (optional) | AppMarker of the client application |
text | string | Distribution message text |
campaignName | string | Distribution message broadcast name. Will bind to the next thread for the client |
HTTP Request
POST /api/v1/chatbot/distributions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <chatbot_token>
Content-Length: 426
Host: localhost: 8080
{
"messages": [
{
"client": {
"extId": "qwerty123",
"phoneNumber": "89031234567"
},
"channel": {
"channelType": "WHATSAPP",
"appMarker": "test"
},
"routing": {
"skillId": 1,
"priority": 1,
"expiredAt": "2022-07-23T18:00:00+03:00"
},
"text": "message text",
"campaignName": "campaign name",
"chatMessageId": "uuid12344_12232"
}
]
}
Example of a Successful HTTP Response
HTTP/1.1 200 OK Vary: Origin Vary: Access-Control-Request-Method Vary: Access-Control-Request-Headers