Полноценное описание пока не готова. В формате справочинка доступно тут
Ресурс предназначен для
| Table of Contents |
|---|
Описание структур данных
Пример
Ресурсы
Раздел "клиент"
Раздел "группа добавочных"
...
| Warning |
|---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Клиент (/client/) |
Ресурс предназначен для получения информации о клиенте.
| Table of Contents |
|---|
Описание структур данных
Имя | Тип | Описание |
|---|---|---|
|
| Домен |
timezone | string | Временная зона клиента. Например: "Africa/Cairo", "America/New_York", "Asia/Baghdad", "Australia/Sydney", "Europe/Minsk", "Pacific/Tahiti" и т.д., также можно указать посто "UTC" |
|
| Дата создания |
|
| Юридический адрес |
|
| Язык |
|
| Фактический адрес |
|
| Для добавочных номеров |
|
| Префикс домена. Используется для полного набора имени добавочного. Например, при префиксе "12345", добавочный 000*000@domain.zone может быть вызван по номеру "12345*000*000" |
|
| Контактные телефоны |
|
| Идентифиатор клиента |
|
| Префикс клиента |
|
| Дополнительные параметры |
|
| Контактные лица |
|
| Тип клиента J – юридическиое лицо, F – физическое лицо |
|
| Адрес электронной почты |
|
| Имя |
reg_status_log | boolean | true/false: определяет, ведется ли статистика регистраций добавочных номеров. Параметр задается сервис провайдером. |
geo_list | string | Задает список стран, с айпи адресов которых разрешено использование SIP аккаунта. Страны перечисляются в формате ISO 3166 Codes A2, например "RU US BY". Если список не задан, то используется значение, определенное сервис провайдером. Если список имеет значение "*", то все страны разрешены и параметр сервис провайдера игнорируется. |
| dial_rule_id | integer | id правила исходящих вызовов (/dial_rule/) |
| disk_space_notify_email | string | Почтовый адрес, на который будет отправлено письмо при достяжении % disk_space_notify_threshold |
| disk_space_notify_threshold | integer | значение (подразумевается % ), при котором сработает отправка письма на почтовый адрес, указанный в disk_space_notify_email |
| hold_music | integer | id звукового файла (/sound/) |
| sip_network_permission_id | integer | id доверенной сети (/network_permission/) |
Пример
Получим информацию о текущем авторизованном клиенте.
метод | ресурс | данные | ответ |
|---|---|---|---|
| GET | client/@me/client/ | { |
Ресурсы раздела "Клиент"
GET /client/{client_id}/client/
Получить информацию о клиенте
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
reg_status_log | boolean |
PUT /client/{client_id}/client/
Обновить настройки клиента (клиенту доступны не все параметры для обновления)
Параметры URL
Имя | Тип |
|---|---|
|
|
Тело запроса
Имя | Тип |
|---|---|
dial_rule_id |
|
| disk_space_notify_email | string |
| disk_space_notify_threshold | integer |
| geo_list | string |
| hold_music | integer |
| sip_network_permission_id | integer |
| timezone | string |
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
reg_status_log | boolean |
Теги по теме
| Related Labels |
|---|