...

Authorization: No Auth

URL: https://chat-apitcl.twin24.ai/api/chats/v1/chats/{chatIdchat_id}/sessions?x_widget=1

Описание параметров пути:

...

Поле	Тип	Обязательно	Описание
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	Нет

Ответы

Код 201

Description: Successful session creation

Блок кода

language	py
theme	DJango
firstline	1
title	Ответ в формате JSON
linenumbers	true
collapse	true

{
  "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

Создать сообщение клиента в чате

...

Authorization: No Auth

URL: https://chatchats-api.twin24.ai/api/v1/sessions/{sessionIdsession_id}/clients/messages

Ссылка на документацию

Описание параметров пути:

Поле	Тип	Обязательно	Описание
sessionId	string	Да	Идентификатор

существующего сеанса чата

чат-сессии.

Тело запроса

Блок кода

language	py
theme	DJango
firstline	1
title	Тело запроса в формате Json:
linenumbers	true
collapse	true

{
  "body": "string",
  "attachments": [
    "bce7d22e-dde6-4427-b391-ebbdfda44de6"
  ],
  "replyToMessageId": "string"
}

Описаниеполейметода:

Поле	Тип	Обязательно
body	string	Да
attachments	array of strings	Нет
replyToMessageId	string	Нет

Ответы

Код 201

Description: Successful message creation

Блок кода

language	py
theme	DJango
firstline	1
title	Ответ в формате JSON
linenumbers	true
collapse	true

{
  "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
  "createdAt": "2018-10-31T11:56:07+00:00"
}

Описание полей ответа

Поле	Тип	Обязательно	Описание
id	string	Да
createdAt	string	Да

Быстрые ссылки

Дерево страниц

Сравнение версий

Старая версия 6

Новая версия 7

Ключ

Создать сообщение клиента в чате

Подключение к сокетам

Быстрые ссылки

Дерево страниц

История страницы

Сравнение версий

Старая версия 6

Новая версия 7

Ключ

Создать сообщение клиента в чате

Подключение к сокетам