Дилер

Данный ресурс предназначен для создания и управления дилерами системы. Каждый клиент АТС принадлежит какому-либо дилеру, который определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиасерверы и прочие.

Описание полей ресурса

Имя

Тип

ОписаниеОбязательноеЗначение по умолчанию

name

string

Имя дилерада

id

integer

Уникальный идентификатор дилера. Поле только для чтения.--

create_date

string

Дата создания дилера в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения.--

client_day_limit

integer

Лимит на количество создаваемых клиентов в сутки. Если значение null, лимит отсутствует. В противном случае, если на момент API-запроса на создание клиента с данным дилером за прошедшие сутки было создано указанное в параметре количество клиентов, API-запрос вернёт ошибку.нетnull

routing_list_id

integer

Идентификатор списка правил маршрутизации исходящих вызовов клиентов дилера. При значении null будет использован список маршрутизации по умолчанию. Может быть переопределен параметром конкретного клиента.нетnull

dispatcher_list_id

integer

Идентификатор списка предпочитаемых медиасерверов клиентов дилера. Если идентификатор задан, то обмен медиаданными клиентов данного сервера будет происходить через медиасерверы из указанного списка при их доступности. При значении null будет использован список медиасерверов по умолчанию. Параметр может быть полезен для того, чтобы направлять медиаданные клиентов дилера через наиболее географически близкие к ним медиасерверы.нетnull

client_calls_limit

integer

Лимит на количество одновременных вызовов клиента. При значении null лимит отсутствует. Может быть переопределен лимитом конкретного клиента.нетnull

dial_rule_limit

integer

Лимит на количество правил набора клиента. Если имеет значение null, используется глобальный лимит.нетnull

type

string

Тип дилера, информационное поле. Значение F означает физическое лицо, значение J – юридическое.нетF

ambassadors

string

Контактные лица дилера, информационное поле.нетnull

contact_phones

string

Контактные телефоны дилера, информационное поле.нетnull

contact_emails

string

Контактные адреса электронной почты дилера, информационное поле.нетnull

jur_address

string

Юридический адрес дилера, информационное поле.нетnull

fact_address

string

Фактический адрес дилера, информационное поле.нетnull

Разрешенные домены дилеры

Каждый дилер может создавать клиентов только в определенных доменах. Список разрешенных доменов дилера настраивается ресурсом "Разрешенные домены дилера", который содержит список идентификаторов доменов, в которых дилер может создавать клиентов.

Описание полей ресурса "Разрешенные домены дилера"

Имя

Тип

ОписаниеОбязательноеЗначение по умолчанию

allowed_domains

array [integer]

Список идентификаторов (id) доменов, в которых дилер может создавать клиентов. Список может быть пустым. Идентификатор (id) домена нельзя удалить из списка, если у дилера уже есть клиенты в этом домене.да

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

POST /admin/dealer/

Добавить дилера

Параметры JSON

Поля дилера

Поля ответа

Поля дилера

GET /admin/dealer/

Получить список дилеров системы

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

Имя

Тип

name

array [string]

id

array [integer]

Поля ответа

Поля дилера


PUT /admin/dealer/{dealer_id}

Обновить дилера

Параметры URL

Имя

Тип

dealer_id

integer

Параметры JSON

Поля дилера

Поля ответа

Поля дилера

GET /admin/dealer/{dealer_id}

Получить дилера по идентификатору

Параметры URL

Имя

Тип

dealer_id

integer

Поля ответа

Поля дилера

DELETE /admin/dealer/{dealer_id}

Удалить дилера

Параметры URL

Имя

Тип

dealer_id

integer


PUT /admin/dealer/{dealer_id}/allowed_domains/

Обновить список разрешенных доменов дилера

Параметры URL

Имя

Тип

dealer_id

integer

Параметры JSON

Поля ресурса "Разрешенные домены дилера"

Поля ответа

Поля ресурса "Разрешенные домены дилера"

GET /admin/dealer/{dealer_id}/allowed_domains/

Получить список разрешенных доменов дилера

Параметры URL

Имя

Тип

dealer_id

integer

Поля ответа

Поля ресурса "Разрешенные домены дилера"