Методы API → Виртуальная АТС

Чтобы воспользоваться методами API, перейдите в раздел «Интеграции» → вкладка «Методы API» → «Виртуальная АТС» или без авторизаци по ссылке.

Calls

• POST/api/protected/calls/vpbx/outbound Create outbound call — создать исходящий звонок через ВАТС
• POST/api/protected/calls/vpbx/outbound/schema Create an outbound call to a virtual PBX — создать исходящий звонок через виртуальную АТС по схеме
• POST/api/protected/calls/vpbx/autocall Create auto call to a virtual PBX — создать автодозвон через виртуальную АТС
• POST/api/protected/calls/phone/outbound/sip Create outbound call by SIP — создать исходящий звонок через SIP
• POST/api/protected/calls/phone/outbound/did Create did outbound call — создать исходящий звонок с DID-номера
• POST/api/protected/calls/phone/authorization Create authorization call — создать авторизационный звонок
• POST/api/protected/calls/common/outbound/default-user-sip Create outbound call by default user SIP — создать исходящий звонок через SIP пользователя по умолчанию

Shared / voip-settings

• GET/api/protected/shared/voip-settings Get voip settings with filter — получить настройки VoIP с фильтрацией
• PATCH/api/protected/shared/voip-settings/{id} Update voip settings — обновить настройки VoIP

Shared / network-whitelists

• GET/api/protected/shared/network-whitelists Get network whitelists on account — получить список разрешённых сетей (whitelist)
• POST/api/protected/shared/network-whitelists Create network whitelist on account — добавить сеть в whitelist
• DELETE/api/protected/shared/network-whitelists/{id} Delete network whitelist on account — удалить сеть из whitelist

Shared / nnp

• GET/api/protected/shared/nnp/countries Get nnp countries — получить список стран
• GET/api/protected/shared/nnp/regions Get nnp regions — получить список регионов
• GET/api/protected/shared/nnp/cities Get nnp cities — получить список городов
• GET/api/protected/shared/nnp/operators Get nnp operators — получить список операторов
• GET/api/protected/shared/nnp/ndc-types Get nnp ndc types — получить типы кодов направлений

Shared / dashboard

• GET/api/protected/shared/dashboard Get dashboards with filter — получить список дашбордов с фильтрацией
• POST/api/protected/shared/dashboard Create dashboard — создать дашборд
• PATCH/api/protected/shared/dashboard/{id} Update dashboard by id — обновить дашборд по ID
• DELETE/api/protected/shared/dashboard/{id} Delete dashboard by id — удалить дашборд по ID
• DELETE/api/protected/shared/dashboard/{id}/accounts Detach accounts from dashboard — отвязать аккаунты от дашборда

Shared / dids

• GET/api/protected/shared/dids Get dids with filter — получить список DID-номеров с фильтрацией
• GET/api/protected/shared/dids/record Get did record — получить запись по DID-номеру
• GET/api/protected/shared/dids/without-imsi Get dids without imsi — получить номера без IMSI

Files

• GET/api/protected/files/call Get call file — получить файл звонка
• POST/api/protected/files/call Upload call file — загрузить файл звонка
• POST/api/protected/files/call/bulk Upload call files bulk — массово загрузить файлы звонков

Shared / superset

• GET/api/protected/shared/superset/guest-token Get guest token for superset — получить гостевой токен для Superset

Phone / composite-dids

