Клиент(/client/)

Owned by Dmitri Savolainen
Last updated: Aug 28, 2020 by Asia Khalitova (Unlicensed)
1 min read

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Клиент (/client/)

Ресурс предназначен для получения информации о клиенте.

Описание структур данных

Имя

Тип

Описание

domain

string

Домен
timezonestringВременная зона клиента. Например: "Africa/Cairo", "America/New_York", "Asia/Baghdad", "Australia/Sydney", "Europe/Minsk", "Pacific/Tahiti" и т.д., также можно указать посто "UTC"

create_date

string

Дата создания

jur_address

string

Юридический адрес

language

string

Язык

fact_address

string

Фактический адрес

extension_len

string

Для добавочных номеров

domain_prefix

string

Префикс домена. Используется для полного набора имени добавочного. Например, при префиксе "12345", добавочный 000*000@domain.zone может быть вызван по номеру "12345*000*000"

contact_phones

string

Контактные телефоны

id

integer

Идентифиатор клиента

prefix

string

Префикс клиента

extra_params

string

Дополнительные параметры

ambassadors

string

Контактные лица

type

string

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

email

string

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

name

string

Имя
reg_status_logbooleantrue/false: определяет, ведется ли статистика регистраций добавочных номеров. Параметр задается сервис провайдером.
geo_liststringЗадает список стран, с айпи адресов которых разрешено использование SIP аккаунта. Страны перечисляются в формате  ISO 3166 Codes A2, например "RU US BY". Если список не задан, то используется значение, определенное сервис провайдером. Если список имеет значение "*", то все страны разрешены и параметр сервис провайдера игнорируется.
dial_rule_idintegerid правила исходящих вызовов (/dial_rule/)
disk_space_notify_emailstringПочтовый адрес, на который будет отправлено письмо при достяжении % disk_space_notify_threshold
disk_space_notify_thresholdintegerзначение (подразумевается % ), при котором сработает отправка письма на почтовый адрес, указанный в  disk_space_notify_email
hold_musicintegerid звукового файла (/sound/)
sip_network_permission_idintegerid доверенной сети (/network_permission/)

Пример

Получим информацию о текущем авторизованном клиенте.

метод
ресурс
данные
ответ
GET
client/@me/client/


{
"domain": "sip.domain.com",
"create_date": "2015-04-06 13:00:48",
"jur_address": null,
"language": null,
"fact_address": null,
"extension_len": "3",
"contact_phones": null,
"id": 12,
"prefix": "000",
"extra_params": null,
"ambassadors": null,
"domain_prefix": "00001",
"type": "F",
"email": "admin@domain.com",
"name": "Тестовый клиент",
"reg_status_log": true
}

Ресурсы раздела "Клиент"

GET /client/{client_id}/client/

Получить информацию о клиенте

Параметры URL

Имя

Тип

client_id

string

Поля ответа

Имя

Тип

domain

string

create_date

string

jur_address

string

language

string

fact_address

string

extension_len

string

domain_prefix

string

contact_phones

string

id

integer

prefix

string

extra_params

string

ambassadors

string

type

string

email

string

name

string

reg_status_logboolean

PUT /client/{client_id}/client/

Обновить настройки клиента (клиенту доступны не все параметры для обновления)

Параметры URL

Имя

Тип

client_id

string

Тело запроса

Имя

Тип

dial_rule_id

integer

disk_space_notify_emailstring
disk_space_notify_thresholdinteger
geo_liststring
hold_musicinteger
sip_network_permission_idinteger
timezonestring

Поля ответа

Имя

Тип

domain

string

create_date

string

jur_address

string

language

string

fact_address

string

extension_len

string

domain_prefix

string

contact_phones

string

id

integer

prefix

string

extra_params

string

ambassadors

string

type

string

email

string

name

string

reg_status_logboolean

Теги по теме