Прогнать сценарий на пробном диалоге

Запускает тест скрипта без обзвона клиентов. Нужен, чтобы услышать или увидеть диалог до публикации.

Scope

scenarios:run

Заголовки

Content-Type: application/json
X-Api-Key — ключ проекта
Idempotency-Key — для повторного запроса с тем же результатом

Прогнать сценарий на пробном диалоге

POST /v1/scenario-runs/test-run. Scope scenarios:run.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Здесь пробный запуск: запрос и ответ на одном вызове.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "id": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b",
    "utterance": "Какой объём у кружки?"
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "scenarioId": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b",
    "reply": "Кружка на 350 мл.",
    "step": "answer_volume"
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/scenario-runs/test-run" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "id": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b", "utterance": "Какой объём у кружки?"}}'

Ошибки

401 INVALID_API_KEY — нет ключа или ключ отозван.
403 FORBIDDEN_SCOPE — у ключа нет scenarios:run.
403 PROJECT_MISMATCH — в теле другой проект.
429 RATE_LIMIT_EXCEEDED — заголовок Retry-After.
400 VALIDATION_ERROR — не хватает поля в data.

Ограничения

Проект и пользователь берутся из ключа. Чужой data.projectId отвечает 403 PROJECT_MISMATCH.

Scope

Заголовки

Прогнать сценарий на пробном диалоге

Запрос

Ответ (успех, 200)

Пример cURL

Ошибки

Ограничения

См. также