• GET/api/protected/phone/composite-dids Get phone numbers — получить список телефонных номеров
• PATCH/api/protected/phone/composite-dids/{id} Edit phone number — изменить настройки номера
• GET/api/protected/phone/composite-dids/{id}/smart-features Get smart options — получить smart-функции номера
• PATCH/api/protected/phone/composite-dids/{id}/smart-features Update main smart options — обновить основные smart-настройки
• PATCH/api/protected/phone/composite-dids/{id}/smart-features/forwards/{type} Update forwarding settings on phone number — обновить настройки переадресации
• POST/api/protected/phone/composite-dids/{id}/smart-features/forwards/{type}/targets Create new forward target on phone number — добавить цель переадресации
• PATCH/api/protected/phone/composite-dids/{id}/smart-features/forwards/{type}/targets/{targetId} Update existing forward target on phone number — изменить цель переадресации
• DELETE/api/protected/phone/composite-dids/{id}/smart-features/forwards/{type}/targets/{targetId} Delete forward target on phone number — удалить цель переадресации
• PUT/api/protected/phone/composite-dids/{id}/smart-features/forwards/{type}/targets/priority Update forward targets priority on phone number — изменить приоритет целей переадресации
• PUT/api/protected/phone/composite-dids/{id}/smart-features/announces Attach announce to phone number — привязать аудио к номеру
• GET/api/protected/phone/composite-dids/smart-features/announces Get available announces — получить список аудио
• POST/api/protected/phone/composite-dids/smart-features/announces Create phone number announce — создать аудио для номера
• GET/api/protected/phone/composite-dids/smart-features/announces/{announceId}/file Get phone number announce file — получить файл аудио
• DELETE/api/protected/phone/composite-dids/smart-features/announces/{announceId} Delete announce — удалить аудио
• POST/api/protected/phone/composite-dids/{id}/smart-features/timecondition-intervals Attach timecondition interval to phone number — добавить временной интервал
• PATCH/api/protected/phone/composite-dids/{id}/smart-features/timecondition-intervals/{intervalId} Update attached timecondition interval to phone number — изменить временной интервал
• DELETE/api/protected/phone/composite-dids/{id}/smart-features/timecondition-intervals/{intervalId} Delete attached timecondition interval to phone number — удалить временной интервал

Phone / sms-messages

• GET/api/protected/phone/sms-messages Get sms messages by user numbers — получить список SMS по номерам
• GET/api/protected/phone/sms-messages/alpha-numbers Get alpha numbers — получить альфа-имена отправителей
• POST/api/protected/phone/sms-messages/send Send a2p and p2p sms — отправить SMS (A2P/P2P)

Phone / sim-cards

• GET/api/protected/phone/sim-cards Get stat sim cards — получить список SIM-карт
• GET/api/protected/phone/sim-cards/dids Get available dids for sim cards — получить доступные номера для SIM
• GET/api/protected/phone/sim-cards/stat Get sim cards from stat — получить статистику SIM-карт
• GET/api/protected/phone/sim-cards/history Get history update sim cards — получить историю изменений SIM
• PATCH/api/protected/phone/sim-cards/{iccid} Update sim card by iccid — обновить SIM-карту (привязка/отвязка номера)

Vpbx / ai-agent

• GET/api/protected/vpbx/ai-agent/available-dids Get dids available for ai agent uncond forwarding — получить номера для безусловной переадресации AI-агента
• GET/api/protected/vpbx/ai-agent/references Get many references by agent ids — получить ссылки для нескольких агентов
• GET/api/protected/vpbx/ai-agent/{agentId}/references Get all references by agent id — получить все связи агента
• GET/api/protected/vpbx/ai-agent/{agentId}/references/dids Get did references — получить привязанные номера
• GET/api/protected/vpbx/ai-agent/{agentId}/references/ivr-schemas Get ivr schema references — получить привязанные IVR-схемы

Vpbx / auto-call-settings

• GET/api/protected/vpbx/auto-call-settings Get auto call settings with filter — получить настройки автодозвона
• DELETE/api/protected/vpbx/auto-call-settings Delete auto call settings — удалить настройки автодозвона
• PATCH/api/protected/vpbx/auto-call-settings/bulk Update auto call settings bulk — массово обновить настройки автодозвона
• PATCH/api/protected/vpbx/auto-call-settings/{id} Update auto call settings — обновить настройки автодозвона

Vpbx / announces

• GET/api/protected/vpbx/announces Get announces with filter — получить список аудио
• POST/api/protected/vpbx/announces Create announce — создать аудио
• GET/api/protected/vpbx/announces/{announceId}/file Get announce file — получить файл аудио
• POST/api/protected/vpbx/announces/voice-file Create announce — создать аудио из файла
• PATCH/api/protected/vpbx/announces/{id} Update announce — обновить аудио
• DELETE/api/protected/vpbx/announces/{id} Delete announce — удалить аудио
• PATCH/api/protected/vpbx/announces/{id}/voice-file Update announce — обновить аудиофайл

