Список сценариев разговоров

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

Scope

scenarios:read

Заголовки

Content-Type: application/json
X-Api-Key — ключ проекта

Список сценариев разговоров

POST /v1/scenarios/list. Scope scenarios:read.

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

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "page": 1,
    "pageSize": 20
  }
}

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

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b",
        "name": "Вопрос про кружку",
        "description": "Клиент спрашивает объём, бот отвечает и даёт ссылку.",
        "status": "draft",
        "enabled": false,
        "projectId": "11111111-1111-4111-8111-111111111111",
        "createdAt": "2026-10-16T09:00:00.000Z",
        "updatedAt": "2026-10-16T09:12:00.000Z",
        "deletedAt": null
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/scenarios/list" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "page": 1, "pageSize": 20}}'

Ошибки

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

Ограничения

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

Scope

Заголовки

Список сценариев разговоров

Запрос

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

Пример cURL

Ошибки

Ограничения

См. также