...
| Table of Contents |
|---|
Описание полей ресурса
| Anchor | ||||
|---|---|---|---|---|
|
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
|---|---|---|---|---|
|
| Имя клиента | да | |
|
| Идентификатор дилера клиента. Дилер определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиа-сервера и прочие. | да | |
|
| Идентификатор домена клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | да | |
|
| Адрес электронной почты клиента | да | |
|
| Префикс клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | - | - |
|
| Уникальный идентификатор клиента. Поле только для чтения. | - | - |
|
| Дата создания клиента в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения. | - | - |
|
| Длина номеров добавочных клиента. Может принимать значения 2, 3, или 4. Не может быть изменена после создания клиента. | нет | 3 |
|
| Статус клиента. Может принимать значения active и blocked. При установленном статусе blocked клиент не может принимать и совершать вызовы, а также пользоваться REST API. | нет | active |
|
| Включить (значение yes) или отключить (значение no) службу presence для клиента. Если служба включена, добавочные клиента могут подписывапться на события presence и dialog. | нет | no |
|
| Включить (значение yes) или отключить (значение no) режим sbc для клиента. Если режим SBC включен, то медиаданные для добавочных клиента будет проходить через тот же адрес, что и SIP-сообщения. Режим SBC может быть использован в случае, когда межсетевой экран клиента разрешает соединение только с одним адресом. Если поле имеет значение null, используется настройка дилера. | нет | null |
|
| Идентификатор списка правил маршрутизации исходящих клиента. При значении null будет использован список маршрутизации дилера. | нет | null |
|
| Использование короткого номера идентификатора звонящего при вызовах между добавочными клиента. Если настройка включена (значение yes), то при вызовах с добавочного клиента на другой добавочных этого же клиента в поле From вместо полного имени добавочного (000*100@sip.ringme.ru) с префиксом клиента будет находится короткое имя добавочного без префикса клиента (100@sip.ringme.ru). | нет | no |
|
| Язык клиента. На языке клиента проигрываются звуковые файлы приветствий голосовой почты, перевода, звуки управления конференцией. Если имеет значение null, используется глобальный язык инсталляции АТС. | нет | null |
|
| Дисковая квота в байтах для хранения записей разговора, сообщений голосовой почты и входящий сообщений факса. При исчерпании квоты запись разговоров, сохранение голосовых сообщений и приём факсов вестись не будет. | нет | 0 |
|
| Лимит на количество одновременных регистраций одного добавочного клиента. Значение 0 означает, что каждая новая регистрация будет отменять предыдущую, при значениях больше нуля при достижении лимита регистраций новые будут отклоняться. | нет | 0 |
|
| Лимит на количество одновременных вызовов клиента. При значении null будет использован лимит дилера. | нет | null |
|
| Лимит на количество добавочных. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество групп добавочных. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество загружаемых клиентом звуковых файлов.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество агентов очереди на один добавочных клиента.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество внешних агентов очередей.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество правил в одной опции контекста IVR.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество опций одного контекста IVR. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество контекстов в одном добавочном типа IVR. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество правил входящего вызова одного добавочного. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество правил набора клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество пользователей типа "добавочный". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество пользователей типа "группа добавочных". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество пользователей типа "клиент". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество временных интервалов клиента.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество обработчиков событий на одном добавочном. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество приложений API клиента.Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество списков разрешенных сетей, которые используются для авторизации и регистрации добавочных с типами авторизации network и both. Если имеет значение null, используется глобальный лимит | нет | null |
|
| Строковое поле, где может быть сохранена любая информация о клиенте, например, о подключенных ему услугах. Клиенту поле не доступно. | нет | null |
|
| Комментарий о клиенте. Может быть использован для сохранения любой информации о клиенте. Клиенту поле не доступно. | нет | null |
|
| Строковое поля для любой дополнительной информации о клиенте. Клиенту данное поле доступно на чтение. | нет | null |
|
| Тип клиента, информационное поле. Значение F означает физическое лицо, значение J – юридическое. | нет | F |
|
| Контактные лица клиента, информационное поле. | нет | null |
|
| Контактные телефоны клиента, информационное поле. | нет | null |
|
| Юридический адрес клиента, информационное поле. | нет | null |
|
| Фактический адрес клиента, информационное поле. | нет | null |
Ресурсы раздела "Администратор"
POST /admin/client/
Добавить client
Параметры JSON
...
Имя
...
Тип
...
Обязательный
...
application_limit
...
integer
...
нет
...
sbc_mode
...
string
...
нет
...
presence
...
string
...
нет
...
reg_limit
...
integer
...
нет
...
routing_list_id
...
integer
...
нет
...
hidden_json
...
string
...
нет
...
network_permission_limit
...
integer
...
нет
...
extension_limit
...
integer
...
нет
...
extension_group_limit
...
integer
...
нет
...
hidden_comment
...
string
...
нет
...
ambassadors
...
string
...
нет
...
domain_id
...
integer
...
да
...
user_extension_group_limit
...
integer
...
нет
...
extension_len
...
integer
...
нет
...
dealer_id
...
integer
...
да
...
sound_limit
...
integer
...
нет
...
forced_prefix
...
string
...
нет
...
contact_phones
...
string
...
нет
...
user_extension_limit
...
integer
...
нет
...
calls_limit
...
integer
...
нет
...
remote_agent_limit
...
integer
...
нет
...
interval_limit
...
integer
...
нет
...
ivr_option_limit
...
integer
...
нет
...
type
...
string
...
нет
...
email
...
string
...
да
...
status
...
string
...
нет
...
ivr_rule_limit
...
integer
...
нет
...
fact_address
...
string
...
нет
...
extension_agent_limit
...
integer
...
нет
...
user_client_limit
...
integer
...
нет
...
disk_quota
...
integer
...
нет
...
event_limit
...
integer
...
нет
...
dial_rule_limit
...
integer
...
нет
...
name
...
string
...
да
...
jur_address
...
string
...
нет
...
language
...
string
...
нет
...
short_local_caller_id
...
string
...
нет
...
extra_params
...
string
...
нет
...
incom_rule_limit
...
integer
...
нет
...
ivr_context_limit
...
integer
...
нет
Поля ответа
...
Имя
...
Тип
...
ivr_option_limit
...
integer
...
create_date
...
string
...
presence
...
string
...
reg_limit
...
integer
...
routing_list_id
...
integer
...
hidden_json
...
string
...
network_permission_limit
...
integer
...
extension_limit
...
integer
...
prefix
...
string
...
extension_group_limit
...
integer
...
hidden_comment
...
string
...
ambassadors
...
string
...
sbc_mode
...
string
...
user_extension_limit
...
integer
...
id
...
integer
...
user_extension_group_limit
...
integer
...
extension_len
...
integer
...
dealer_id
...
integer
...
sound_limit
...
integer
...
application_limit
...
integer
...
contact_phones
...
string
...
domain_id
...
integer
...
calls_limit
...
integer
...
remote_agent_limit
...
integer
...
interval_limit
...
integer
...
type
...
string
...
email
...
string
...
status
...
string
...
ivr_rule_limit
...
integer
...
fact_address
...
string
...
extension_agent_limit
...
integer
...
user_client_limit
...
integer
...
disk_quota
...
integer
...
event_limit
...
integer
...
dial_rule_limit
...
integer
...
name
...
string
...
jur_address
...
string
...
language
...
string
...
short_local_caller_id
...
string
...
extra_params
...
string
...
incom_rule_limit
...
integer
...
ivr_context_limit
...
integer
нового клиента
Параметры JSON
Поля ответа
GET /admin/client/
Получить client listсписок клиентов системы
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
...
Имя
...
Тип
...
ivr_option_limit
...
integer
...
create_date
...
string
...
presence
...
string
...
reg_limit
...
integer
...
routing_list_id
...
integer
...
hidden_json
...
string
...
network_permission_limit
...
integer
...
extension_limit
...
integer
...
prefix
...
string
...
extension_group_limit
...
integer
...
hidden_comment
...
string
...
ambassadors
...
string
...
sbc_mode
...
string
...
user_extension_limit
...
integer
...
id
...
integer
...
user_extension_group_limit
...
integer
...
extension_len
...
integer
...
dealer_id
...
integer
...
sound_limit
...
integer
...
application_limit
...
integer
...
contact_phones
...
string
...
domain_id
...
integer
...
calls_limit
...
integer
...
remote_agent_limit
...
integer
...
interval_limit
...
integer
...
type
...
string
...
email
...
string
...
status
...
string
...
ivr_rule_limit
...
integer
...
fact_address
...
string
...
extension_agent_limit
...
integer
...
user_client_limit
...
integer
...
disk_quota
...
integer
...
event_limit
...
integer
...
dial_rule_limit
...
integer
...
name
...
string
...
jur_address
...
string
...
language
...
string
...
short_local_caller_id
...
string
...
extra_params
...
string
...
incom_rule_limit
...
integer
...
ivr_context_limit
...
Поля клиента