Мы обновили документацию, актуальная версия страницы доступна по ссылке: Группа внутренних номеров (/extension_group/)

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

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

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

Имя	Тип	Описание
`id`	`integer`	Уникальный идентификатор группы добавочных
`name`	`string`	Имя группы добавочных
`client_id`	`integer`	Идентификатор клиента, которому принадлежит группа

Пример

Создадим группу добавочных

метод	ресурс	данные	ответ
POST	/client/@me/extension_group/	{ "name": "Новая группа добавочных" }	{ "id": 14, "client_id": 12, "name": "Новая группа добавочных" }

Поместим добавочный c идентификатором 30 в созданную группу

метод	ресурс	данные	ответ
PUT	/client/@me/extension/30	{ "extension_group_id": 14 }	{ "status": "active", "dial_rule_limit": null, "name": "000*300", "extension_group_id": 14, "label": "Hello", "client_id": 12, "extra_params": null, "type": "phone", "id": 30 }

Поместим добавочный c идентификатором 28 в созданную группу

метод	ресурс	данные	ответ
PUT	/client/@me/extension/28	{ "extension_group_id": 14 }	{ "status": "active", "dial_rule_limit": null, "name": "000*301", "extension_group_id": 14, "label": null, "client_id": 12, "extra_params": "312", "type": "phone", "id": 28 }

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

метод	ресурс	данные	ответ
GET	/extension_group/14/extension/		[ { "status": "active", "dial_rule_limit": null, "name": "000301", "extension_group_id": 14, "label": null, "client_id": 12, "extra_params": "312", "type": "phone", "id": 28 }, { "status": "active", "dial_rule_limit": null, "name": "000300", "extension_group_id": 14, "label": "Hello", "client_id": 12, "extra_params": null, "type": "phone", "id": 30 } ]

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

метод	ресурс	данные	ответ
GET	/extension_group/14/record/?start_datetime=2016-04-01%2000%3A00%3A03&end_datetime=2016-04-21%2000%3A00%3A00		[ { "to_username": "000300", "source_number": "000306", "result": "answered", "duration": 1, "hangup_time_gmt": "2016-04-12 11:59:31", "dealer_owner_id": 1, "to_domain": "siptest.ringme.ru", "record_file_size": 2304, "from_username": "000306", "start_time_gmt": "2016-04-12 11:59:30", "ext_number_reg": null, "hangup_cause": "NORMAL_CLEARING", "extension_group_owner_id": 14, "init_time_gmt": "2016-04-12 11:59:28.410000", "dest_domain": null, "from_domain": "siptest.ringme.ru", "source_domain": "siptest.ringme.ru", "extension_type": "phone", "record_uuid": "30-45331F7000A611E686F30968F8BBCB45", "from_screen_name": "000306", "extension_name": "000300@siptest.ringme.ru", "flow": "in", "dest_number": null, "extension_id": 30, "did_number": null, "client_owner_id": 12, "did_domain": null }, { "to_username": "000301", "source_number": "000306", "result": "answered", "duration": 1, "hangup_time_gmt": "2016-04-12 11:59:23", "dealer_owner_id": 1, "to_domain": "siptest.ringme.ru", "record_file_size": 2016, "from_username": "000306", "start_time_gmt": "2016-04-12 11:59:22", "ext_number_reg": null, "hangup_cause": "NORMAL_CLEARING", "extension_group_owner_id": 14, "init_time_gmt": "2016-04-12 11:59:21.640000", "dest_domain": null, "from_domain": "siptest.ringme.ru", "source_domain": "siptest.ringme.ru", "extension_type": "phone", "record_uuid": "30-412A038000A611E686700968F8BBCB45", "from_screen_name": "000306", "extension_name": "000301@siptest.ringme.ru", "flow": "in", "dest_number": null, "extension_id": 28, "did_number": null, "client_owner_id": 12, "did_domain": null } ]

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

`POST /client/{client_id}/extension_group/`

Добавить группу добавочных

Параметры URL

Имя	Тип
`client_id`	`string`

Параметры JSON

Имя	Тип	Обязательный
`name`	`string`	`да`

Поля ответа

Имя	Тип
`id`	`integer`
`client_id`	`integer`
`name`	`string`

`GET /client/{client_id}/extension_group/`

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

Параметры URL

Имя	Тип
`client_id`	`string`

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

Имя	Тип
`id`	`array [string]`
`name`	`array [string]`

Поля ответа

Имя	Тип
`id`	`integer`
`client_id`	`integer`
`name`	`string`

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

Обновить группу добавочных

Параметры URL

Имя	Тип
`ext_group_id`	`integer`
`client_id`	`string`

Параметры JSON

Имя	Тип	Обязательный
`name`	`string`	`нет`

Поля ответа

Имя	Тип
`id`	`integer`
`client_id`	`integer`
`name`	`string`

`GET /client/{client_id}/extension_group/{ext_group_id`}

Получить группу добавочных

Параметры URL

Имя	Тип
`ext_group_id`	`integer`
`client_id`	`string`

Поля ответа

Имя	Тип
`id`	`integer`
`client_id`	`integer`
`name`	`string`

`DELETE /client/{client_id}/extension_group/{ext_group_id`}

Удалить группу добавочных

Параметры URL

Имя	Тип
`ext_group_id`	`integer`
`client_id`	`string`

Ресурсы раздела "Группа добавочных"

`GET /extension_group/{ext_group_id}/extension_group/`

Получить группу добавочных

Параметры URL

Имя	Тип
`ext_group_id`	`string`

Поля ответа

Имя	Тип
`id`	`integer`
`client_id`	`integer`
`name`	`string`

Похожие разделы

Browser not supported