Voximplant Management API: Создать приложение и пользователя для звонков из браузера или приложения

Сценарий из mcp-everything. Актуально на 2026-10-24.

Сотрудник звонит клиентам прямо из веб-интерфейса CRM через Web SDK Voximplant.

1. Создай приложение: AddApplication с application_name в формате [a-z][a-z0-9-]{1,64}.
2. Создай пользователя: AddUser с user_name, user_display_name, user_password (от 8 символов, с заглавной и строчной буквой, цифрой и спецсимволом) и application_id или application_name.
3. Проверь, что всё на месте: GetApplications с application_id и with_rules — увидишь правила и сценарии приложения.
4. В веб-интерфейсе пользователь входит в Web SDK с этим именем и паролем и может принимать и совершать звонки по правилам приложения.

app = vox("AddApplication", application_name="crm-calls")
vox("AddUser", user_name="manager-101", user_display_name="Иван Петров",
    user_password="Str0ng!Passw0rd", application_id=app["application_id"])

Базовые 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>. Токен короткоживущий (в библиотеках — около минуты), его генерируют на каждый запрос.

Методы сценария

POST /platform_api — GetApplications: приложения

Параметр	Где	Тип	Обяз.	Описание
cmd	body	string	да	GetApplications
application_id	body	integer	нет	ID приложения
application_name	body	string	нет	Имя приложения
with_rules	body	boolean	нет	Вернуть правила
with_scenarios	body	boolean	нет	Вернуть сценарии
count	body	integer	нет	Число записей
offset	body	integer	нет	Смещение

POST /platform_api — AddApplication: создание приложения

Параметр	Где	Тип	Обяз.	Описание
cmd	body	string	да	AddApplication
application_name	body	string	да	Короткое имя в формате [a-z][a-z0-9-]{1,64}
secure_record_storage	body	boolean	нет	Защищённое хранение логов и записей

POST /platform_api — AddUser: создание пользователя

Параметр	Где	Тип	Обяз.	Описание
cmd	body	string	да	AddUser
user_name	body	string	да	Имя в формате [a-z0-9][a-z0-9_-]{2,49}
user_display_name	body	string	да	Отображаемое имя, до 256 символов
user_password	body	string	да	Пароль от 8 символов: заглавная и строчная буква, цифра, спецсимвол
application_id	body	integer	да	ID приложения (или application_name)
application_name	body	string	нет	Имя приложения
parent_accounting	body	boolean	нет	Использовать баланс родительского аккаунта
user_active	body	boolean	нет	Активен ли пользователь
user_custom_data	body	string	нет	Произвольная строка

Нюансы

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

Другие сценарии

• Позвонить клиенту из своей системы
• Автообзвон по списку номеров
• Отправить SMS с номера Voximplant
• Выгрузить историю звонков

---

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