Домен

Данный ресурс предназначен для создания и управления доменами и их псевдонимами.

Поскольку платформа АТС является многодоменной, доменное имя является значимой частью полного имени добавочного. Полное имя добавочного состоит из префикса клиента, номера добавочного и домена и имеет следующий формат:

префикс_клиента*номер_добавочного@домен

Например, 001*100@sip.ringme.ru

Таким образом, при авторизации SIP-сообщения от добавочных, осуществляется, в том числе, и проверка доменного имени из SIP-поля From. Поскольку некоторые устройства посылают IP-адрес домена вместо доменного имени, существует возможность настроить псевдонимы домена. Дополнительно существуют инструменты для соотнесения запроса с нужным доменом исходя из IP-адреса источника запроса, независимо от того, что стоит в доменной части поля From, а также инструменты для соотнесения запроса с нужным доменом исходя из фактического содержимого доменной части присланного поля From. Порядок авторизации SIP-сообщений от добавочных описан ниже.

Порядок авторизации SIP-сообщений от добавочных

  1. Производится поиск добавочного по информации из поля From, домен из поля From соотносится c доменами системы.
  2. Если домен не был найден в предыдущем шаге, IP-адрес из поля From соотносится c псевдонимами доменов системы. Если совпадение найдено, то вычисляется фактический домен добавочного
  3. Если домен не был найден в предыдущем шаге, то IP-адрес источника запроса соотноситcя с Force Source доменов системы. Если совпадение найдено, то вычисляется фактический домен добавочного.
  4. Если домен не был найден в предыдущем шаге, то содержимое доменной части поля From соотноситcя с Force Destinations доменов системы. Если совпадение найдено, то вычисляется фактический домен добавочного.
  5. Производится авторизация запроса в соответствии с настройками добавочного.

Описание полей ресурса Домен (Domain)

Имя

Тип

Описание

Обязательное

Значение по умолчанию

name

string

Доменное имя. Не может быть изменено после создания домена.

да


domain_prefix

string

Уникальный префикс домена, должен представлять из себя стороку из 5 цифр. Префикс домена может быть использован для звонков клиентов разных доменов между собой. Для такого вызова необходимо набирать номер в формате префикс_домена*префикс_клиента*номер_добавочного

да


comment

string

Комментарий

нет

null
id

integer

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

-

-

Описание полей ресурса Псевдоним домена (Domain Alias)

Имя

Тип

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

name

string

Псевдоним домена, который может быть в поле From на месте домена. Может быть IP-адресом домена.да

comment

string

Комментарий

нет

null

id

integer

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

-

-

Описание полей ресурса Force Source домена

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

ip

string

IP-адрес, запросы с которого будут считаться относящимися к данному домену.да

comment

string

Комментарий

нет

null

id

integer

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

-

-

Описание полей ресурса Force Destination домена

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

ip

string

IP-адрес в поле From, который будет соотносить запрос с данным доменом.да

comment

string

Комментарий

нет

null

id

integer

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

-

-

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

POST /admin/domain/

Добавить домен

Параметры JSON

Поля домена

Поля ответа

Поля домена

GET /admin/domain/

Получить список доменов

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

Имя

Тип

comment

array [string]

domain_prefix

array [string]

id

array [integer]

name

array [string]

Поля ответа

Поля домена


PUT /admin/domain/{domain_id}

Обновить домен

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Поля домена

Поля ответа

Поля домена

GET /admin/domain/{domain_id}

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

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Поля домена

DELETE /admin/domain/{domain_id}

Удалить домен

Параметры URL

Имя

Тип

domain_id

integer


POST /admin/domain/{domain_id}/alias/

Добавить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Поля псевдонима домена

Поля ответа

Поля псевдонима домена

GET /admin/domain/{domain_id}/alias/

Получить список псевдонимов домена

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Поля псевдонима домена


PUT /admin/domain/{domain_id}/alias/{id
}

Обновить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Поля псевдонима домена

Поля ответа

Поля псевдонима домена

GET /admin/domain/{domain_id}/alias/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Поля псевдонима домена

DELETE /admin/domain/{domain_id}/alias/{id}

Удалить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer


POST /admin/domain/{domain_id}/force_src/

Добавить force source домена

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Поля force source домена

Поля ответа

Поля force source домена

GET /admin/domain/{domain_id}/force_src/

Получить список force source домена

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Поля force source домена


PUT /admin/domain/{domain_id}/force_src/{id}

Обновить force source домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Поля force source домена

Поля ответа

Поля force source домена

GET /admin/domain/{domain_id}/force_src/{id}

Получить force source домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Поля force source домена

DELETE /admin/domain/{domain_id}/force_src/{id}

Удалить force source домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer


POST /admin/domain/{domain_id}/force_dst/

Добавить force desination домена

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Поля force destination домена

Поля ответа

Поля force destination домена

GET /admin/domain/{domain_id}/force_dst/

Получить список force desination домена

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Поля force destination домена


PUT /admin/domain/{domain_id}/force_dst/{id}

Обновить force desination домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Поля force destination домена

Поля ответа

Поля force destination домена

GET /admin/domain/{domain_id}/force_dst/{id}

Получить force desination домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Поля force destination домена

DELETE /admin/domain/{domain_id}/force_dst/{id}

Удалить force desination домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer