...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 | Нет |
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
def send_file_to_chat_session(session_id: str):
url = f"https://chats-api.twin24.ai/api/v1/sessions/{session_id}/messages"
headers = {'Content-Type': 'application/json'}
form_data = {}
response = requests.request("POST", url, headers=headers, data=form_data)
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 владельца |
...
Далее, для отправки сообщения используется метод отправки сообщения в чат сессию (описан в начале текущего раздела). Важно, при отправке сообщения в котором прикреплён файл, указать в параметрах запроса attachments идентификатор(ы) файла(ов).
...
Подключение к сокетам
| Информация | ||
|---|---|---|
| ||
Socket.IO - это библиотека для создания приложений, работающих в режиме реального времени, имеющих двунаправленный канал связи и основанных на событиях. Более подробно ознакомиться с библиотекой можно на сайте официальной документации. |
...
Описание параметров события chatMessageCreatedEmit
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 |
Подтверждение о прочтении сообщения
...
Описание параметров события chatMessageCreatedEmit
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 |
Статус оператора
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
"operatorStatusChangedEmit",
{
"operatorId": "389",
"previousStatus": "ACTIVE",
"currentStatus": "PAUSED"
}
] |
...