Клиент
Данный ресурс предназначен для создания клиентов АТС и управления ими.
Описание полей ресурса
Имя | Тип | Описание | Обязательное | Значение по умолчанию |
---|---|---|---|---|
|
| Имя клиента | да | |
|
| Идентификатор дилера клиента. Дилер определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиа-сервера и прочие. | да | |
|
| Идентификатор домена клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. | да | |
|
| Адрес электронной почты клиента | да | |
|
| Префикс клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения. | - | - |
|
| Уникальный идентификатор клиента. Поле только для чтения. | - | - |
|
| Дата создания клиента в формате YYYY-MM-DD HH:MM:SS. Поле только для чтения. | - | - |
|
| Длина номеров добавочных клиента. Может принимать значения 2, 3, или 4. Не может быть изменена после создания клиента. | нет | 3 |
|
| Статус клиента. Может принимать значения active и blocked. При установленном статусе blocked клиент не может принимать и совершать вызовы, регистрироваться, а также пользоваться REST API. | нет | active |
timezone | string | Временная зона клиента | нет | Системная временная зона |
|
| Включить (значение yes) или отключить (значение no) службу presence для клиента. Если служба включена, добавочные клиента могут подписывапться на события presence и dialog. | нет | no |
|
| Идентификатор списка правил маршрутизации исходящих вызовов клиента. При значении 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 |
exclude_codecs | string | Кодеки, которые нужно вырезать при инвайте на добавочный. В клиенте указывается None чтобы ничего не вырезать, либо конкретные - настройка в клиенте будет приоритетной. Если в клиенте не указано ничего - только тогда провериться диллерский exclude_codecs | нет | null |
call_interactive_method | string | Call Interactive метод (GET или POST). При выбранном методе GET параметры запроса, содержащие информацию о вызове, будут переданы в строке запроса, а при методе POST – в теле запроса. | нет | null |
call_interactive_out_call | boolean | Если true - функционал будет активен, в обратном случае параметры call interactive будут проигнорированы | нет | null |
call_interactive_timeout | long | timeout в секундах | нет | null |
call_interactive_url | string | URL, на который системой будет осуществляться запрос | нет | null |
dial_rule_id | long | Идентификатор правила исходящих вызовов | нет | null |
did_as_transfer_caller_id | long | см. описание в Клиент (/client/, /client_info/) | нет | null |
disk_space_notify_email | string | Адрес e-mail, на который будет отправлено письмо при достижении порогового значения дискового пространства (disk_space_notify_threshold) | нет | null |
disk_space_notify_threshold | long | Адрес e-mail, на который будет отправлено письмо при достижении порогового значения дискового пространства (disk_space_notify_threshold) | нет | null |
hold_music | long | Идентификатор звукового файла, проигрываемого при удержании вызова | нет | null |
record_format | string | Формат записи разговоров, по умолчанию mp3 | нет | null |
record_stereo | boolean | true/false: определяет, ведется ли запись разговоров в формате “стерео”, по умолчанию false | нет | null |
reg_status_log | boolean | true/false: определяет, ведется ли статистика регистраций внутренних номеров. Параметр задается сервис-провайдером. | нет | null |
speech_to_text | boolean | Включение\выключение функционала преобразование речи в текст (speech to text) | нет | null |
task_scheduler_asr_fails_minute | long | Максимальное количество неуспешных вызовов в минуту в планировщике звонков. Значение по умолчанию выставляется в main.cfg в параметре asr_fails_minute | нет | null |
task_scheduler_tasks_per_cycle | long | Максимальное количество тасков запускаемых у клиента за один цикл (примерно за 1 сек) | нет | null |
Ресурсы раздела "Администратор"
POST /admin/client/
Добавить нового клиента
Параметры JSON
Поля ответа
GET /admin/client/
Получить список клиентов системы. Возможна фильтрация результатов с помощью полей запроса.
Параметры запроса
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
PUT /admin/client/{client_id
}
Обновить клиента
Параметры URL
Имя | Тип |
---|---|
|
|
Параметры JSON
Поля ответа
GET /admin/client/{client_id
}
Получить клиента по его идентификатору
Параметры URL
Имя | Тип |
---|---|
|
|
Поля ответа
DELETE /admin/client/{client_id
}
Удалить клиента. Если передан параметр запроса delete_dids и он имеет значение true, то did'ы клиента будут удалены из системы. В противном случае, они будут отвязаны от удаляемого клиента.
Параметры URL
Имя | Тип |
---|---|
|
|
Параметры запроса
Имя | Тип | По умолчанию |
---|---|---|
|
| false |