Группы доступных АОНов (/caller_id_group/)

Owned by Dmitri Savolainen
Last updated: Mar 13, 2024

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

Ресурс позволяет клиенту дать возможность сотрудникам устанавливать АОН для исходящих вызовов. Для этого из списка внешних номеров клиента можно выбрать необходимые номера и закрепить этот список за добавочным (параметр “caller_id_group_id”). Впоследствии сотрудник может выбирать из этого списка нужный ему АОН (параметр “client_public_caller_id_number“).

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

Имя

Тип

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

Описание

Имя

Тип

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

Описание

did_list

array [integer]
или
array [caller_id_group_values]

нет

Список идентификторов (“id”) внешних номеров
или
Список вида {"did_id": integer, "value": "string”} - идентификаторы внешних номеров со значениями

id

integer

да

Идентификатор группы

name

string

да

Наименование группы (должно быть уникальным)

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

POST /client/{client_id}/caller_id_group/

Добавить группу АОНов

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

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

Имя

Тип

Имя

Тип

did_list

array [integer]

name

string

Параметры ответа

Имя

Тип

Имя

Тип

did_list

array [integer]

id

long

client_id

long

name

string

GET /client/{client_id}/caller_id_group/

Получить список всех групп АОНов

Параметры URL

Имя

Тип

Имя

Тип

client_id

string

Параметры ответа

Имя

Тип

Имя

Тип

did_list

array [integer]

id

long

client_id

long

name

string

PUT /client/{client_id}/caller_id_group/{group_id}

Изменить группу АОНов

Параметры URL

Имя

Тип

Имя

Тип

group_id

integer

client_id

string

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

Имя

Тип

Имя

Тип

did_list

array [integer]

name

string

Параметры ответа

Имя

Тип

Имя

Тип

did_list

array [integer]

id

long

client_id

long

name

string

GET /client/{client_id}/caller_id_group/{group_id}

Запросить параметры группы АОНов по id

Параметры URL

Имя

Тип

Имя

Тип

group_id

integer

client_id

string

Параметры ответа

Имя

Тип

Имя

Тип

did_list

array [integer]

id

long

client_id

long

name

string

DELETE /client/{client_id}/caller_id_group/{group_id}

Удалить группу АОНов

Параметры URL

Имя

Тип

Имя

Тип

group_id

integer

client_id

string

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