Клиент

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

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

Имя

Тип

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

name

string

Имя клиентада

dealer_id

integer

Идентификатор дилера клиента. Дилер определяет общие настройки для всех своих клиентов, такие как правила маршрутизации, различные лимиты, правила набора, предпочитаемые медиа-сервера и прочие.да

domain_id

integer

Идентификатор домена клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента.да

email

string

Адрес электронной почты клиентада

prefix

string

Префикс клиента. Все добавочные клиента имеют номера в формате префикс_клиента*имя_добавочного@домен_клиента. Поле только для чтения.--

id

integer

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

create_date

string

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

extension_len

integer(2,3,4)

Длина номеров добавочных клиента. Может принимать значения 2, 3, или 4. Не может быть изменена после создания клиента.нет3

status

string("active", "blocked")

Статус клиента. Может принимать значения active и blocked. При установленном статусе blocked клиент не может принимать и совершать вызовы, регистрироваться, а также пользоваться REST API.нетactive
timezonestringВременная зона клиентанетСистемная временная зона

presence

string("yes","no")

Включить (значение yes) или отключить (значение no) службу presence для клиента. Если служба включена, добавочные клиента могут подписывапться на события presence и dialog.нетno

routing_list_id

integer

Идентификатор списка правил маршрутизации исходящих вызовов клиента. При значении null будет использован список маршрутизации дилера.нетnull

short_local_caller_id

string("yes","no")

Использование короткого номера идентификатора звонящего при вызовах между добавочными клиента. Если настройка включена (значение yes), то при вызовах с добавочного клиента на другой добавочных этого же клиента в поле From вместо полного имени добавочного (000*100@sip.ringme.ru) с префиксом клиента будет находится короткое имя добавочного без префикса клиента (100@sip.ringme.ru).нетno

language

string("ru","en")

Язык клиента. На языке клиента проигрываются звуковые файлы приветствий голосовой почты, перевода, звуки управления конференцией. Если имеет значение null, используется глобальный язык инсталляции АТС.нетnull

disk_quota

integer

Дисковая квота в байтах для хранения записей разговора, сообщений голосовой почты и входящий сообщений факса. При исчерпании квоты запись разговоров, сохранение голосовых сообщений и приём факсов вестись не будет.нет0

reg_limit

integer

Лимит на количество одновременных регистраций одного добавочного клиента. Значение 0 означает, что каждая новая регистрация будет отменять предыдущую, при значениях больше нуля при достижении лимита регистраций новые будут отклоняться.нет0

calls_limit

integer

Лимит на количество одновременных вызовов клиента. При значении null будет использован лимит дилера.нетnull

extension_limit

integer

Лимит на количество добавочных. Если имеет значение null, используется глобальный лимит.нетnull

extension_group_limit

integer

Лимит на количество групп добавочных. Если имеет значение null, используется глобальный лимит.нетnull

sound_limit

integer

Лимит на количество загружаемых клиентом звуковых файлов. Если имеет значение null, используется глобальный лимит.нетnull

extension_agent_limit

integer

Лимит на количество агентов очереди на один добавочных клиента. Если имеет значение null, используется глобальный лимит.нетnull

remote_agent_limit

integer

Лимит на количество внешних агентов очередей. Если имеет значение null, используется глобальный лимит.нетnull

ivr_rule_limit

integer

Лимит на количество правил в одной опции контекста IVR. Если имеет значение null, используется глобальный лимит.нетnull

ivr_option_limit

integer

Лимит на количество опций одного контекста IVR. Если имеет значение null, используется глобальный лимит.нетnull

ivr_context_limit

integer

Лимит на количество контекстов в одном добавочном типа IVR. Если имеет значение null, используется глобальный лимит.нетnull

incom_rule_limit

integer

Лимит на количество правил входящего вызова одного добавочного. Если имеет значение null, используется глобальный лимит.нетnull

dial_rule_limit

integer

Лимит на количество правил набора клиента. Если имеет значение null, используется глобальный лимит.нетnull

user_extension_limit

integer

Лимит на количество пользователей типа "добавочный". Если имеет значение null, используется глобальный лимит.нетnull

user_extension_group_limit

integer

Лимит на количество пользователей типа "группа добавочных". Если имеет значение null, используется глобальный лимит.нетnull

user_client_limit

integer

Лимит на количество пользователей типа "клиент". Если имеет значение null, используется глобальный лимит.нетnull

interval_limit

integer

Лимит на количество временных интервалов клиента. Если имеет значение null, используется глобальный лимит.нетnull

event_limit

integer

Лимит на количество обработчиков событий на одном добавочном. Если имеет значение null, используется глобальный лимит.нетnull

application_limit

integer

Лимит на количество приложений API клиента. Если имеет значение null, используется глобальный лимит.нетnull

network_permission_limit

integer

