...
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
|---|---|---|---|---|
|
| Имя клиента | да | |
|
| Идентификатор дилера клиента. Дилер определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиа-сервера и прочие. | да | |
|
| Идентификатор домена клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. | да | |
|
| Адрес электронной почты клиента | да | |
|
| Префикс клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | - | - |
|
| Уникальный идентификатор клиента. Поле только для чтения. | - | - |
|
| Дата создания клиента в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения. | - | - |
|
| Длина номеров добавочных клиента. Может принимать значения 2, 3, или 4. Не может быть изменена после создания клиента. | нет | 3 |
|
| Статус клиента. Может принимать значения active и blocked. При установленном статусе blocked клиент не может принимать и совершать вызовы, регистрироваться, а также пользоваться REST API. | нет | active |
timezone | string | Временная зона клиента | нет | Системная временная зона |
|
| Включить (значение 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 |
geo_list | string | Задает список стран, с IP-адресов которых разрешено использование SIP-аккаунта. Страны перечисляются в формате ISO 3166 Codes A2, например: "RU US BY". Если список не задан, то используется значение, определенное сервис-провайдером. Если список имеет значение "*", то все страны разрешены и параметр сервис провайдера игнорируется | нет | null |
|
| Фактический адрес клиента, информационное поле. | нет | null |
blind_transfer_return | boolean | Используется для исключения потери вызова при “слепом переводе”. Работает только для звонков внутри одной АТС. Все “слепые переводы” внутри атс между телефонного терминал при установке значения данного параметра в true и в случае неуспеха будут возвращены обратно. Тем не менее, для лучшего пользовательского опыта рекомендуется использовать “перевод с сопровождением” вместо слепого перевода. В случае отсутсвия указанного параметра bl_xfer_return_timeout вызов вернется по таймауту (hangup_timeout) телефонного терминала, на который был совершен “слепой перевод”. | нет | null |
bl_xfer_return_timeout | long | Только в случае указания blind_transfer_return в true будет проанализирован данный таймаут, в обратном случае этот параметр игнорируется. В случае blind_transfer_return в true и указания bl_xfer_return_timeout в секундах - при слепом переводе на телефонный терминал его таймаут (hangup_timeout) будет проигноирован, вместо него будет использоваться значение bl_xfer_return_timeout | нет | null |
outg_call_VR_on_fail | boolean | Используется для голосового уведомления результата вызова при исходящем звонке. В случае отсутсвия заданных кодов в outg_call_VR_code_list ничего проиграно не будет. | нет | null |
outg_call_VR_code_list | string | Данный список будет использован только при outg_call_VR_on_fail в true, список должен содержать интерпретации ошибки (Enumiration) , перечисленные через запятую. Пример указания списка: “USER_BUSY,NO_USER_RESPONSE,NO_ANSWER” | нет | null |
...
Добавить нового клиента
Параметры JSON
Поля ответа
GET /admin/client/
Получить список клиентов системы. Возможна фильтрация результатов с помощью полей запроса.
...
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
PUT /admin/client/{client_id}
...
Имя | Тип |
|---|---|
|
|
Параметры JSON
Поля ответа
GET /admin/client/{client_id}
...
Имя | Тип |
|---|---|
|
|
Поля ответа
DELETE /admin/client/{client_id}
...