...
| Примечание | ||
|---|---|---|
| ||
В дальнейшем интеграцию чат-платформу TWIN планируется осуществлять с помощью SDK (находиться в разработке). Это позволит производить процесс интеграции быстрее и обеспечит более высокую стабильность работы. |
Оглавление
| Оглавление |
|---|
...
Информация об интеграции
...
| Блок кода | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{
"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 | Да | Идентификатор чат-сессии. | |
clientId | |||
startedAt | |||
ttl | |||
messages | |||
| body | |||
| answers | |||
| actions | |||
| attachments | |||
| | id | |||
| | isPrivate | |||
| | createdAt | |||
| | name | |||
| | baseName | |||
| | extension | |||
| | sugestedExtension | |||
| | path | |||
| | size | |||
| | url | |||
| | downloadLink |
...
Создать сообщение клиента в чате
...
Описание параметров пути:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
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 | Да | Отметка даты и времени, когда было отправлено сообщение |
...
Подключение к сокетам
| Информация | ||
|---|---|---|
| ||
Socket.IO - это библиотека для создания приложений, работающих в режиме реального времени, имеющих двунаправленный канал связи и основанных на событиях. Более подробно ознакомиться с библиотекой можно на сайте официальной документации. |
...