Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Данный ресурс предназначен для создания и управления дилерами системы.

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

Имя

Тип

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

name

string

Имя дилерада

id

integer

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

create_date

string

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

sbc_mode

string("yes","no")

Включить (значение yes) или отключить (значение no) режим sbc для клиентов дилера. Если режим SBC включен, то медиаданные для добавочных клиентов будет проходить через тот же адрес, что и SIP-сообщения. Режим SBC может быть использован в случае, когда межсетевой экран клиента разрешает соединение только с одним адресом. нетno

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

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

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

GET /admin/dealer/

Получить dealer list

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

Имя

Тип

name

array [string]

id

array [integer]

Поля ответа

Имя

Тип

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


PUT /admin/dealer/{dealer_id}

Обновить dealer

Параметры URL

Имя

Тип

dealer_id

integer

Параметры 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

GET /admin/dealer/{dealer_id}

Получить dealer

Параметры URL

Имя

Тип

dealer_id

integer

Поля ответа

Имя

Тип

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

DELETE /admin/dealer/{dealer_id}

Удалить dealer

Параметры URL

Имя

Тип

dealer_id

integer


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

Обновить dealer allowed domains

Параметры URL

Имя

Тип

dealer_id

integer

Параметры JSON

Имя

Тип

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

allowed_domains

array [integer]

да

Поля ответа

Имя

Тип

allowed_domains

array [integer]

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

Получить dealer allowed domains

Параметры URL

Имя

Тип

dealer_id

integer

Поля ответа

Имя

Тип

allowed_domains

array [integer]

  • No labels