Vpbx / blacklists

• GET/api/protected/vpbx/blacklists Get blacklists with filter — получить списки блокировок
• POST/api/protected/vpbx/blacklists Create blacklist — создать чёрный список
• POST/api/protected/vpbx/blacklists/default Create default blacklist — создать чёрный список по умолчанию
• PATCH/api/protected/vpbx/blacklists/{id} Update blacklist — обновить чёрный список
• DELETE/api/protected/vpbx/blacklists/{id} Delete blacklist — удалить чёрный список
• GET/api/protected/vpbx/blacklists/{id}/members Import blacklist members from file — получить/импортировать участников списка
• POST/api/protected/vpbx/blacklists/{id}/members Add member to blacklist — добавить номер в список
• DELETE/api/protected/vpbx/blacklists/{id}/members Delete member from blacklist — удалить номер из списка
• POST/api/protected/vpbx/blacklists/{id}/members/bulk Bulk add members to blacklist — массово добавить номера
• DELETE/api/protected/vpbx/blacklists/{id}/members/bulk Bulk delete members from blacklist — массово удалить номера
• POST/api/protected/vpbx/blacklists/{id}/members/imports Import blacklist members from file — импортировать номера из файла

Vpbx / codes

• GET/api/protected/vpbx/codes Get codes with filter — получить список кодов
• POST/api/protected/vpbx/codes Create code — создать код
• POST/api/protected/vpbx/codes/default Create default code — создать код по умолчанию
• PATCH/api/protected/vpbx/codes/{id} Update code — обновить код
• DELETE/api/protected/vpbx/codes/{id} Delete code — удалить код

Vpbx / codes-templates

• GET/api/protected/vpbx/codes-templates Get codes templates with filter — получить шаблоны кодов

Vpbx / core-users

• GET/api/protected/vpbx/core-users — получить список пользователей ВАТС

Vpbx / departments

• GET/api/protected/vpbx/departments Get departments with filter — получить список отделов
• POST/api/protected/vpbx/departments Create department — создать отдел
• POST/api/protected/vpbx/departments/default Create default department — создать отдел по умолчанию
• PATCH/api/protected/vpbx/departments/{id} Update department — обновить отдел
• DELETE/api/protected/vpbx/departments/{id} Delete department — удалить отдел
• POST/api/protected/vpbx/departments/{id}/members/bulk Bulk add members to department — массово добавить участников
• PATCH/api/protected/vpbx/departments/{id}/members Update department members — обновить участников
• DELETE/api/protected/vpbx/departments/{id}/members Bulk delete members from department — массово удалить участников

Vpbx / composite-int-number

• GET/api/protected/vpbx/composite-int-number Get composite int number — получить составные внутренние номера
• GET/api/protected/vpbx/composite-int-number/first-free-number Get first free int number — получить первый свободный внутренний номер

Vpbx / int-number

• GET/api/protected/vpbx/int-number Get int number with filter — получить список внутренних номеров с фильтрацией

Vpbx / conferences

• GET/api/protected/vpbx/conferences Get list of conferences by vpbxId — получить список конференций
• POST/api/protected/vpbx/conferences Create conference with internal number — создать конференцию с внутренним номером
• POST/api/protected/vpbx/conferences/default Create default conference — создать конференцию по умолчанию
• PATCH/api/protected/vpbx/conferences/{id} Update conference with internal number — обновить конференцию
• DELETE/api/protected/vpbx/conferences/{id} Delete conference and internal number by vpbxId — удалить конференцию и её номер

Vpbx / external-pbxs

• GET/api/protected/vpbx/external-pbxs Get external pbx attached to vpbx — получить внешние АТС
• POST/api/protected/vpbx/external-pbxs Create external pbx — создать внешнюю АТС
• PATCH/api/protected/vpbx/external-pbxs/{id} Update external pbx — обновить внешнюю АТС
• DELETE/api/protected/vpbx/external-pbxs/{id} Remove external pbx — удалить внешнюю АТС

