• KB Home
  • API
  • API edna Chat Center
  • Сообщения
  • Отправить сообщение от агента существующему клиенту в edna Chat Center в очередь маршрутизации

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

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

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

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

Разрешения

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

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

ПараметрТипОписание
clientIdstring (необязательно)Внешний ID клиента
threadsClientIdlong (необязательно)Внутренний ID клиента в edna Chat Center
loginstringЛогин агента, от чьего имени будет отправлено сообщение
modestringРежим маршрутизации для треда. Возможные значения: TO_FREE_SLOTTO_READY_OPERATOR и TO_ROUTING. Значение по умолчанию — TO_ROUTING.
userIdslist of numbersСписок ID агентов, которым можно назначить тред в процессе маршрутизации
loginslist of stringsСписок логинов агентов, которым можно назначить тред в процессе маршрутизации
skillIdslist of numbersСписок навыков, необходимых агентов, на которых можно назначить тред в процессе маршрутизации
unitIdslist of numbersСписок необходимых отделов, агентам которых можно назначить тред в процессе маршрутизации
prioritynumberПриоритет треда в очереди распределения. Треды с более низкими значениями приоритета будут назначены первыми.
commentstringКомментарий в свободной форме, максимум 220 символов
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-to-queue HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 203
Host: localhost: 8080
{
    "text": "message",
    "attachments": [],
    "clientId": "clientId",
    "channelType": "MOBILE",
    "login": "login",
    "mode": "TO_ROUTING",
    "logins": [
        "login"
    ],
    "priority": 100
}

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

ПараметрТипОписание
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
}
Отправить сообщение от агента существующему клиенту в edna Chat Center