Перейти к основному содержимому

Отправить сообщение на email клиента

Чтобы отправить сообщение на email клиента, в теле запроса должно быть указано поле emailAccountId. С этого аккаунта email будет отправлено письмо клиенту.

    ----
Permissions:INTEGRATOR
----
Поля тела запроса
ПараметрТипОписание

text

String

Текст сообщения

attachments

List of objects (необязательно)

Список вложений сообщения

emailAccountId

Long

Идентификатор email аккаунта, с которого сообщение будет отправлено. Запрашивается у системного администратора.

emailSubject

String

Тема email. Все сообщения в треде сгруппированы по теме email. Это поле обязательно для заполнения.

emailAddress

String

Email клиента, которому вы хотите отправить сообщение

Пример curl

$ curl 'http://localhost:8080/api/v1/messages/email' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <integrator_token>' \
-H 'X-Tenant-Name: local' \
-d '{
"text" : "message",
"emailAccountId" : 1,
"emailSubject" : "subject",
"emailAddress" : "test@test.ru"
'

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

POST /api/v1/messages/email HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
X-Tenant-Name: local
Content-Length: 113
Host: localhost:8080

{
"text" : "message",
"emailAccountId" : 1,
"emailSubject" : "subject",
"emailAddress" : "test@test.ru"

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

Поля тела ответа
ПараметрТипОписание

id

Long

Уникальный идентификатор сообщения в edna

threadId

Long

Уникальный идентификатора нового треда в edna для отправленного сообщения

clientId

Long

Уникальный идентификатор клиента, которому было отправлено сообщение

clientExternalId

String

Уникальный внешний идентификатор клиента, которому было отправлено сообщение

agentId

Long

Уникальный идентификатор агента, отправившего сообщение

HTTP/1.1 200 OK
X-Request-Id: a61d7e84-3353-4aaa-b66d-9a7e06811bef
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 106

{
"id" : 1,
"threadId" : 2,
"clientId" : 1,
"clientExternalId" : "test@test.ru",
"agentId" : 3