...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | Имя сессии. |
botId | string | Нет | Идентификатор бота. |
sessionId | string | Нет | Идентификатор существующего сеанса чата. |
sessionTtl | integer | Нет | Время жизни чат-сессии. Указывается в секундах и не может быть больше 12 часов. По умолчанию равен 3 600 секундам. |
messengerType | string | Нет | Тип мессенджера. Указывает из какого мессенджера произведена отправка сообщения (WHATSAPP, TELEGRAM, FACEBOOK...). |
messengerUserId | string | Нет | |
messageBody | string | Нет | Тело сообщения. |
messageAttachments | array of strings | Нет | Список вложений к сообщению. |
clientNameForOperator | string | Нет | Имя клиента, которое будет видно оператору. |
clientId | string | Нет | Идентификатор клиента. |
clientExternalId | string | Нет | Определяемый пользователем идентификатор клиента, инициировавшего сеанс чата. |
clientPhone | string | Нет | Номер телефона клиента. |
clientEmail | string | Нет | Электронная почта клиента. |
clientDeviceId | string | Нет | Идентификатор клиентского устройства для отправки PUSH-уведомлений. |
clientTimezone | integer | Нет | Смещение часового пояса клиента в минутах. |
clientMetadata | object | Нет | Любые определенные пользователем пары ключ/значение в качестве переменных бота. |
returnAnswerAsync | boolean | Нет |
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор чат-сессии. |
clientId | string | Идентификатор клиента. | |
startedAt | string | Отметка времени старта чат-сессии. | |
ttl | integer | Время жизни чат-сессии в секундах. | |
messages | array of objects | Массив данных о сообщении. | |
| body | string | ||
| answers | array of strings | ||
| actions | array of objects | ||
| attachments | array of objects | Список идентификаторов вложений. | |
| | id | string | Идентификатор файла. | |
| | isPrivate | boolean | ||
| | createdAt | string | Отметка времени о создании. | |
| | name | string | Полное имя файла (с расширением). | |
| | baseName | string | Имя файла. | |
| | extension | string | Расширение файла. | |
| | sugestedExtension | string | Предлагаемое расширение файла. | |
| | path | string | ||
| | size | int64 | Размер файла в байтах. | |
| | url | string | ||
| | downloadLink | string | Ссылка на скачивание. |
В успешном ответе содержится идентификатор чат-сессии. Именно этот параметр будет в дальнейшем использоваться для отправки сообщения в чат-сессию и подключения socket.io для "прослушивания" событий в данной чат-сессии.
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"body": "string",
"attachments": [
"bce7d22e-dde6-4427-b391-ebbdfda44de6"
],
"replyToMessageId": "string"
} |
Описаниеполейметода:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
body | string | Да | Текст сообщения |
attachments | array of strings | Нет | Список идентификаторов вложений (файлов), которые были |
| прикреплены при отправке сообщения. | |||
replyToMessageId | string | Нет | Если сообщение является ответом, идентификатор исходного сообщения. |
Ответы
Код 201
Description: Successful message creation
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор сообщения. |
createdAt | string | Да | Отметка даты и времени, когда было отправлено сообщение. |
Отправка файлов в чат-сессию
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор файла. |
isPrivate | boolean | ||
name | string | Полное имя файла (с расширением). | |
baseName | string | Имя файла. | |
extension | string | Расширение файла. | |
| suggestedExtension | string | Предлагаемое расширение файла. | |
| path | string | ||
| size | int64 | Размер файла в байтах. | |
| url | string | ||
| downloadLink | string | ||
ownerId | string | ID владельца |
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор сообщения. |
authorId | string | Идентификатор автора сообщения. | |
authorType | string | Тип автора. Определяет, кто отправил сообщение: бот или оператор. | |
authorName | string | Имя автора сообщения. | |
type | string | ||
body | string | Текст сообщения. | |
answers | string | ||
createdAt | string | Отметка времени о созданном сообщении. | |
sessionId | string | Идентификатор чат-сессии. | |
attachments | string | ||
actions | string | ||
avatar | string | ||
| | id | string | Идентификатор файла. | |
| | isPrivate | boolean | ||
| | createdAt | string | Отметка времени о создании. | |
| | contentType | string | ||
| | name | string | Полное имя файла (с расширением). | |
| | baseName | string | Имя файла. | |
| | extension | string | Расширение файла. | |
| | suggestedExtension | string | Предлагаемое расширение файла. | |
| | path | string | ||
| | size | string | Размер файла в байтах. | |
| | url | string | ||
| | downloadLink | string | Ссылка на скачивание. | |
| | ownerId | string |
Подтверждение о прочтении сообщения
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор сообщения. |
operatorId | string | Идентификатор оператора. | |
operatorName | string | Имя оператора. | |
avatar | string | Аватар оператора. | |
previousOperatorId | string | Идентификатор предыдущего оператора. | |
previousOperatorName | string | Имя предыдущего оператора. | |
previousOperatorAvatar | string | Аватар предыдущего оператора. | |
| | id | string | ||
| | isPrivate | boolean | ||
| | createdAt | string | ||
| | contentType | string | ||
| | name | string | Полное имя файла (с расширением). | |
| | baseName | string | Предлагаемое расширение файла. | |
| | extension | string | Расширение файла. | |
| | suggestedExtension | string | Предлагаемое расширение файла. | |
| | path | string | ||
| | size | string | Размер файла в байтах. | |
| | url | string |
Статус оператора
...