Создать диалог

POST /api/v1/bots/{botUniqueId}/dialogues

Создаёт диалог для хранения контекста переписки.

URL

https://app.helpfy.ai/api/v1/bots/{botUniqueId}/dialogues

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

Параметры запроса

Параметры пути

Параметр	Тип	Обязательный	Описание
botUniqueId	строка	Да	Уникальный идентификатор бота.

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
name	строка	Да	Название диалога.
message_limit	число	Да	Сколько предыдущих сообщений включать в контекст диалога.
operator_limit	число	Нет	Количество сообщений клиента, после которого диалог передаётся оператору.

Пример запроса

curl --request POST 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/dialogues' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "name": "Служба поддержки",
  "message_limit": 1
}
JSON

Ответы

HTTP	Описание
201	Успешный ответ

Пример ответа — HTTP 201

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "dialogue_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "My new dialogue",
  "message_limit": 20,
  "operator_limit": 25,
  "successful_messages": 5,
  "clarification_attempted": false,
  "is_active": true,
  "created_at": "2024-10-18T09:17:43.552Z",
  "updated_at": "2024-10-18T09:17:43.552Z"
}