Выложить сценарий звонка в Voximplant

Отправляет сценарий в Voximplant, чтобы звонки шли по нему. Нужен после проверки, не вместо неё.

Scope

operator:write

Заголовки

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

Выложить сценарий звонка в Voximplant

POST /v1/ai-operator/voice-profiles/scenario-deploy. Scope operator:write.

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

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "id": "9f9f9f9f-9f9f-49f9-89f9-9f9f9f9f9f9f",
    "scenarioId": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b"
  }
}

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

{
  "success": true,
  "data": {
    "id": "9f9f9f9f-9f9f-49f9-89f9-9f9f9f9f9f9f",
    "projectId": "11111111-1111-4111-8111-111111111111",
    "name": "Спокойный женский",
    "provider": "voximplant",
    "isDefault": true
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/ai-operator/voice-profiles/scenario-deploy" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "id": "9f9f9f9f-9f9f-49f9-89f9-9f9f9f9f9f9f", "scenarioId": "9b9b9b9b-9b9b-49b9-89b9-9b9b9b9b9b9b"}}'

Ошибки

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

Ограничения

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

Scope

Заголовки

Выложить сценарий звонка в Voximplant

Запрос

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

Пример cURL

Ошибки

Ограничения

См. также