Группа внутренних номеров (/extension_group/)

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

Ресурс позволяет управлять группами внутренних номеров клиента. Группы внутренних номеров предназначены для объединения внутренних номеров клиента в группу, что позволяет:

  • работать с рядом ресурсов (записи разговоров, голосовая почта, входящие факсы) на уровне групп. Например, можно получить список записей разговора для внутренних номеров, находящихся в определенной группе;

  • организовывать доступ к ресурсам внутренних номеров с помощью создания пользователя типа "группа внутренних номеров". Такой пользователь, в отличии от пользователя типа "внутренний номер", может использовать ресурсы нескольких внутренних номеров, но, в отличие от пользователя типа "клиент", ему доступны ресурсы только тех внутренних номеров, которые находятся в его группе.

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

Имя

Тип

Описание

Имя

Тип

Описание

id 

long

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

name 

string

Имя группы внутренних номеров

client_id

long

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

extra_params 

string

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

Примеры

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

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

{ "id": 14, "name": "Новая группа внутренних номеров", "client_id": 12, "extra_params": null }

Помещение внутреннего номера c идентификатором 30 в ранее созданную группу
(для этого внутренний номер должен быть предварительно создан):

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

{ "status": "active", "domain": "sip.ringme.ru", "create_date": "2020-03-16 12:18:08", "name": "000*300", "dial_rule_limit": null, "extension_group_id": 14, "label": "Петров", "caller_id_name": "Петров П.П.", "client_id": 12, "extra_params": "null", "message_did": "string", "dial_rule_id": null, "ani_rfc3325": false, "type": "phone", "id": 30, "did_as_transfer_caller_id": null }

Аналогично помещаем ранее созданный внутренний номер c идентификатором 28 в ранее созданную группу:

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

{ "status": "active", "domain": "sip.ringme.ru", "create_date": "2020-03-16 12:18:08", "name": "000*301", "dial_rule_limit": null, "extension_group_id": 14, "label": "Сидоров", "caller_id_name": "Сидоров С.С.", "client_id": 12, "extra_params": "312", "message_did": "string", "dial_rule_id": null, "ani_rfc3325": false, "type": "phone", "id": 28, "did_as_transfer_caller_id": null }

Получение списка всех внутренних номеров в данной группе:

Получение списка записей разговоров внутренних номеров в заданной группе с 1 по 21 апреля 2016 года:

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

POST /client/{client_id}/extension_group/

Добавить группу внутренних номеров

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

Параметры JSON

Имя

Тип

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

Имя

Тип

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

name

string

нет

extra_params 

string

нет

Поля ответа

Имя

Тип

Имя

Тип

id

integer

client_id

integer

name

string

extra_params 

string

GET /client/{client_id}/extension_group/

Получить список групп внутренних номеров клиента

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

Параметры запроса

Имя

Тип

Имя

Тип

id

array [string]

name

array [string]

Поля ответа

Имя

Тип

Имя

Тип

id

integer

client_id

integer

name

string

extra_params 

string

PUT /client/{client_id}/extension_group/{ext_group_id}

Обновить группу внутренних номеров

Параметры URL

Имя

Тип

Имя

Тип

ext_group_id

integer

client_id

string

Параметры JSON

Имя

Тип

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

Имя

Тип

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

name

string

нет

extra_params 

string

нет

Поля ответа

Имя

Тип

Имя

Тип

id

integer

client_id

integer

name

string

extra_params 

string

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