Vpbx / faxes

• GET/api/protected/vpbx/faxes Get faxes with filter — получить список факсов
• POST/api/protected/vpbx/faxes Create fax — создать факс
• GET/api/protected/vpbx/faxes/files Get fax files with filter — получить файлы факсов
• GET/api/protected/vpbx/faxes/files/{faxFileId}/file Get pdf fax file by id — получить PDF-файл факса
• POST/api/protected/vpbx/faxes/default Create default fax — создать факс по умолчанию
• PATCH/api/protected/vpbx/faxes/{id} Update fax — обновить факс
• DELETE/api/protected/vpbx/faxes/{id} Delete fax — удалить факс
• DELETE/api/protected/vpbx/faxes/files/{faxFileId} Delete fax file by id — удалить файл факса

Vpbx / fmc-numbers

• GET/api/protected/vpbx/fmc-numbers Get fmc numbers with filter — получить FMC-номера
• POST/api/protected/vpbx/fmc-numbers Create fmc number — создать FMC-номер
• PATCH/api/protected/vpbx/fmc-numbers/{id} Update fmc number — обновить FMC-номер
• DELETE/api/protected/vpbx/fmc-numbers/{id} Delete fmc number — удалить FMC-номер

Vpbx / ivr-schemas

• GET/api/protected/vpbx/ivr-schemas Get ivr schemas — получить список IVR-схем
• POST/api/protected/vpbx/ivr-schemas Create ivr schema — создать IVR-схему
• POST/api/protected/vpbx/ivr-schemas/{id}/move Move ivr schema from one groups to anothers — переместить IVR-схему между группами
• PUT/api/protected/vpbx/ivr-schemas/reset Reset ivr schemas from archive — восстановить IVR-схемы из архива
• DELETE/api/protected/vpbx/ivr-schemas/archive Clean archive — очистить архив IVR
• POST/api/protected/vpbx/ivr-schemas/{id}/copy Copy ivr schema by id — скопировать IVR-схему
• PATCH/api/protected/vpbx/ivr-schemas/{id}/lock Set ivr schema lock — заблокировать/разблокировать IVR-схему
• PATCH/api/protected/vpbx/ivr-schemas/{id} Update ivr schema — обновить IVR-схему
• DELETE/api/protected/vpbx/ivr-schemas/{id} Delete ivr schema — удалить IVR-схему

👉 Параметры:

• GET/api/protected/vpbx/ivr-schemas/parameters Get ivr parameters on ivr schema with filter — получить параметры IVR
• GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters Get ivr parameters on ivr schema — получить параметры схемы
• POST/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters Create global ivr parameter on ivr schema — создать параметр
• GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters/grouped Get grouped ivr parameters on ivr schema — получить сгруппированные параметры
• POST/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters/bulk Bulk create ivr parameters on ivr schema — массово создать параметры
• PATCH/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters/{ivrParameterId} Update ivr parameter on ivr schema — обновить параметр
• DELETE/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters/{ivrParameterId} Delete ivr parameter on ivr schema — удалить параметр

👉 Объекты:

• GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/objects Get ivr objects on ivr schema — получить объекты IVR
• GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/objects/composite Get ivr objects with objects on ivr schema — получить объекты с вложениями

👉 История:

• GET/api/protected/vpbx/ivr-schemas/{id}/history Get history ivr schema — получить историю изменений
• POST/api/protected/vpbx/ivr-schemas/{id}/history/redo Redo ivr schema changes — повторить изменения
• POST/api/protected/vpbx/ivr-schemas/{id}/history/undo Undo ivr schema changes — отменить изменения
• POST/api/protected/vpbx/ivr-schemas/{id}/history/clear Clear ivr schema changes history — очистить историю

👉 Связи и объекты:

