...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
body | string | Да | Текст сообщения |
attachments | array of strings | Нет | Список идентификаторов файлов, которые были приложены при отправке сообщения. |
replyToMessageId | string | Нет |
...
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | Идентификатор сообщения |
createdAt | string | Да | Отметка даты и времени, когда было отправлено сообщение |
Отправка файлов в чат-сессию
Для отправки файлов в чат сессию для начала необходимо загрузить файл используя метод, описанный ниже.
Метод: POST
Authorization: No Auth
URL: https://tcl.twin24.ai/api/chats/v1/files?x_widget=1
Пример функции на языке python:
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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'}
response = requests.request("POST", url, headers=headers)
return response |
Ответы
Код 201
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[
{
"id": "c419011c-a998-4189-b897-e82117e6a803",
"isPrivate": true,
"createdAt": "2023-06-26T15:44:32+00:00",
"contentType": "image\/png",
"name": "for_test.png",
"baseName": "for_test",
"extension": "png",
"suggestedExtension": "png",
"path": "",
"size": 18463,
"url": "https:\/\/tcl.twin24.ai\/s3\/twin-chat-prod\/private\/2023-06-26\/c419011c-a998-4189-b897-e82117e6a803?response-content-type=image%2Fpng&response-content-disposition=inline%3B%20filename%3Dfor_test.png&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20230626%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230626T154432Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=a135aa83042d8ae5b36b46c65ed04199432e1610d82bd44dbe3c9951c8639fb6",
"downloadLink": "https:\/\/tcl.twin24.ai\/s3\/twin-chat-prod\/private\/2023-06-26\/c419011c-a998-4189-b897-e82117e6a803?response-content-type=image%2Fpng&response-content-disposition=attachment%3B%20filename%3Dfor_test.png&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20230626%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230626T154432Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=4fd7e5aa634d057612d0cb4d6d72f3b301f174ed4345722c414378c222a1c4bd",
"ownerId": null
}
] |
Описание полей ответа
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | Да | Идентификатор файла | |
isPrivate | |||
name | Полное имя файла (с расширением) | ||
baseName | Имя файла | ||
extension | Расширение файла | ||
| suggestedExtension | |||
| path | |||
| size | Размер файла в байтах | ||
| url | |||
| downloadLink | |||
ownerId | ID владельца |
Далее, для отправки сообщения используется метод отправки сообщения в чат сессию (описан в начале текущего раздела). Важно, при отправке сообщения в котором прикреплён файл, указать в параметрах запроса идентификатор файла.
Метод: POST
Authorization: No Auth
URL: https://tcl.twin24.ai/api/chats/v1/sessions/{session_id}/clients/messages?x_widget=1
Тело запроса
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{body: "отправляю тестовый файл", attachments: ["abc507ad-21f0-4e83-9a41-bb606da8e2d3"]} |
...
Подключение к сокетам
| Информация | ||
|---|---|---|
| ||
Socket.IO - это библиотека для создания приложений, работающих в режиме реального времени, имеющих двунаправленный канал связи и основанных на событиях. Более подробно ознакомиться с библиотекой можно на сайте официальной документации. |
...