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

Чтобы воспользоваться методами 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/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 — Получение белых списков сети на аккаунте.
  • POST/api/protected/shared/network-whitelists Create network whitelist on account — Создание белого списка сети на аккаунте.
  • DELETE/api/protected/shared/network-whitelists/{id} Delete network whitelist on account — Удаление белого списка сети на аккаунте.

• 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 — Получение смарт-настроек номера.
  • PATCH/api/protected/phone/composite-dids/{id}/smart-features Update main smart options — Обновление основных смарт-настроек номера.
  • 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 по номерам пользователей.

• VPBX/blacklists

  • GET/api/protected/vpbx/blacklists Get blacklists with filter — Получение черных списков с фильтром.
  • 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 — Получение кодов с фильтром.

• VPBX/codes-templates

  • GET/api/protected/vpbx/codes-templates Get codes templates 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 — Создание конференции с внутренним номером.
  • 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 — Создание факса.
  • PATCH/api/protected/vpbx/faxes/{id} Update fax — Обновление факса.
  • DELETE/api/protected/vpbx/faxes/{id} Delete fax — Удаление факса.

• 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-схем.
  • GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters Get ivr parameters on ivr schema — Получение параметров IVR-схемы.
  • PATCH/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/parameters/{ivrParameterId} Update ivr parameter on ivr schema — Обновление параметра IVR-схемы.
  • GET/api/protected/vpbx/ivr-schemas/{ivrSchemaId}/objects Get ivr objects on ivr schema — Получение объектов IVR-схемы.

• 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/queues

  • GET/api/protected/vpbx/queues Get queues with filter — Получение очередей с фильтром.
  • GET/api/protected/vpbx/queues/{id}/members Get queue members — Получение участников очереди.
  • PATCH/api/protected/vpbx/queues/members/by-numbers Update queue members — Обновление участников очереди.

• 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 — Создание короткого номера.
  • 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 с фильтром.

• VPBX/timeconditions

  • GET/api/protected/vpbx/timeconditions Get schedules with filter — Получение графиков с фильтром.
  • POST/api/protected/vpbx/timeconditions Create schedules — Создание графиков.
  • PATCH/api/protected/vpbx/timeconditions/{id} Update schedules — Обновление графиков.
  • DELETE/api/protected/vpbx/timeconditions/{id} Remove schedules — Удаление графиков.

• Vpbx/composite-dids

  • GET/api/protected/vpbx/composite-dids Get vpbx composite dids on vpbx — Получение сводных DID на ВАТС.
  • PATCH/api/protected/vpbx/composite-dids/{id} Update vpbx composite did — Обновление сводного DID на ВАТС.

• 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 — Создание SIP-устройства.
  • PUT/api/protected/equipment/devices/priority Update sip devices priority — Обновление приоритета SIP-устройств.
  • GET/api/protected/equipment/devices/{name}/registration-events Get sip devices registration events — Получение событий регистрации SIP-устройств.
  • POST/api/protected/equipment/devices/bulk Create bulk sip devices — Массовое создание SIP-устройств.
  • PATCH/api/protected/equipment/devices/bulk Update bulk sip devices — Массовое обновление SIP-устройств.
  • DELETE/api/protected/equipment/devices/bulk Delete many sip devices — Массовое удаление SIP-устройств.
  • 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 — Обновление SIP-устройства.
  • DELETE/api/protected/equipment/devices/{name} Delete sip device — Удаление SIP-устройства.
  • 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 — Обновление секретного ключа SIP-устройства.

• Users/devices

  • GET/api/protected/users/devices Get sip devices attached to user from all accounts accessed by user — Получение списка SIP-устройств, прикрепленных к пользователю, с доступом ко всем учетным записям, которыми пользуется данный пользователь.

• 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 — Массовое отключение номеров от SIP-транков.
  • PATCH/api/protected/equipment/trunks/composite-dids/{id} Attached trunk composite did — Присоединение сводного DID к транку по ID.
  • DELETE/api/protected/equipment/trunks/composite-dids/{id} Detach the number from sip trunk — Отключение номера от SIP-транка по ID.
  • PATCH/api/protected/equipment/trunks/{id} Update trunk settings — Обновление настроек транка.

Также см.:

Методы API → Интеграция

Методы API → Автозвонки

Методы API → API ЛК

Методы API → Интеграции v2

Методы API → Адресная книга