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

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

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

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

1 Описание структур данных
2 Примеры
3 Ресурсы раздела "Клиент"
4 Ресурсы раздела "Группа внутренних номеров"

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

Имя	Тип	Описание

Имя	Тип	Описание
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
}

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

[
  {
    "status": "active",
    "domain": "sip.ringme.ru",
    "create_date": "2020-03-16 12:11:13",
    "name": "000*301",
    "extra_params": "312",
    "label": "Сидоров",
    "caller_id_name": "Сидоров С.С.",
    "client_id": 12,
    "extension_group_id": 14,
    "message_did": "string",
    "dial_rule_limit": null,
    "ani_rfc3325": false,
    "type": "phone",
    "id": 28,
    "did_as_transfer_caller_id": null
  },
  {
  "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
 } 
]

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

[
 {
   "to_username": "000*300",
   "source_number": "000*306",
   "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": "000*306",
   "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": "000*306",
   "extension_name": "000*300@siptest.ringme.ru",
   "flow": "in","dest_number": null,
   "extension_id": 30,
   "did_number": null,
   "client_owner_id": 12,
   "did_domain": null
  },
  {
   "to_username": "000*301",
   "source_number": "000*306",
   "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": "000*306",
   "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": "000*306",
   "extension_name": "000*301@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	нет
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

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

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

Параметры URL

Имя	Тип

Имя	Тип
ext_group_id	integer
client_id	string

Поля ответа

Имя	Тип

Имя	Тип
id	integer
client_id	integer
name	string
extra_params	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
extra_params	string

REST API Документация клиента 2.0

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

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

Примеры

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

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

Related content