...
Описание параметров пути:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
chatId | string | Да | Идентификатор чата. Он определяет настройки чата и схему работы бота. |
Тело запроса
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"name": "string",
"clientExternalId": "string",
"clientMetadata": {
"var1": "val1",
"var2": "val2",
"var3": "val3"
}
} |
Описаниеполейметода:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | Имя сессии. |
clientExternalId | string | Нет | Определяемый пользователем идентификатор клиента, инициировавшего сеанс чата. |
clientMetadata | object | Нет | Любые определенные пользователем пары ключ/значение в качестве переменных бота. |
Ответы
Код 201
Description: Successful session creation
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"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 для "прослушивания" событий в данной чат-сессии.
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"body": "string",
"attachments": [
"bce7d22e-dde6-4427-b391-ebbdfda44de6"
],
"replyToMessageId": "string"
} |
Описаниеполейметода:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
body | string | Да | Текст сообщения |
attachments | array of strings | Нет | Список идентификаторов вложений (файлов), которые были прикреплены при отправке сообщения. |
replyToMessageId | string | Нет | Если сообщение является ответом, идентификатор исходного сообщения. |
Ответы
Код 201
Description: Successful message creation
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"createdAt": "2018-10-31T11:56:07+00:00"
} |
Описание полей ответа
Поле | Тип | Описание |
|---|---|---|
id | string | Идентификатор сообщения. |
createdAt | string | Отметка даты и времени, когда было отправлено сообщение. |
Отправка файлов в чат-сессию
...
Описание параметров события 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 | Идентификатор владельца. |
Подтверждение о прочтении сообщения
...
Описание параметров события chatMessageReadEmit
Поле | Тип | Описание |
|---|---|---|
messageId | string | Идентификатор сообщения |
ОПЕРАТОРЫ
Назначение оператора после бота (первичное назначение)
...
Описание параметров события chatMessageCreatedEmit
Поле | Тип | Описание |
|---|---|---|
id | string | Идентификатор сообщения. |
operatorId | string | Идентификатор оператора. |
operatorName | string | Имя оператора. |
avatar | string | Аватар оператора. |
previousOperatorId | string | Идентификатор предыдущего оператора. |
previousOperatorName | string | Имя предыдущего оператора. |
previousOperatorAvatar | string | Аватар предыдущего оператора. |
| | id | string | Идентификатор файла. |
| | isPrivate | boolean | Отметка о приватности. |
| | createdAt | string | Отметка времени о создании. |
| | contentType | string | Content type. Тип контента (тип передачи файла). |
| | name | string | Полное имя файла (с расширением). |
| | baseName | string | Предлагаемое расширение файла. |
| | extension | string | Расширение файла. |
| | suggestedExtension | string | Предлагаемое расширение файла. |
| | path | string | Путь (расположение) во внутреннем хранилище. |
| | size | string | Размер файла в байтах. |
| | url | string | Ссылка на файл во внутреннем хранилище. |
Статус оператора
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
"operatorStatusChangedEmit",
{
"operatorId": "389",
"previousStatus": "ACTIVE",
"currentStatus": "PAUSED"
}
] |
Описание параметров события operatorStatusChangedEmit
Поле | Тип | Описание |
|---|---|---|
operatorId | string | Идентификатор оператора |
previousStatus | string | Предыдущий статус оператора |
currentStatus | string | Текущий статус оператора |
Выход оператора из системы
...
Описание параметров события operatorStatusChangedEmit
Поле | Тип | Описание |
|---|---|---|
operatorId | string | Идентификатор оператора |
Подключение чат-сессии к socket.io
...