• GET/api/protected/vpbx/ivr-schemas/ivr-links Get ivr links with filter — получить связи IVR
• POST/api/protected/vpbx/ivr-schemas/ivr-links Create ivr link — создать связь
• PATCH/api/protected/vpbx/ivr-schemas/ivr-links/reassign Reassing ivr links — переназначить связи
• DELETE/api/protected/vpbx/ivr-schemas/ivr-links/bulk Bulk delete ivr links — массово удалить связи
• DELETE/api/protected/vpbx/ivr-schemas/ivr-links/{id} Delete ivr link — удалить связь
• GET/api/protected/vpbx/ivr-schemas/ivr-objects/agents/unassigned Get unassignet agents — получить неназначенных агентов
• POST/api/protected/vpbx/ivr-schemas/ivr-objects Create ivr object — создать объект IVR
• POST/api/protected/vpbx/ivr-schemas/ivr-objects/default Create default ivr object — создать объект по умолчанию
• POST/api/protected/vpbx/ivr-schemas/ivr-objects/bulk Bulk create ivr objects — массово создать объекты
• PATCH/api/protected/vpbx/ivr-schemas/ivr-objects/bulk Bulk update ivr objects — массово обновить объекты
• DELETE/api/protected/vpbx/ivr-schemas/ivr-objects/bulk Bulk delete ivr objects — массово удалить объекты
• PATCH/api/protected/vpbx/ivr-schemas/ivr-objects/{id} Update ivr object — обновить объект
• DELETE/api/protected/vpbx/ivr-schemas/ivr-objects/{id} Delete ivr object — удалить объект

Vpbx / ivr-schema-groups

• GET/api/protected/vpbx/ivr-schema-groups Get ivr schema groups — получить группы IVR-схем
• POST/api/protected/vpbx/ivr-schema-groups Create ivr schema group — создать группу
• POST/api/protected/vpbx/ivr-schema-groups/attach Attach ivr schemas to groups — привязать схемы к группе
• POST/api/protected/vpbx/ivr-schema-groups/detach Detach ivr schemas from groups — отвязать схемы от группы
• PATCH/api/protected/vpbx/ivr-schema-groups/{id} Update ivr schema group — обновить группу
• DELETE/api/protected/vpbx/ivr-schema-groups/{id} Delete ivr schema group — удалить группу

Vpbx / ivr-schema-template

• GET/api/protected/vpbx/ivr-schema-template Get ivr schema tempaltes with filter — получить шаблоны IVR
• POST/api/protected/vpbx/ivr-schema-template Create ivr schema tempalte by schema id — создать шаблон из схемы
• GET/api/protected/vpbx/ivr-schema-template/{templateId}/ivr-schema Get ivr schema template in ivr schema format — получить шаблон как IVR-схему
• POST/api/protected/vpbx/ivr-schema-template/{templateId}/ivr-schema Create ivr schema by tempalte id — создать IVR из шаблона
• PATCH/api/protected/vpbx/ivr-schema-template/{templateId} Update ivr schema template by schema id — обновить шаблон
• DELETE/api/protected/vpbx/ivr-schema-template/{templateId} Delete ivr schema template — удалить шаблон

Vpbx / voice-menu

• GET/api/protected/vpbx/voice-menu Get voice menu with filter — получить голосовые меню
• POST/api/protected/vpbx/voice-menu Create voice menu — создать голосовое меню
• POST/api/protected/vpbx/voice-menu/default Create default voice menu — создать меню по умолчанию
• PATCH/api/protected/vpbx/voice-menu/{id} Update voice menu — обновить меню
• DELETE/api/protected/vpbx/voice-menu/{id} Delete voice menu — удалить меню

Vpbx / missed-call-settings

• GET/api/protected/vpbx/missed-call-settings Get missed call settings with filter — получить настройки пропущенных вызовов
• POST/api/protected/vpbx/missed-call-settings Create missed call settings — создать настройки
• PATCH/api/protected/vpbx/missed-call-settings/{id} Update missed call settings — обновить настройки
• DELETE/api/protected/vpbx/missed-call-settings/{id} Delete missed call settings — удалить настройки

Vpbx / music-on-hold

