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

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

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

Разрешения

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

Пример curl

$ curl 'http://localhost:8080/api/v1/messages/outgoing-to-queue' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <integrator_token>' \
    -d '{
  "text" : "message",
  "attachments" : [ ],
  "clientId" : "clientId",
  "channelType" : "MOBILE",
  "login" : "login",
  "mode" : "TO_ROUTING",
  "logins" : [ "login" ],
  "priority" : 100
}'

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

Пример для clientId:

POST /api/v1/messages/outgoing-to-queue HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 194
Host: localhost: 8080
{
    "text": "message",
    "attachments": [],
    "clientId": "clientId",
    "channelType": "MOBILE",
    "login": "login",
    "mode": "TO_ROUTING",
    "logins": [
        "login"
    ],
    "priority": 100
}

Поля тела запроса

ПараметрТипОписание
loginstringЛогин агента, от чьего имени будет отправлено сообщение
modestringРежим маршрутизации для треда. Возможные значения: TO_FREE_SLOTTO_READY_OPERATOR 
и TO_ROUTING. Значение по умолчанию — TO_ROUTING.
clientIdstring (необязательно)Внешний идентификатор клиента. Если не указан, то threadsClientId должен быть заполнен
threadsClientIdlong (необязательно)Внутренний идентификатор клиента в {edna}. Если не указан, то clientId должен быть заполнен
userIdslist of longsСписок идентификаторов агентов, которым можно назначить тред в процессе маршрутизации
loginslist of stringsСписок логинов агентов, которым можно назначить тред в процессе маршрутизации
skillIdslist of longsСписок навыков, необходимых агентов, на которых можно назначить тред в процессе маршрутизации
unitIdslist of longsСписок необходимых отделов, агентам которых можно назначить тред в процессе маршрутизации
prioritylongПриоритет треда в очереди распределения. Треды с более низкими значениями приоритета будут назначены первыми (по умолчанию 100).
commentstring (необязательно)Комментарий в свободной форме, максимум 220 символов
channelTypestringТип канала клиента, которому вы хотите отправить сообщение (по умолчанию MOBILE)
appMarkerstring (необязательно)appMarker приложения клиента
textstring (необязательно)Текст сообщения. Максимальная длина 2000 символов. Если не указан, то attachments должен быть заполнен
attachmentslist of objects (необязательно)Список вложений сообщения. Если не указан, то text должен быть заполнен

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

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

Пример HTTP ответа

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 14
{
    "id": 2
}

Поля тела ответа

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