Данный ресурс предназначен для создания клиентов АТС и управления ими.
Описание полей ресурса
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
|---|---|---|---|---|
|
| Лимит на количество опций одного контекста IVR. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Дата создания клиента в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения. | - | - |
|
| Включить (значение yes) или отключить (значение no) службу presence для клиента. Если служба включена, добавочные клиента могут подписывапться на события presence и dialog. | нет | no |
|
| Лимит на количество одновременных регистраций одного добавочного клиента. Значение 0 означает, что каждая новая регистрация будет отменять предыдущую, при значениях больше нуля при достижении лимита регистраций новые будут отклоняться. | нет | 0 |
|
| Идентификатор списка правил маршрутизации исходящих клиента. При значении null будет использован список маршрутизации дилера. | нет | null |
|
| Строковое поле, где может быть сохранена любая информация о клиенте, например, о подключенных ему услугах. Клиенту поле не доступно. | нет | null |
|
| Лимит на количество списков разрешенных сетей, которые используются для авторизации и регистрации добавочных с типами авторизации network и both. Если имеет значение null, используется глобальный лимит | нет | null |
|
| Лимит на количество добавочных. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Префикс клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | - | - |
|
| Лимит на количество групп добавочных. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Комментарий о клиенте. Может быть использован для сохранения любой информации о клиенте. Клиенту поле не доступно. | нет | null |
|
| Контактные лица клиента, информационное поле. | нет | null |
|
| Включить (значение yes) или отключить (значение no) режим sbc для клиента. Если режим SBC включен, то медиаданные для добавочных клиента будет проходить через тот же адрес, что и SIP-сообщения. Режим SBC может быть использован в случае, когда межсетевой экран клиента разрешает соединение только с одним адресом. Если поле имеет значение null, используется настройка дилера. | нет | null |
|
| Лимит на количество пользователей типа "добавочный". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Уникальный идентификатор клиента. Поле только для чтения. | - | - |
|
| Лимит на количество пользователей типа "группа добавочных". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Длина номеров добавочных клиента. Может принимать значения 2, 3, или 4. Не может быть изменена после создания клиента. | нет | 3 |
|
| Идентификатор дилера клиента. Дилер определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиа-сервера и прочие. | да | |
|
| Лимит на количество загружаемых клиентом звуковых файлов. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество приложений API клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Контактные телефоны клиента, информационное поле. | нет | null |
|
| Идентификатор домена клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | да | |
|
| Лимит на количество одновременных вызовов клиента. При значении null будет использован лимит дилера. | нет | null |
|
| Лимит на количество внешних агентов очередей. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество временных интервалов клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Тип клиента, информационное поле. Значение F означает физическое лицо, значение J – юридическое. | нет | F |
|
| Адрес электронной почты клиента | да | |
|
| Статус клиента. Может принимать значения active и blocked. При установленном статусе blocked клиент не может принимать и совершать вызовы, а также пользоваться REST API. | нет | active |
|
| Лимит на количество правил в одной опции контекста IVR. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Фактический адрес клиента, информационное поле. | нет | null |
|
| Лимит на количество агентов очереди на один добавочных клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество пользователей типа "клиент". Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Дисковая квота в байтах для хранения записей разговора, сообщений голосовой почты и входящий сообщений факса. При исчерпании квоты запись разговоров, сохранение голосовых сообщений и приём факсов вестись не будет. | нет | 0 |
|
| Лимит на количество обработчиков событий на одном добавочном. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество правил набора клиента. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Имя клиента | да | |
|
| Юридический адрес клиента, информационное поле. | нет | null |
|
| Язык клиента. На языке клиента проигрываются звуковые файлы приветствий голосовой почты, перевода, звуки управления конференцией. Если имеет значение null, используется глобальный язык инсталляции АТС. | нет | null |
|
| Использование короткого номера идентификатора звонящего при вызовах между добавочными клиента. Если настройка включена (значение yes), то при вызовах с добавочного клиента на другой добавочных этого же клиента в поле From вместо полного имени добавочного (000*100@sip.ringme.ru) с префиксом клиента будет находится короткое имя добавочного без префикса клиента (100@sip.ringme.ru). | нет | no |
|
| Строковое поля для любой дополнительной информации о клиенте. Клиенту данное поле доступно на чтение. | нет | null |
|
| Лимит на количество правил входящего вызова одного добавочного. Если имеет значение null, используется глобальный лимит. | нет | null |
|
| Лимит на количество контекстов в одном добавочном типа IVR. Если имеет значение null, используется глобальный лимит. | нет | null |
POST /admin/client/
Добавить client
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /admin/client/
Получить client list
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|