...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"clientId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"startedAt": "2018-10-31T11:56:07+00:00",
"ttl": 3600,
"messages": [
{
"body": "string",
"answers": [
"string"
],
"actions": [
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
],
"attachments": [
{
"id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"isPrivate": true,
"createdAt": "2018-10-31T11:56:07+00:00",
"name": "bot.png",
"baseName": "bot",
"extension": "png",
"sugestedExtension": "png",
"path": "string",
"size": 12400,
"url": "string",
"downloadLink": "string"
}
]
}
]
} |
Описание полей ответа
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 для "прослушивания" событий в данной чат-сессии.
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[
{
"id": "c419011c-a998-4189-b897-e82117e6a803",
"isPrivate": true,
"createdAt": "2022-06-26T15:44:32+00:00",
"contentType": "image/jpeg",
"name": "for_test.png",
"baseName": "for_test",
"extension": "png",
"suggestedExtension": "png",
"path": "",
"size": 18463,
"url": "string",
"downloadLink": "string",
"ownerId": null
}
] |
Описание полей ответа
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор файла. |
isPrivate | boolean | Да | Отметка о приватности. True если файл загружен пользователем или оператором, False - если ботом. |
name | string | Да | Полное имя файла (с расширением). |
baseName | string | Да | Имя файла. |
extension | string | Да | Расширение файла. |
| suggestedExtension | string | Да | Предлагаемое расширение файла. |
| path | string | Да | Путь (расположение) во внутреннем хранилище. |
| size | int64 | Да | Размер файла в байтах. |
| url | string | Да | Ссылка на файл во внутреннем хранилище. |
| downloadLink | string | Да | Ссылка на скачивание файла. |
ownerId | string | Да | ID владельца |
Далее, для отправки сообщения используется метод отправки сообщения в чат сессию (описан в начале текущего раздела). Важно, при отправке сообщения в котором прикреплён файл, указать в параметрах запроса attachments идентификатор(ы) файла(ов).
...
Описание параметров события chatMessageCreatedEmit
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор сообщения. |
authorId | string | Идентификатор автора сообщения. | |
authorType | string | Тип автора. Определяет, кто отправил сообщение: бот или оператор. | |
authorName | string | Имя автора сообщения. | |
type | string | Тип сообщения. Может быть:REGULAR - обычное сообщение;TERMINAL - последнее (завершающее) сообщение в сессии. После этого сообщения сессия закрывается.HELP - запрос помощи оператора. | |
body | string | Текст сообщения. | |
answers | array of objects | Варианты ответов (кнопки с вариантами ответов). | |
createdAt | string | Отметка времени о созданном сообщении. | |
sessionId | string | Идентификатор чат-сессии. | |
attachments | array of objects | Список идентификаторов вложений. | |
actions | string | Информация о дополнительной функциональности в данном сообщении (например форма опроса). | |
avatar | string | Аватар бота или оператора. Массив данных. | |
| | id | string | Идентификатор файла. | |
| | isPrivate | boolean | False - бот, True - оператор | |
| | createdAt | string | Отметка времени о создании. | |
| | contentType | string | Content type. Тип контента (тип передачи файла). | |
| | name | string | Полное имя файла (с расширением). | |
| | baseName | string | Имя файла. | |
| | extension | string | Расширение файла. | |
| | suggestedExtension | string | Предлагаемое расширение файла. | |
| | path | string | Путь (расположение) во внутреннем хранилище. | |
| | size | string | Размер файла в байтах. | |
| | url | string | Ссылка на файл во внутреннем хранилище. | |
| | downloadLink | string | Ссылка на скачивание. | |
| | ownerId | string | Идентификатор владельца. |
Подтверждение о прочтении сообщения
...