Экспортировать сценарий

GET /api/v1/bots/{uniqueId}/scenarios/{scenarioUniqueId}/export

URL

https://app.helpfy.ai/api/v1/bots/{uniqueId}/scenarios/{scenarioUniqueId}/export

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

Заголовки

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

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

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

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

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

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

curl --request GET 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/scenarios/11111111-1111-4111-8111-111111111111/export' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json'

Ответы

HTTP	Описание
200	Успешный ответ
400	Неверные настройки сценария.
401	Требуется авторизация.
403	Нет доступа к боту.
404	Бот или сценарий не найден.

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

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

{
  "format": "helpfy.bot-scenario",
  "schema_version": 2,
  "exported_at": "example",
  "scenario": {
    "title": "example",
    "trigger_description": "example",
    "examples": [
      "example"
    ],
    "exclusions": [
      "example"
    ],
    "min_confidence": 50,
    "priority": 1,
    "allow_repeat_in_dialogue": false,
    "definition": {
      "start_node_id": "answer",
      "nodes": [
        {
          "id": "answer",
          "type": "FIXED_REPLY",
          "title": "Ответить клиенту",
          "text": "Адрес доставки можно изменить до передачи заказа в доставку."
        },
        {
          "id": "end",
          "type": "END",
          "title": "Завершить сценарий"
        }
      ],
      "edges": [
        {
          "id": "answer-end",
          "source": "answer",
          "target": "end",
          "priority": 100,
          "condition": {
            "type": "ALWAYS"
          }
        }
      ]
    }
  },
  "dependencies": {
    "api_tools": [
      {
        "name": "Служба поддержки",
        "request_method": "example"
      }
    ]
  }
}

Пример ошибки — HTTP 400

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}