Внутренний номер (/extension/)

Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)

Внутренний номер является основной единицей АТС, выполняющей определенный перечень функций в соответствии с заданным типом. Ресурс служит для управления наиболее абстрактными свойствами внутреннего номера. Для специфических параметров внутренних номеров в зависимости от типа есть отдельные разделы (например, ресурс /phone/ для внутренних номеров типа "телефонный терминал").

Внутренний номер может быть адресован номерами разного типа:

  • абсолютный — имеет вид префикс_домена*префикс_клиента*имя_внутреннего_номера или префикс_клиента*имя_внутреннего_номера@имя_домена (например, 00500*0003*100 или 0003*100@somehost.com). Префиксы клиента и домена можно получить из ресурса “Клиент (/client/)”;

  • относительный — в пределах одного домена префикс_клиента*имя_внутреннего_номера (например, 0003*100) и просто имя_внутреннего_номера в пределах одного клиента (например, 100).

Вариант префикс_клиента*имя_внутреннего_номера является основным используемым при выдаче результатов и приеме параметров.

Будучи созданным, внутренний номер не может быть переименован. Возможно удаление с последующим созданием под другим именем.

Есть возможность объединения нескольких внутренних номеров в группу внутренних номеров.

При обновлении параметров внутреннего номера, находящегося в , синхронизирующиеся параметры (Список синхронизирующихся параметров) также обновятся и на остальных внутренних номерах в “bundle“

Описание структур данных

Внутренний номер (ExtensionItem)

Имя

Тип

Обяза-тельный

Описание

Имя

Тип

Обяза-тельный

Описание

ani_rfc3325

boolean

нет

Предназначено для вставки в поле P-Asserted-Identity внешнего номера, на который пришел вызов в АТС, в случае дальнейшей переадресации вызова с данного внутреннего номера на другой внешний номер (не использовать без необходимости, о возможностях и последствиях использования необходимо уточнить у провайдера телефонии)

caller_id_name

string

нет

Отображаемое имя при исходящем вызове

client_id

long

да

Идентификатор клиента, которому принадлежит внутренний номер

create_date 

string

нет

Дата создания внутреннего номера

dial_rule_id 

long

нет

Идентификатор правила набора

dial_rule_limit

long

нет

Лимит количества правил набора

did_as_transfer_caller_id 

string

нет

Внешний номер АТС, на который изначально пришел вызов, отображаемый при дальнейшей переадресации номера

domain

string

нет

Домен клиента

extension_group_id

long

нет

Идентификатор группы, которой принадлежит внутренний номер

extra_params

string

нет

Дополнительные параметры

id

long

да

Уникальный идентификатор внутреннего номера

label

string

нет

Display Name внутреннего номера. Отображается на вызываемом терминале при исходящих вызовах (если поддерживается)

message_did

string

нет

Сообщение, которое придет на данный внутренний номер в случае, если за ним будет закреплен внешний номер

name

string

да

префикс_клиента*имя_внутреннего_номера или просто имя_внутреннего_номера (в этом случае префикс будет дописан автоматически). Разрядность номера в пределах клиента одинакова и определяется его свойствами

status

string

нет

Статус внутреннего номера:

  • 'active' – активен;

  • 'blocked' – заблокирован

type

string

да

Тип внутреннего номера. Параметры настройки, зависящие от типа, находятся в соответствующих разделах:

caller_id_group_id

long

нет

Идентификатор группы АОНов, доступных для подстановки при исходящих (не внутренних) вызовах

client_public_caller_id_number

string

нет

Используемое в данным момент значине АОНа из группы “caller_id_group_id

Пример

Создание внутреннего номера типа 'phone':

Ответ системы:

{ "status": "active", "domain": "sip.ringme.ru", "create_date": "2020-03-16 12:11:13", "name": "000*100",  "dial_rule_limit": null, "extension_group_id": null, "label": "Иванов Петр", "caller_id_name": null, "client_id": 12, "extra_params": null,  "message_did": null, "dial_rule_id": null,  "ani_rfc3325": false, "type": "phone", "id": 190, "did_as_transfer_caller_id": null, "caller_id_group_id": null, "client_public_caller_id_number": null }

Ресурсы раздела "Клиент"

POST /client/{client_id}/extension/
Добавить внутренний номер

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

Параметры JSON

Имя

Тип

Обязательный

Имя

Тип

Обязательный

caller_id_name

string

нет

dial_rule_id 

long

нет

dial_rule_limit

long

нет

did_as_transfer_caller_id 

string

нет

extension_group_id

long

нет

extra_params

string

нет

label

string

нет

message_did

string

нет

name

string

да

status

string

нет

type

string

да

caller_id_group_id

long

нет

client_public_caller_id_number

string

нет

Поля ответа

Имя

Тип

Имя

Тип

ani_rfc3325

boolean

caller_id_name

string

client_id

long

create_date 

string

dial_rule_id 

long

dial_rule_limit

long

did_as_transfer_caller_id 

string

domain

string

extension_group_id

long

extra_params

string

id

long

label

string

message_did

string

name

string

status

string

type

string

caller_id_group_id

long

client_public_caller_id_number

string

GET /client/{client_id}/extension/
Получить список внутренних номеров клиента

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

Параметры JSON

Имя

Тип

Имя

Тип

status

array [string]

name

array [string]

id

array [string]

client_id

string

extension_group_id

array [string]

per_page

integer

type

array [string]

page

integer

Поля ответа

Имя

Тип

Имя

Тип

ani_rfc3325

boolean

caller_id_name

string

client_id

long

create_date 

string

dial_rule_id 

long

dial_rule_limit

long

did_as_transfer_caller_id 

string

domain

string

extension_group_id

long

extra_params

string

id

long

label

string

message_did

string

name

string

status

string

type

string

caller_id_group_id

long

client_public_caller_id_number

string

PUT /client/{client_id}/extension/{extension_id}
Обновить внутренний номер

Параметры URL

Имя

Тип

Имя

Тип

extension_id

integer

client_id

string

Параметры JSON

Имя

Тип

Обязательный

Имя

Тип

Обязательный

caller_id_name

string

нет

dial_rule_id 

long

нет

dial_rule_limit

long

нет

did_as_transfer_caller_id 

string

нет

extension_group_id

long

нет

extra_params

string

нет

label

string

нет

message_did

string

нет

status

string

нет

caller_id_group_id

long

нет

client_public_caller_id_number

string

нет

Поля ответа

Имя

Тип

Имя

Тип

ani_rfc3325

boolean

caller_id_name

string

client_id

long

create_date 

string

dial_rule_id 

long

dial_rule_limit

long

did_as_transfer_caller_id 

string

domain

string

extension_group_id

long

extra_params

string

id

long

label

string

message_did

string

name

string

status

string

type

string

caller_id_group_id

long

client_public_caller_id_number

string

GET /client/{client_id}/extension/{extension_id}
Получить данные о внутреннем номере

Параметры URL

Имя

Тип

Имя

Тип

extension_id

integer

client_id

string

Поля ответа

Имя

Тип

Имя

Тип

ani_rfc3325

boolean

caller_id_name

string

client_id

long

create_date 

string

dial_rule_id 

long

dial_rule_limit

long

did_as_transfer_caller_id 

string

domain

string

extension_group_id

long

extra_params

string

id

long

label

string

message_did

string

name

string

status

string

type

string

caller_id_group_id

long

client_public_caller_id_number

string

Ресурсы раздела "Группа внутренних номеров"

Ресурсы раздела "Внутренний номер"