Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Table of Contents
maxLevel3

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

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

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

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

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

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

...

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

Anchor
domain_fields
domain_fields

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

Имя

Тип

Описание

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

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

name

string

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

да


domain_prefix

string

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

да


comment

string

Комментарий

нет

null
id

integer

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

-

-

Anchor
domain_alias_fields
domain_alias_fields

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

Имя

Тип

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

name

string

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

comment

string

Комментарий

нет

null

id

integer

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

-

-

Anchor
force_source_fields
force_source_fields

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

...

Force

...

Source домена

string
ИмяТип

comment

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

ip

string

id

integer

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

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

comment

stringip

Комментарий

нет

null

id

integer

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

POST /admin/domain/

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

...

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

-

-

Anchor
force_dst_fields
force_dst_fields

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

ИмяТип

Обязательный

comment

string

нет

domain_prefix

string

да

name

string

да

Поля ответа

string

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

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

ip

string

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

comment

string

Комментарий

нет

null

id

integer

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

-

-

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

POST /admin/domain/

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

Параметры JSON

Поля домена

Поля ответа

Поля домена

GET /admin/domain/

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

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

Имя

Тип

comment

array [string]

domain_prefix

array [string]

id

array [integer]

name

array [string]

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

Поля домена

...

PUT /admin/domain/{domain_id}

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

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

Поля домена

Поля ответа

Поля домена

GET /admin/domain/{domain_id}

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

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

Поля домена

DELETE /admin/domain/{domain_id}

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

Параметры URL

Имя

Тип

domain_id

integer

...

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

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

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

...

Имя

...

Тип

...

Обязательный

...

comment

...

string

...

нет

...

name

...

string

...

да

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

Поля ответа

...

Имя

...

Тип

...

comment

...

string

...

id

...

integer

...

name

...

string

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

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

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

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

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


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

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

...

Имя

...

Тип

...

Обязательный

...

comment

...

string

...

нет

...

name

...

string

...

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

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

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

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

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

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

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

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

...

POST /admin/domain/{domain_id}/force_

...

src/

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

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

ip

string

да

Поля ответа

...

Имя

...

Тип

...

comment

...

string

...

ip

...

string

...

id

...

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

Поля ответа

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

GET /admin/domain/{domain_id}/force_

...

src/

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

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

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

...

PUT /admin/domain/{domain_id}/force_

...

src/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

...

Имя

...

Тип

...

comment

...

string

...

ip

...

string

...

id

...

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

Поля ответа

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

GET /admin/domain/{domain_id}/force_

...

src/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

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

DELETE /admin/domain/{domain_id}/force_

...

src/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

...

POST /admin/domain/{domain_id}/force_

...

dst/

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

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

...

Имя

...

Тип

...

Обязательный

...

comment

...

string

...

нет

...

ip

...

string

...

да

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

Поля ответа

...

Имя

...

Тип

...

comment

...

string

...

ip

...

string

...

id

...

integer

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

GET /admin/domain/{domain_id}/force_

...

dst/

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

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

...

Имя

...

Тип

...

comment

...

string

...

ip

...

string

...

id

...

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

...

PUT /admin/domain/{domain_id}/force_

...

dst/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

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

Поля ответа

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

GET /admin/domain/{domain_id}/force_

...

dst/{id}

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

Параметры URL

Имя

Тип

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

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

DELETE /admin/domain/{domain_id}/force_

...

dst/{id}

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

Параметры URL

Имя

Тип

domain_id

integer

id

integer

...