Чтобы отправить сообщение существующему клиенту, необходимо указать либо clientId, либо threadsClientId. В случае передачи и threadsClientId, и clientId поиск клиента будет осуществлен по более приоритетному threadsClientId.
Разрешения
---- Permissions:INTEGRATOR,OPERATOR,SUPERVISOR ----
Пример curl
$ curl 'http://localhost:8080/api/v1/messages/outgoing-from-myself' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <integrator_token>' \
-d '{
"text" : "message",
"attachments" : [ ],
"clientId" : "clientId",
"channelType" : "MOBILE",
"login" : "login",
"status" : "READY"
}'
Пример HTTP запроса
Для clientId:
POST /api/v1/messages/outgoing-from-myself HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
Content-Length: 145
Host: localhost: 8080
{
"text": "message",
"attachments": [],
"clientId": "clientId",
"channelType": "MOBILE",
"login": "login",
"status": "READY"
}
Поля тела запроса
| Параметр | Тип | Описание |
login | string | Логин агента, от чьего имени будет отправлено сообщение |
status | string | Статус агента (READY или OUTGOING) |
channelType | string | Тип канала клиента, которому вы хотите отправить сообщение (MOBILE by default) |
clientId | string (необязательно) | Внешний идентификатор клиента. Если не указан, то threadsClientId должен быть заполнен |
threadsClientId | long (необязательно) | Внутренний идентификатор клиента в {edna}. Если не указан, то clientId должен быть заполнен |
appMarker | string (необязательно) | appMarker приложения клиента |
text | string (необязательно) | Текст сообщения. Максимальная длина 2000 символов. Если не указан, то attachments должен быть заполнен |
attachments | list of objects (необязательно) | Список вложений сообщения. Если не указан, то text должен быть заполнен |
Пример объекта вложения
Для того, чтобы файл верно отображался клиенту, название изображения должно содержать расширение файла, либо же должен быть указан тип файла (например,
image/jpg). "attachments": [
{
"url": "http://...",
"name": "test.jpg",
"type": "image/jpeg",
"size": 256
}
],
...
| Параметр | Тип | Описание |
url | string | URL файла, строка до 4000 символов |
name | string | Название файла, строка до 1000 символов |
type | string | MIME-тип файла, строка до 256 символов |
size | integer | Размер файла в байтах |
Параметры ответа
Пример 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 |