Для кого нужна эта статья
Эта статья поможет вам интегрировать чат-бота TWIN в стороннее приложение. Как мобильное, так и десктопное.
Актуальность информации
Учтите при интеграции
SDK как основной инструмент интеграции
В дальнейшем интеграцию чат-платформу TWIN планируется осуществлять с помощью SDK (находиться в разработке). Это позволит производить процесс интеграции быстрее и обеспечит более высокую стабильность работы.
Оглавление
Информация об интеграции
Интеграция чат-платформы TWIN в приложение (кодовую базу) клиента идёт на стороне клиента.
Возможность интеграции и её срок определяется специалистами на стороне клиента.
Со своей стороны TWIN предоставляет необходимую документацию по методам подключения и взаимодействия платформы с приложением заказчика.
Для обеспечения двухсторонней связи используется библиотека Socket.IO, построенная на основе протокола WebSocket.
Интеграция осуществляется в несколько простых шагов:
- Старт чат-сессии. Происходит при помощи API.
- Отправка сообщения в чат сессию. Происходит при помощи API.
- Получение сообщений, подтверждение получения сообщений - происходит с помощью socket.io. Важно: на каждое полученное сообщение необходимо отправить событие (emit) о прочтении сообщения.
Ниже детально описаны все перечисленные этапы с примерами кода на языке python версии 3.11.
О примере
Для примера интеграции мы рассмотрим простую программу. Суть и логика программы: запускается эхо-бот, который повторяет введенное в терминале пользователем сообщение. Завершение эхо-чата происходит по ключевому слову "стоп".
Пример отображения диалога в виджете. Здесь в качестве демонстрации показано как бот при старте диалога отправляет картинку. Также продемонстрирована возможность отправки файла в чат.
Список зависимостей окружения
Для корректной работы описанной эхо-программы, рекомендуем установить следующие зависимости:
aiohttp==3.8.4 aiosignal==1.3.1 async-timeout==4.0.2 attrs==23.1.0 bidict==0.22.1 certifi==2023.5.7 charset-normalizer==3.1.0 frozenlist==1.3.3 idna==3.4 multidict==6.0.4 python-engineio==3.14.2 python-socketio==4.6.1 requests==2.31.0 six==1.16.0 urllib3==2.0.3 websocket-client==1.6.0 yarl==1.9.2
Старт новой чат-сессии
Метод: POST
Authorization: No Auth
URL: https://tcl.twin24.ai/api/chats/v1/chats/{chat_id}/sessions?x_widget=1
Пример функции на языке python:
def start_chat_session(chat_id: str, name: str = "integration_example") -> dict:
"""
Создаёт чат-сессию и возвращает коллекцию данных о ней.
:param chat_id: Идентификатор чата.
:param name: Имя чат-сессии. Задается для облегчения поиска чат-сессии в личном кабинете TWIN.
:return: Коллекция данных о созданной чат-сессии.
"""
url = f"https://tcl.twin24.ai/api/chats/v1/chats/{chat_id}/sessions?x_widget=1"
headers = {"Content-Type": "application/json"}
payload = json.dumps({"name": name})
response = requests.request("POST", url, headers=headers, data=payload)
return response.json()
Описание параметров пути:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 для "прослушивания" событий в данной чат-сессии.
Отправка сообщения в чат сессию
Метод: POST
Authorization: No Auth
URL: https://chats-api.twin24.ai/api/v1/sessions/{session_id}/messages
Пример функции на языке python:
def send_msg_to_chat_session(session_id: str, message_text: str) -> dict:
"""
Отправляет сообщение.
:param session_id: Идентификатор чат-сессии.
:param message_text: Текст сообщения.
:return: Коллекция данных об отправленном сообщении.
"""
url = f"https://chats-api.twin24.ai/api/v1/sessions/{session_id}/messages"
headers = {'Content-Type': 'application/json'}
payload = json.dumps({"body": message_text, "attachments": []})
response = requests.request("POST", url, headers=headers, data=payload)
return response.json()
Описание параметров пути:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
sessionId | string | Да | Идентификатор чат-сессии. |
Тело запроса
{
"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 | Отметка даты и времени, когда было отправлено сообщение. |
Отправка файлов в чат-сессию
Для отправки файлов в чат сессию для начала необходимо загрузить файл используя метод, описанный ниже.
Метод: POST
Authorization: No Auth
URL: https://tcl.twin24.ai/api/chats/v1/files?x_widget=1
Пример функции на языке python для отправки файла с расширением png:
def uploading_file_to_chat_session(file_name, file_path) -> dict:
"""
Функция загрузки файла изображения в хранилище TWIN.
:param file_name: Полное имя файла с расширением.
:param file_path: Путь к файлу.
:return: Массив данных о загруженном файле.
"""
url = "https://tcl.twin24.ai/api/chats/v1/files?x_widget=1"
payload = {}
files = [("file[]", (file_name, open(file_path, 'rb'), 'image/png'))]
headers = {}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
return response.json()
Примечание: данная функция демонстрирует загрузку изображений. Если необходимо отправить pdf-файл, необходимо указать в переменной file следующее:files = [("file[]", (file_name, open(file_path, 'rb'), 'application/pdf'))]
Ответы
Код 201
[
{
"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 идентификатор(ы) файла(ов).
Подключение к сокетам
О библиотеки socket.io
Socket.IO - это библиотека для создания приложений, работающих в режиме реального времени, имеющих двунаправленный канал связи и основанных на событиях. Более подробно ознакомиться с библиотекой можно на сайте официальной документации.
О библиотеки socket.io
Для взаимодействия с socket.io взята библиотека python-socketio версии 4.6.1
Справочная информация о событиях socket.io для виджета чат-платформы TWIN
Протокол Socket.IO основан на событиях. Когда сервер хочет установить связь с клиентом, он создает событие. Каждое событие имеет имя и список аргументов.
Ниже представлены ключевые события, которые возникают в виджете и описаны параметры каждого события.
Данная информация носит справочный характер и позволяет определить, какие события необходимо инициировать для корректной интеграции чат-платформы в кодовую базу приложения на стороне клиента.
Процесс набора текста
Описание параметров события showTypingIndicatorEmit
Поле | Тип | Описание |
|---|---|---|
authorType | 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 | string | Идентификатор оператора |
previousStatus | string | Предыдущий статус оператора |
currentStatus | string | Текущий статус оператора |
Выход оператора из системы
Описание параметров события operatorStatusChangedEmit
Поле | Тип | Описание |
|---|---|---|
operatorId | string | Идентификатор оператора |
Подключение чат-сессии к socket.io
Создание клиентского экземпляра
import socketio # Создаем экземпляр клиента socketio sio = socketio.Client()
Определение обработчиков событий
Регистрируем функцию обработчика событий с помощью декоратора socketio.Client.on() указывая имя события. Также после отправки сообщения, инициируем событие messageReceived - подтверждение прочтения сообщения.
# Обработка события получения сообщения.
@sio.on("chatMessageCreatedEmit")
def msg_handler(data: dict):
"""
Обработка сообщений и общение с эхо-ботом.
:param data: Массив данных с параметрами сообщения.
"""
# Вывод в терминал
print(f"{data['authorType']}: {data['body']}")
# Подтверждение о прочтении сообщения
response = {"action": "chatMessageCreated", "data": {"id": data["id"]}}
sio.emit('messageReceived', response)
# Завершение диалога после введения ключевого слова в терминале
if data['type'] == 'TERMINAL':
globals()['FLAG'] = False
Подключаемся к серверу используя TLS/SSL подключение.
URL для подключения к серверу: https://tcl.twin24.ai/operator/socket.io/?key={session_id}
Параметр session_id предварительно был получен при вызове функции start_chat_session
sio.connect(url=f'https://tcl.twin24.ai/operator/socket.io/?key={chat_session_id}',
transports=['polling', 'websocket'],
socketio_path='operator/socket.io')
После этого шага, всё готово для того чтобы "слушать" происходящие события в указанной чат-сессии. Можно отправлять сообщения и в случае завершения диалога по ключевому слову закрывать соединение.
Ниже представлена кодовая база всей программы:
# Импортируем все необходимые библиотеки
import json
from datetime import datetime
from time import sleep
import requests
import socketio
# Указываем идентификатор чата (получить идентификатор необходимо в личном кабинете)
# Важно: необходимо указывать свои параметры идентификатора чата! Это пример!
CHAT_ID = "3eb5cf6d-4d20-41c2-b886-f60374d11d19"
# Создаем экземпляр клиента socketio
sio = socketio.Client()
FLAG = True
# Определяем функции, необходимые для работы программы
def start_chat_session(chat_id: str, name: str = "integration_example") -> dict:
"""
Создаёт чат-сессию и возвращает коллекцию данных о ней.
:param chat_id: Идентификатор чата.
:param name: Имя чат-сессии. Задается для облегчения поиска чат-сессии в личном кабинете TWIN.
:return: Коллекция данных о созданной чат-сессии.
"""
url = f"https://tcl.twin24.ai/api/chats/v1/chats/{chat_id}/sessions?x_widget=1"
headers = {"Content-Type": "application/json"}
payload = json.dumps({"name": name})
response = requests.request("POST", url, headers=headers, data=payload)
return response.json()
def send_msg_to_chat_session(session_id: str, message_text: str) -> dict:
"""
Отправляет сообщение.
:param session_id: Идентификатор чат-сессии.
:param message_text: Текст сообщения.
:return: Коллекция данных об отправленном сообщении.
"""
url = f"https://chats-api.twin24.ai/api/v1/sessions/{session_id}/messages"
headers = {'Content-Type': 'application/json'}
payload = json.dumps({"body": message_text, "attachments": []})
response = requests.request("POST", url, headers=headers, data=payload)
return response.json()
@sio.event
def connect():
pass
@sio.event
def connect_error(data):
print(f"The connection failed!\n{data}")
@sio.event
def disconnect():
pass
# Обработка события получения сообщения.
@sio.on("chatMessageCreatedEmit")
def msg_handler(data: dict):
"""
Обработка сообщений и общение с эхо-ботом.
:param data: Массив данных с параметрами сообщения.
"""
# Вывод в терминал
print(f"{data['authorType']}: {data['body']}")
# Подтверждение о прочтении сообщения
response = {"action": "chatMessageCreated", "data": {"id": data["id"]}}
sio.emit('messageReceived', response)
# Завершение диалога после введения ключевого слова в терминале
if data['type'] == 'TERMINAL':
globals()['FLAG'] = False
if __name__ == '__main__':
# Отметка времени
test_time = datetime.now().strftime("%d.%m.%Y_%H.%M.%S")
# Старт чат-сессии. Получение результатов
response_data = start_chat_session(CHAT_ID, f'Test: {test_time}')
# Получаем ID чат-сессии
chat_session_id = response_data['id']
# Блок диалога с эхо-ботом
msgs = response_data['messages']
for msg in msgs:
print(f"{msg['authorType']}: {msg['body']}")
sio.connect(url=f'https://tcl.twin24.ai/operator/socket.io/?key={chat_session_id}',
transports=['polling', 'websocket'],
socketio_path='operator/socket.io')
while FLAG:
send_msg_to_chat_session(chat_session_id, input('USER: '))
sleep(2)
sio.disconnect()
Это минимальная программа, отображающая все шаги, необходимые для интеграции чат-платформы TWIN в кодовую базу приложения клиента.

