Данный ресурс предназначен для создания и управления дилерами системы. Каждый клиент АТС принадлежит какому-либо дилеру, который определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиасерверы и прочие.
| Table of Contents | ||
|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
Описание полей ресурса
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
|---|---|---|---|---|
|
| Имя дилера | да | |
|
| Уникальный идентификатор дилера. Поле только для чтения. | - | - |
|
| Дата создания дилера в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения. | - | - |
|
| Включить (значение yes) или отключить (значение no) режим sbc для клиентов дилера. Если режим SBC включен, то медиаданные для добавочных клиентов будет проходить через тот же адрес, что и SIP-сообщения. Режим SBC может быть использован в случае, когда межсетевой экран клиента разрешает соединение только с одним адресом. | нет | no |
|
| Лимит на количество создаваемых клиентов в сутки. Если значение null, лимит отсутствует. В противном случае, если на момент API-запроса на создание клиента с данным дилером за прошедшие сутки было создано указанное в параметре количество клиентов, API-запрос вернёт ошибку. | нет | null |
|
| Идентификатор списка правил маршрутизации исходящих вызовов клиентов дилера. При значении null будет использован список маршрутизации по умолчанию. Может быть переопределен параметром конкретного клиента. | нет | null |
|
| Идентификатор списка предпочитаемых медиасерверов клиентов дилера. Если идентификатор задан, то обмен медиаданными клиентов данного сервера будет происходить через медиасерверы из указанного списка при их доступности. При значении null будет использован список медиасерверов по умолчанию. Параметр может быть полезен для того, чтобы направлять медиаданные клиентов дилера через наиболее географически близкие к ним медиасерверы. | нет | null |
|
| Лимит на количество одновременных вызовов клиента. При значении null лимит отсутствует. Может быть переопределен лимитом конкретного клиента. | нет | null |
|
| Лимит на количество правил набора клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Тип дилера, информационное поле. Значение F означает физическое лицо, значение J – юридическое. | нет | F |
|
| Контактные лица дилера, информационное поле. | нет | null |
|
| Контактные телефоны дилера, информационное поле. | нет | null |
|
| Контактные адреса электронной почты дилера, информационное поле. | нет | null |
|
| Юридический адрес дилера, информационное поле. | нет | null |
|
| Фактический адрес дилера, информационное поле. | нет | null |
Ресурсы раздела "Администратор"
POST /admin/dealer/
Добавить dealer
Параметры JSON
...
Имя
...
Тип
...
Обязательный
...
dial_rule_limit
...
integer
...
нет
...
jur_address
...
string
...
нет
...
fact_address
...
string
...
нет
...
client_calls_limit
...
integer
...
нет
...
routing_list_id
...
integer
...
нет
...
contact_phones
...
string
...
нет
...
dispatcher_list_id
...
integer
...
нет
...
client_day_limit
...
integer
...
нет
...
contact_emails
...
string
...
нет
...
ambassadors
...
string
...
нет
...
sbc_mode
...
string
...
нет
...
type
...
string
...
нет
...
name
...
string
...
да
Поля ответа
Имя
Тип
create_date
string
jur_address
string
fact_address
string
client_calls_limit
integer
routing_list_id
integer
contact_phones
string
dispatcher_list_id
integer
client_day_limit
integer
contact_emails
string
dial_rule_limit
integer
ambassadors
string
sbc_mode
string
type
string
id
integer
name
string
Разрешенные домены дилеры
Каждый дилер может создавать клиентов только в определенных доменах. Список разрешенных доменов дилера настраивается ресурсом "Разрешенные домены дилера", который содержит список идентификаторов доменов, в которых дилер может создавать клиентов.
| Anchor | ||||
|---|---|---|---|---|
|
Описание полей ресурса "Разрешенные домены дилера"
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
|---|---|---|---|---|
|
| Список идентификаторов (id) доменов, в которых дилер может создавать клиентов. Список может быть пустым. Идентификатор (id) домена нельзя удалить из списка, если у дилера уже есть клиенты в этом домене. | да |
Ресурсы раздела "Администратор"
POST /admin/dealer/
Добавить дилера
Параметры JSON
Поля ответа
GET /admin/dealer/
Получить dealer listсписок дилеров системы
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
...
PUT /admin/dealer/{dealer_id}
Обновить dealerдилера
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
...
Имя
...
Тип
...
create_date
...
string
...
jur_address
...
string
...
fact_address
...
string
...
client_calls_limit
...
integer
...
routing_list_id
...
integer
...
contact_phones
...
string
...
dispatcher_list_id
...
integer
...
client_day_limit
...
integer
...
contact_emails
...
string
...
dial_rule_limit
...
integer
...
ambassadors
...
string
...
sbc_mode
...
string
...
type
...
string
...
id
...
integer
...
name
...
Поля ответа
GET /admin/dealer/{dealer_id}
Получить dealerдилера по идентификатору
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
...
Имя
...
Тип
...
create_date
...
string
...
jur_address
...
string
...
fact_address
...
string
...
client_calls_limit
...
integer
...
routing_list_id
...
integer
...
contact_phones
...
string
...
dispatcher_list_id
...
integer
...
client_day_limit
...
integer
...
contact_emails
...
string
...
dial_rule_limit
...
integer
...
ambassadors
...
string
...
sbc_mode
...
string
...
type
...
string
...
id
...
integer
...
name
...
DELETE /admin/dealer/{dealer_id}
Удалить dealerдилера
Параметры URL
Имя | Тип |
|---|---|
|
|
...
PUT /admin/dealer/{dealer_id}/allowed_domains/
Обновить dealer allowed domainsсписок разрешенных доменов дилера
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
...
Имя
...
Тип
...
Обязательный
...
allowed_domains
...
array [integer]
...
да
Поля ответа
...
Имя
...
Тип
...
allowed_domains
...
Поля ресурса "Разрешенные домены дилера"
Поля ответа
Поля ресурса "Разрешенные домены дилера"
GET /admin/dealer/{dealer_id}/allowed_domains/
Получить dealer allowed domainsсписок разрешенных доменов дилера
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
...
Имя
...
Тип
...
allowed_domains
...