...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"name": "string",
"botId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"sessionId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"sessionTtl": 3600,
"messengerType": "WHATSAPP",
"messengerUserId": "string",
"messageBody": "string",
"messageAttachments": [
"bce7d22e-dde6-4427-b391-ebbdfda44de6"
],
"clientNameForOperator": "string",
"clientId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
"clientExternalId": "string",
"clientPhone": 75555673245,
"clientEmail": "string",
"clientDeviceId": "string",
"clientTimezone": 300,
"clientMetadata": {
"var1": "val1",
"var2": "val2",
"var3": "val3"
},
"returnAnswerAsync": true
} |
Описаниеполейметода:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | Да | Имя сессии. |
botId | string | Нет | Идентификатор бота. |
sessionId | string | Нет | Идентификатор существующего сеанса чата. |
sessionTtl | integer | Нет | Время жизни чат-сессии. Указывается в секундах и не может быть больше 12 часов. По умолчанию равен 3 600 секундам. |
messengerType | string | Нет | Тип мессенджера. Указывает из какого мессенджера произведена отправка сообщения (WHATSAPP, TELEGRAM, FACEBOOK...). |
messengerUserId | string | Нет | Идентификатор пользователя в конкретном мессенджере. Например для WHATSAPP это будет номер телефона. |
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 | Нет | Включение/отключение асинхронного режима. |
Ответы
Код 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 для "прослушивания" событий в данной чат-сессии.
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
def send_file_to_chat_session(session_id: str, file_name, file_path): url = f"https://chats-api.twin24.ai/api/v1/sessions/{session_id}/messages" payload = {} headers = {'Content-Type': 'multipart/form-data'} form_datafilse = {}["file[]", (file_name, open(file_path)] response = requests.request("POST", url, headers=headers, data=form_datapayload, ) return response |
Ответы
Код 201
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор файла. |
isPrivate | boolean | ||
name | string | Полное имя файла (с расширением). | |
baseName | string | Имя файла. | |
extension | string | Расширение файла. | |
| suggestedExtension | string | Предлагаемое расширение файла. | |
| path | string | Путь (расположение) во внутреннем хранилище. | |
| size | int64 | Размер файла в байтах. | |
| url | string | Ссылка на файл во внутреннем хранилище. | |
| downloadLink | string | Ссылка на скачивание файла. | |
ownerId | string | ID владельца |
...
Описание параметров события 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 | Идентификатор владельца. |
Подтверждение о прочтении сообщения
...