• GET/api/protected/vpbx/music-on-hold Get music on hold with filter — получить музыку на удержании
• POST/api/protected/vpbx/music-on-hold Create music on hold — создать музыку на удержании
• PATCH/api/protected/vpbx/music-on-hold/{id} Update music on hold — обновить музыку на удержании
• DELETE/api/protected/vpbx/music-on-hold/{id} Delete music on hold — удалить музыку на удержании
• GET/api/protected/vpbx/music-on-hold/{id}/file Get music on hold file — получить аудиофайл

Vpbx / phone-numbers

• GET/api/protected/vpbx/phone-numbers Get phone numbers with filter — получить список телефонных номеров
• POST/api/protected/vpbx/phone-numbers Create phone number — создать номер
• PATCH/api/protected/vpbx/phone-numbers/{id} Update phone number — обновить номер
• DELETE/api/protected/vpbx/phone-numbers/{id} Delete phone number — удалить номер

Vpbx / operator

• GET/api/protected/vpbx/operator Get operator with filter — получить оператора

Vpbx / paidmethods

• GET/api/protected/vpbx/paidmethods/brand-voice/template Get brand voice templates — получить шаблоны голосов
• GET/api/protected/vpbx/paidmethods/brand-voice/template/grouped Get grouped brand voice templates — получить сгруппированные шаблоны
• GET/api/protected/vpbx/paidmethods/brand-voice/template/{templateId}/file Get brand voice template file — получить файл шаблона
• POST/api/protected/vpbx/paidmethods/brand-voice/template/{templateId}/tts Get brand voice template tts file — сгенерировать TTS файл
• GET/api/protected/vpbx/paidmethods/speaker Get speechkit speaker with filter — получить список голосов (speaker)
• GET/api/protected/vpbx/paidmethods/speaker/grouped Get grouped speaker — получить сгруппированные голоса
• GET/api/protected/vpbx/paidmethods/recog-provider Get recog provider with filter — получить провайдеров распознавания
• GET/api/protected/vpbx/paidmethods/recog-provider/grouped Get grouped recog provider — получить сгруппированных провайдеров
• POST/api/protected/vpbx/paidmethods/speech/file Get tts file — получить TTS аудиофайл

Vpbx / queues

• GET/api/protected/vpbx/queues Get queues with filter — получить очереди
• POST/api/protected/vpbx/queues Create queue — создать очередь
• GET/api/protected/vpbx/queues/{id}/members Get queue members — получить участников очереди
• DELETE/api/protected/vpbx/queues/{id}/members Delete queue member from queue — удалить участника
• PATCH/api/protected/vpbx/queues/members/by-numbers Update queue members — обновить участников
• PATCH/api/protected/vpbx/queues/{id} Update queue — обновить очередь
• DELETE/api/protected/vpbx/queues/{id} Delete queue — удалить очередь

Vpbx / resource-usage

• GET/api/protected/vpbx/resource-usage Get resource usage with filter — получить статистику использования ресурсов

Vpbx / settings

• GET/api/protected/vpbx/settings Get VPBXs on account — получить список ВАТС аккаунта
• PATCH/api/protected/vpbx/settings/{id} Update vpbx settings — обновить настройки ВАТС

Vpbx / short-numbers

• GET/api/protected/vpbx/short-numbers Get short numbers with filter — получить короткие номера
• POST/api/protected/vpbx/short-numbers Create short number — создать короткий номер
• POST/api/protected/vpbx/short-numbers/default Create default short number — создать номер по умолчанию
• PATCH/api/protected/vpbx/short-numbers/{id} Update short number — обновить номер
• DELETE/api/protected/vpbx/short-numbers/{id} Delete short number — удалить номер

Vpbx / sms-targets

• GET/api/protected/vpbx/sms-targets Get sms targets with filter — получить получателей SMS
• POST/api/protected/vpbx/sms-targets Create sms target — создать получателя
• POST/api/protected/vpbx/sms-targets/default Create default sms target — создать по умолчанию
• PATCH/api/protected/vpbx/sms-targets/{id} Update sms target — обновить получателя
• DELETE/api/protected/vpbx/sms-targets/{id} Delete sms target — удалить получателя

