Отправить сообщение от агента существующему клиенту в edna Chat Center

Чтобы отправить сообщение существующему клиенту, необходимо указать либо clientId, либо threadsClientId.

Два типа ответов в порядке приоритетности:

  • 1. По threadsClientId: Это внутренний ID клиента. Подходит как для авторизованных, так и для неавторизованных клиентов.
  • 2. По clientId: Это внешний ID клиента. Чаще используется для авторизованных клиентов и не имеет привязки к конкретному треду.

Разрешения

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

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

ПараметрТипОписание
clientIdstring (необязательно)Внешний ID клиента
threadsClientIdlong (необязательно)Внутренний ID клиента в edna Chat Center
loginstringЛогин агента, от чьего имени будет отправлено сообщение
statusstringСтатус агента (READY или OUTGOING)
channelTypestringТип канала клиента, которому вы хотите отправить сообщение (MOBILE по умолчанию)
appMarkerstring (необязательно)appMarker приложения клиента
textstring (необязательно)Текст сообщения. Максимальная длина 2000 символов
attachmentslist<attachmentDTO> (необязательно)Список вложений сообщения

Пример объекта вложения

Для того, чтобы файл верно отображался клиенту, название изображения должно содержать расширение файла, либо же должен быть указан тип файла (например, image/jpg).
"attachments": [
    {
        "url": "http://...",
        "name": "test.jpg",
        "type": "image/jpeg",
        "size": 256
    }
],
...
ПараметрТипОписание
urlstringURL файла, строка до 4000 символов
namestringНазвание файла, строка до 1000 символов
typestringMIME-тип файла, строка до 256 символов
sizeintegerРазмер файла в байтах

HTTP запрос

Для clientId:

POST /api/v1/messages/outgoing-from-myself HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 152
Host: localhost: 8080
{
    "text": "message",
    "attachments": [],
    "clientId": "clientId",
    "channelType": "MOBILE",
    "login": "login",
    "status": "READY"
}

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

ПараметрТипОписание
id longУникальный ID сообщение в edna Chat Center

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

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 16
{
    "id": 2
}
Отправить сообщение на определенное устройство
Cледующая статья Отправить сообщение от агента существующему клиенту в edna Chat Center в очередь маршрутизации