Лимит на количество списков разрешенных сетей, которые используются для авторизации и регистрации добавочных с типами авторизации network и both. Если имеет значение null, используется глобальный лимитнетnull

hidden_json

string

Строковое поле, где может быть сохранена любая информация о клиенте, например, о подключенных ему услугах. Клиенту поле не доступно.нетnull

hidden_comment

string

Комментарий о клиенте. Может быть использован для сохранения любой информации о клиенте. Клиенту поле не доступно.нетnull

extra_params

string

Строковое поля для любой дополнительной информации о клиенте. Клиенту данное поле доступно на чтение.нетnull

type

string("J","F")

Тип клиента, информационное поле. Значение F означает физическое лицо, значение J – юридическое.нетF

ambassadors

string

Контактные лица клиента, информационное поле. нетnull

contact_phones

string

Контактные телефоны клиента, информационное поле. нетnull

jur_address

string

Юридический адрес клиента, информационное поле.нетnull

geo_list

string

Задает список стран, с IP-адресов которых разрешено использование SIP-аккаунта. Страны перечисляются в формате  ISO 3166 Codes A2, например: "RU US BY". Если список не задан, то используется значение, определенное сервис-провайдером. Если список имеет значение "*", то все страны разрешены и параметр сервис провайдера игнорируется

нетnull

fact_address

string

Фактический адрес клиента, информационное поле.нет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_codecsstringКодеки, которые нужно вырезать при инвайте на добавочный. В клиенте указывается None чтобы ничего не вырезать, либо конкретные - настройка в клиенте будет приоритетной. Если в клиенте не указано ничего - только тогда провериться диллерский exclude_codecsнет

null

call_interactive_methodstringCall Interactive  метод (GET или POST). При выбранном методе GET параметры запроса, содержащие информацию о вызове, будут переданы в строке запроса, а при методе POST –  в теле запроса. нет

null

call_interactive_out_callbooleanЕсли true - функционал будет активен, в обратном случае параметры call interactive будут проигнорированынет

null

call_interactive_timeoutlongtimeout в секундахнет

null

call_interactive_urlstring URL, на который системой будет осуществляться запроснет

null

dial_rule_idlongИдентификатор правила исходящих вызововнет

null

did_as_transfer_caller_idlongсм. описание в Клиент (/client/, /client_info/)нет

null

disk_space_notify_emailstring

Адрес e-mail, на который будет отправлено письмо при достижении порогового значения дискового пространства (disk_space_notify_threshold)

нет

null

disk_space_notify_thresholdlong

Адрес e-mail, на который будет отправлено письмо при достижении порогового значения дискового пространства (disk_space_notify_threshold)

нет

null

hold_musiclong

Идентификатор звукового файла, проигрываемого при удержании вызова

нет

null

record_formatstringФормат записи разговоров, по умолчанию mp3нет

null

record_stereoboolean

true/false: определяет, ведется ли запись разговоров в формате “стерео”, по умолчанию false

нет

null

reg_status_logboolean

true/false: определяет, ведется ли статистика регистраций внутренних номеров. Параметр задается сервис-провайдером.

нет

null

speech_to_textbooleanВключение\выключение функционала преобразование речи в текст (speech to text)нет

null

task_scheduler_asr_fails_minute
longМаксимальное количество неуспешных вызовов в минуту в планировщике звонков. Значение по умолчанию выставляется в main.cfg в параметре asr_fails_minuteнетnull
task_scheduler_tasks_per_cyclelongМаксимальное количество тасков запускаемых у клиента за один цикл (примерно за 1 сек)нетnull

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

POST /admin/client/

Добавить нового клиента

Параметры JSON

Поля клиента

Поля ответа

Поля клиента

GET /admin/client/

Получить список клиентов системы. Возможна фильтрация результатов с помощью полей запроса.

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

Имя

Тип

extension_len

array [integer]

dealer_id

array [integer]

name

array [string]

domain_id

array [integer]

routing_list_id

array [integer]

id

array [integer]

prefix

array [string]

order_by

string

per_page

integer

type

array [string]

order

string

page

integer

Поля ответа

Поля клиента

PUT /admin/client/{client_id}

Обновить клиента

Параметры URL

Имя

Тип

client_id

integer

Параметры JSON

Поля клиента

Поля ответа

Поля клиента

GET /admin/client/{client_id}

Получить клиента по его идентификатору

Параметры URL

Имя

Тип

client_id

integer

Поля ответа

Поля клиента

DELETE /admin/client/{client_id}

Удалить клиента. Если передан параметр запроса delete_dids и он имеет значение true, то did'ы клиента будут удалены из системы. В противном случае, они будут отвязаны от удаляемого клиента.

Параметры URL

Имя

Тип

client_id

integer

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

Имя

Тип

По умолчанию

delete_dids

boolean

false