Voximplant Management API: POST /platform_api — StartScenarios: запуск сценария

Запускает JavaScript-сценарий в новой медиасессии по правилу маршрутизации. В ответе: result, media_session_access_url, media_session_access_secure_url (HTTP-запрос на них вызывает событие AppEvents.HttpRequest в сценарии), call_session_history_id.

Параметр	Где	Тип	Обяз.	Описание
cmd	body	string	да	StartScenarios
rule_id	body	integer	да	ID правила (обязателен, если нет rule_name); к правилу должен быть привязан сценарий
rule_name	body	string	нет	Имя правила вместо rule_id
user_id	body	integer	нет	Запуск от имени пользователя (или user_name)
user_name	body	string	нет	Имя пользователя
application_id	body	integer	нет	ID приложения (или application_name)
application_name	body	string	нет	Имя приложения
script_custom_data	body	string	нет	Данные, доступные в сценарии через VoxEngine.customData()
reference_ip	body	string	нет	IP для выбора ближайшего сервера
server_location	body	string	нет	Расположение сервера (приоритетнее reference_ip)

Базовые URL

• Боевой: https://api.voximplant.com

Авторизация

Тип: Bearer-токен

Сервисный аккаунт: JSON-файл с ключом (account_id, key_id, private_key) создаётся в панели управления (https://manage.voximplant.com/settings/service_accounts) или методом CreateKey. Клиент подписывает JWT алгоритмом RS256 (iss — ID аккаунта, iat, exp; в заголовке токена kid — key_id) и передаёт его в заголовке Authorization: Bearer <token>. Токен короткоживущий (в библиотеках — около минуты), его генерируют на каждый запрос.

Нюансы

• Параметры передаются формой (multipart/form-data); списки — строкой через ;.
• Даты — YYYY-MM-DD HH:mm:ss.
• При ошибке в ответе объект error с полями code и msg.
• Некоторые методы (отчёты, детали списков в CSV) возвращают файл application/octet-stream.
• Всего в API около 400 методов: правила и сценарии, очереди ACD и SmartQueue, ключи и роли, KV-хранилище, SIP, push-учётки, дочерние аккаунты, счета.

Сценарии с этим методом

• Позвонить клиенту из своей системы

---

Если этого недостаточно — официальная документация: https://voximplant.com/docs/references/httpapi Вся интеграция одним документом: https://mcp-everything.ru/integrations/voximplant.md