Чтобы отправить сообщение на определенное устройство, укажите его идентификатор в поле deviceAddress.
Разрешения
---- Permissions:INTEGRATOR,OPERATOR,SUPERVISOR ----
Пример curl
$ curl 'http://localhost:8080/api/v1/messages/outgoing-to-device' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <integrator_token>' \
-d '{
"text" : "message",
"attachments" : [ ],
"clientApplicationDescriptor" : {
"channelType" : "WHATSAPP",
"deviceAddress" : "89991234567"
}
}'
Примеры HTTP запросов
- Пример отправки сообщения в WhatsApp:
POST /api/v1/messages/outgoing-to-device HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 156
Host: localhost: 8080
{
"text": "message",
"attachments": [],
"clientApplicationDescriptor": {
"channelType": "WHATSAPP",
"deviceAddress": "89991234567"
}
}
- Пример отправки сообщения на мобильное устройство:
POST /api/v1/messages/outgoing-to-device HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 181
Host: localhost: 8080
{
"text": "message",
"attachments": [],
"clientApplicationDescriptor": {
"channelType": "MOBILE",
"clientId": "012-4393-3943-79",
"appMarker": "myApp"
}
}
Поля тела запроса
| Параметр | Тип | Описание |
text | string | Текст сообщения |
attachments | list of objects (необязательно) | Список вложений сообщения |
applicationDescriptor.channelType | string | Тип канала |
applicationDescriptor.clientId | string | Внешний ID авторизованного клиента |
applicationDescriptor.unauthorizedClientId | string (необязательно) | Внешний ID неавторизованного клиента |
applicationDescriptor.deviceAddress | string | Адрес устройства в данном channelType, куда вы хотите отправить сообщение |
applicationDescriptor.appMarker | string (необязательно) | Идентификатор приложения на данном устройстве, куда вы хотите отправить сообщение |
Пример HTTP ответа
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 96
{
"id": 1,
"threadId": 2,
"clientId": 1,
"clientExternalId": null,
"agentId": 3
}
Поля тела ответа
| Параметр | Тип | Описание |
id | long | Уникальный идентификатор сообщения в edna Chat Center |
threadId | long | Уникальный идентификатора нового треда в edna Chat Center для отправленного сообщения |
clientId | long | Уникальный идентификатор клиента, которому было отправлено сообщение |
clientExternalId | string | Уникальный внешний идентификатор клиента, которому было отправлено сообщение |
agentId | long | Уникальный идентификатор агента, отправившего сообщение |