Отправить сообщение на определенное устройство

Чтобы отправить сообщение на определенное устройство, укажите его идентификатор в поле deviceAddress.

Разрешения

----
Permissions:INTEGRATOR,OPERATOR,SUPERVISOR
----

Параметры запроса

ПараметрТипОписание
textstringТекст сообщения
attachmentslist<attachmentDTO> (необязательно)Список вложений сообщения
applicationDescriptor.channelTypestringТип канала
applicationDescriptor.clientIdstringВнешний ID авторизованного клиента
applicationDescriptor.unauthorizedClientIdstring (необязательно)Внешний ID неавторизованного клиента
applicationDescriptor.deviceAddressstringАдрес устройства в данном channelType, куда вы хотите отправить сообщение
applicationDescriptor.appMarkerstring (необязательно)Идентификатор приложения на данном устройстве, куда вы хотите отправить сообщение

Примеры HTTP запросов

  • Пример отправки сообщения в WhatsApp:
POST /api/v1/messages/outgoing-to-device HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 163
Host: localhost: 8080
{
    "text": "message",
    "attachments": [],
    "clientApplicationDescriptor": {
        "channelType": "WHATSAPP",
        "deviceAddress": "89000000000"
    }
}
  • Пример отправки сообщения на мобильное устройство:
POST /api/v1/messages/outgoing-to-device HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 250
Host: localhost: 8080
{
    "text": "message",
    "attachments": [],
    "clientApplicationDescriptor": {
        "channelType": "MOBILE",
        "clientId": "012-4393-3943-79",
        "appMarker": "myApp",
        "deviceAddress": "wsfck62auiv00gz14vedivwptm09ahmrhz"
    }
}

Параметры ответа

ПараметрТипОписание
idlongУникальный идентификатор сообщения в edna Chat Center
threadIdlongУникальный идентификатора нового треда в edna Chat Center для отправленного сообщения
clientIdlongУникальный идентификатор клиента, которому было отправлено сообщение
clientExternalIdstringУникальный внешний идентификатор клиента, которому было отправлено сообщение
agentIdlongУникальный идентификатор агента, отправившего сообщение

Пример успешного HTTP ответа

Пример успешного HTTP ответа
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 102
{
    "id": 1,
    "threadId": 2,
    "clientId": 1,
    "clientExternalId": null,
    "agentId": 3
}
Отправить сообщение на email клиента
Cледующая статья Отправить сообщение от агента существующему клиенту в edna Chat Center