Vpbx / speechkit

• GET/api/protected/vpbx/speechkit Get speechkit with filter — получить настройки SpeechKit
• POST/api/protected/vpbx/speechkit Create speechkit — создать настройки
• POST/api/protected/vpbx/speechkit/default Create default speechkit — создать по умолчанию
• PATCH/api/protected/vpbx/speechkit/{id} Update speechkit — обновить настройки
• DELETE/api/protected/vpbx/speechkit/{id} Delete speechkit with filter — удалить настройки

Vpbx / synthesis

• GET/api/protected/vpbx/synthesis Get synthesis — получить синтез речи
• POST/api/protected/vpbx/synthesis Create synthesis — создать синтез
• GET/api/protected/vpbx/synthesis/{synthesisId}/file Get synthesis file — получить аудиофайл
• POST/api/protected/vpbx/synthesis/default Create default synthesis — создать по умолчанию
• PATCH/api/protected/vpbx/synthesis/{id} Update synthesis — обновить синтез
• DELETE/api/protected/vpbx/synthesis/{id} Delete synthesis — удалить синтез

Vpbx / stt-tts-templates

• GET/api/protected/vpbx/stt-tts-templates Get stt tts template with filter — получить шаблоны STT/TTS
• POST/api/protected/vpbx/stt-tts-templates Create stt tts template — создать шаблон
• PATCH/api/protected/vpbx/stt-tts-templates/{id} Update stt tts template — обновить шаблон
• DELETE/api/protected/vpbx/stt-tts-templates/{id} Delete stt tts template — удалить шаблон

Vpbx / timeconditions

• GET/api/protected/vpbx/timeconditions Get schedules with filter — получить расписания
• POST/api/protected/vpbx/timeconditions Create schedules — создать расписание
• POST/api/protected/vpbx/timeconditions/default Create default shedules — создать по умолчанию
• PATCH/api/protected/vpbx/timeconditions/{id} Update schedules — обновить расписание
• DELETE/api/protected/vpbx/timeconditions/{id} Remove schedules — удалить расписание

Vpbx / timecondition-calendar

• GET/api/protected/vpbx/timecondition-calendar Get timecondition calendar with filter — получить календарь условий
• POST/api/protected/vpbx/timecondition-calendar Create timecondition calendar — создать календарь
• PATCH/api/protected/vpbx/timecondition-calendar/{id} Update timecondition calendar — обновить календарь
• DELETE/api/protected/vpbx/timecondition-calendar/{id} Remove timecondition calendar — удалить календарь

Vpbx / transcribation

• GET/api/protected/vpbx/transcribation Get transcribation settings — получить настройки транскрибации
• PATCH/api/protected/vpbx/transcribation Update transcribation settings — обновить настройки
• GET/api/protected/vpbx/transcribation/providers Get providers list — получить список провайдеров

Vpbx / voice-mail-box

• GET/api/protected/vpbx/voice-mail-box Get voice mail box with filter — получить голосовые ящики
• POST/api/protected/vpbx/voice-mail-box Create voice mail box — создать ящик
• POST/api/protected/vpbx/voice-mail-box/default Create default voice mail box — создать по умолчанию
• PATCH/api/protected/vpbx/voice-mail-box/{id} Update voice mail box — обновить ящик
• DELETE/api/protected/vpbx/voice-mail-box/{id} Delete voice mail box — удалить ящик

Vpbx / composite-dids

