| Предупреждение | ||
|---|---|---|
| ||
| Мы стараемся поддерживать информацию в данной статье в актуальном состоянии. В связи с тем, что возможны задержки, наиболее актуальную информацию о нашем API вы сможете найти на ресурсе Все последние обновления для работы с сервисами TWIN в первую очередь публикуются на ресурсе https://developers.twin24.ai. |
| Предупреждение | ||
|---|---|---|
| ||
| Мы Команда TWIN постоянно совершенствуем наши инструментысвои сервисы. В связи с этим возможно внесение изменений в наше API. Просим вас учитывать этот факт при реализации интеграции чат-платформы TWIN с вашими приложениями. Важно обратить на это внимание при согласовании гарантийных обязательств. |
| Примечание | ||
|---|---|---|
| ||
В скором времени интеграцию чат-платформу TWIN планируется осуществлять с помощью SDK. Это позволит производить процесс интеграции быстрее и обеспечит более высокую стабильность работы. Дополнительно о сроках реализации SDK вы можете узнать у наших специалистов. |
| Оглавление |
|---|
--Для интеграции чат-платформы необходимо выполнить следующие шаги--
Старт новой чат-сессии
Метод: POST
Authorization: No Auth
URL: https://chat-api.twin24.ai/api/v1/chats/{chatId}/sessions
Описание параметров пути:
Поле | Тип | Обязательно | Описание |
|---|---|---|---|
chatId | string | Да | Идентификатор чата. Он определяет настройки чата и схему работы бота. |
| Блок кода | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{
"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 | |||
sessionTtl | Время жизни чат-сессии. Указывается в секундах и не может быть больше 12 часов. По умолчанию равен 3 600 секундам. | ||
messengerType | |||
messengerUserId | |||
messageBody | |||
messageAttachments | |||
clientNameForOperator | Нет | Имя клиента, которое будет видно оператору. | |
clientId | Нет | ||
clientExternalId | string | Нет | Определяемый пользователем идентификатор клиента, инициировавшего сеанс чата. |
clientPhone | string | Нет | |
clientEmail | string | Нет | Электронная почта клиента |
clientDeviceId | string | Нет | Идентификатор клиентского устройства для отправки PUSH-уведомлений. |
clientTimezone | integer | Нет | Смещение часового пояса клиента в минутах. |
clientMetadata | object | Нет | Любые определенные пользователем пары ключ/значение в качестве переменных бота. |
returnAnswerAsync | boolean | Нет |
| Блок кода | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{
"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"
}
]
}
]
} |