• GET/api/protected/vpbx/composite-dids Get vpbx composite dids on vpbx — получить DID-номера ВАТС
• GET/api/protected/vpbx/composite-dids/disabled-vpbx Get disabled vpbx — получить отключённые ВАТС
• GET/api/protected/vpbx/composite-dids/sip-uri Generate sipUriNumber — сгенерировать SIP URI
• POST/api/protected/vpbx/composite-dids/sip-uri Connect sip uri did to vpbx — подключить SIP URI
• POST/api/protected/vpbx/composite-dids/internal/bulk Connect internal did to vpbx bulk — массово подключить внутренние DID
• DELETE/api/protected/vpbx/composite-dids/bulk Detach vpbx did from vpbx bulk — массово отвязать DID
• PATCH/api/protected/vpbx/composite-dids/{id} Update vpbx composite did — обновить DID
• DELETE/api/protected/vpbx/composite-dids/{id} Detach vpbx did from vpbx — отвязать DID
• POST/api/protected/vpbx/composite-dids/internal Connect internal did to vpbx — подключить внутренний DID
• POST/api/protected/vpbx/composite-dids/external Connect external did to vpbx — подключить внешний DID

Vpbx / monitoring

• GET/api/protected/vpbx/monitoring/composite-int-number — получить мониторинг внутренних номеров

Vpbx / transcribation-template

• GET/api/protected/vpbx/transcribation-template Get transcribation templates with filter — получить шаблоны транскрибации
• POST/api/protected/vpbx/transcribation-template Create transcribatin template — создать шаблон
• PATCH/api/protected/vpbx/transcribation-template/{id} Update transcribatin template — обновить шаблон
• DELETE/api/protected/vpbx/transcribation-template/{id} Delete transcribatin template — удалить шаблон

Equipment / help-links

• GET/api/protected/equipment/help-links HelpLinks — получить справочные ссылки

Equipment / devices

• GET/api/protected/equipment/devices Get sip devices on account — получить SIP-устройства
• POST/api/protected/equipment/devices Create sip device — создать устройство
• GET/api/protected/equipment/devices/peer-status Get sip devices pees status by names — получить статус устройств
• PUT/api/protected/equipment/devices/priority Update sip devices priority — обновить приоритет устройств
• GET/api/protected/equipment/devices/{name}/registration-events Get sip devices registration events — получить события регистрации
• POST/api/protected/equipment/devices/bulk Create bulk sip devices — массово создать устройства
• PATCH/api/protected/equipment/devices/bulk Update bulk sip devices — массово обновить устройства
• DELETE/api/protected/equipment/devices/bulk Delete many sip devices — массово удалить устройства
• POST/api/protected/equipment/devices/transfer/bulk Transfer many devices to another account in same contract with device account — массово перенести устройства
• PATCH/api/protected/equipment/devices/{name} Update sip device — обновить устройство
• DELETE/api/protected/equipment/devices/{name} Delete sip device — удалить устройство
• POST/api/protected/equipment/devices/{name}/transfer Transfer device to another account in same contract with device account — перенести устройство
• PATCH/api/protected/equipment/devices/{name}/secret Update sip device secret — обновить пароль устройства
• POST/api/protected/equipment/devices/settings/export/email Send devices settings to emails — отправить настройки на email

Users / devices

• GET/api/protected/users/devices Get sip devices attached to user from all accounts accessed by user — получить устройства пользователя

Equipment / trunks

• GET/api/protected/equipment/trunks Get trunks on account — получить SIP-транки
• GET/api/protected/equipment/trunks/composite-dids Get trunk composite dids with filter — получить DID транков
• PATCH/api/protected/equipment/trunks/composite-dids/bulk Bulk attached trunk composite did — массово привязать DID
• DELETE/api/protected/equipment/trunks/composite-dids/bulk Bulk detach the number from sip trunk — массово отвязать номера
• PATCH/api/protected/equipment/trunks/sip-devices/bulk Update bulk sip device for trunk — обновить устройства транка
• PATCH/api/protected/equipment/trunks/sip-devices/detach/bulk Detach bulk sip device for trunk — отвязать устройства
• PATCH/api/protected/equipment/trunks/composite-dids/{id} Attached trunk composite did — привязать DID
• DELETE/api/protected/equipment/trunks/composite-dids/{id} Detach the number from sip trunk — отвязать номер
• PATCH/api/protected/equipment/trunks/{id} Update trunk settings — обновить настройки транка

Также см.:
Методы API → Интеграция
Методы API → Base
Методы API → Автозвонки
Методы API → API ЛК
Методы API → Платные методы
Ответы на запросы методов API