This resource is designed to create and manage domains and their aliases.
| Table of Contents | ||||
|---|---|---|---|---|
|
Because the PBX platform is multi-domain, the domain name is a meaningful part of the full extension name. The fully qualified extension name consists of the client prefix, extension number, and domain, and has the following format:
...
Name | Type | Description | Required | Default value |
|---|---|---|---|---|
|
| Domain name. Cannot be changed after the domain has been created. |
| |
|
| Unique domain prefix, must be a string of 5 digits. The domain prefix can be used for client calls from different domains to each other. For such call, dial a number in the format domain_prefix*client_prefix*extension_number |
| |
|
| Comment |
| null |
|
| Unique domain id. Read only. | - | - |
| Anchor | ||||
|---|---|---|---|---|
|
...
Name | Type | Description | Required | Default value |
|---|---|---|---|---|
|
| A domain alias, which can be in the “From” field in place of the domain. Can be a domain IP address. |
| |
|
| Comment |
| null |
|
| Unique domain alias id. Read only. | - | - |
| Anchor | ||||
|---|---|---|---|---|
|
...
Name | Type | Description | Required | Default value |
|---|---|---|---|---|
|
| IP address, requests from which will be considered related to this domain. |
| |
|
| Comment |
| null |
|
| Unique domain Force Source id. Read only. | - | - |
| Anchor | ||||
|---|---|---|---|---|
|
...
Name | Type | Description | Required | Default value |
|---|---|---|---|---|
|
| The IP address in the “From” field that will map the request to this domain. |
| |
|
| Comment |
| null |
|
| Unique domain Force Destination id. Read only. | - | - |
Resources section "Admin"
POST /admin/domain/
Add Create a new domain
JSON params
...
PUT /admin/domain/{domain_id}
Update a domain
URL parameters
Name | Type |
|---|---|
|
|
...
GET /admin/domain/{domain_id}
Получить домен по его идентификаторуGet a domain by its id
URL parameters
Name | Type |
|---|---|
|
|
...
DELETE /admin/domain/{domain_id}
Удалить доменDelete a domain
URL parameters
Name | Type |
|---|---|
|
|
...
POST /admin/domain/{domain_id}/alias/
Добавить псевдоним доменаAdd a domain alias
URL parameters
Name | Type |
|---|---|
|
|
JSON parameters
Поля псевдонима доменаDomain alias fields
Response fields
Поля псевдонима доменаDomain alias fields
GET /admin/domain/{domain_id}/alias/
Получить список псевдонимов доменаGet a list of the domain aliases
URL parameters
Name | Type |
|---|---|
|
|
Response fields
Поля псевдонима доменаDomain alias fields
PUT /admin/domain/{domain_id}/alias/{id}
Обновить псевдоним доменаUpdate a domain alias
URL parameters
Name | Type |
|---|---|
|
|
|
|
JSON parameters
Поля псевдонима доменаDomain alias fields
Response fields
Поля псевдонима доменаDomain alias fields
GET /admin/domain/{domain_id}/alias/{id}
Получить псевдоним домена по его идентификаторуGet a domain alias by its id
URL parameters
Name | Type |
|---|---|
|
|
|
|
Response fields
Поля псевдонима доменаDomain alias fields
DELETE /admin/domain/{domain_id}/alias/{id}
Удалить псевдоним доменаDelete a domain alias
URL parameters
Name | Type |
|---|---|
|
|
|
|
...
POST /admin/domain/{domain_id}/force_src/
Добавить Add a domain force source домена
URL parameters
Name | Type |
|---|---|
|
|
JSON parameters
Поля Domain force source доменаfields
Response fields
Поля Domain force source доменаfields
GET /admin/domain/{domain_id}/force_src/
Получить список force source доменаGet a list of domain force source
URL parameters
Name | Type |
|---|---|
|
|
Response fields
Поля Domain force source доменаfields
...
PUT /admin/domain/{domain_id}/force_src/{id}
Обновить force Update a domain force source домена
URL parameters
Name | Type |
|---|---|
|
|
|
|
JSON parameters
Поля Domain force source доменаfields
Response fields
Поля Domain force source доменаfields
GET /admin/domain/{domain_id}/force_src/{id}
Получить force Get a domain force source домена
URL parameters
Name | Type |
|---|---|
|
|
|
|
Response fields
Поля Domain force source доменаfields
DELETE /admin/domain/{domain_id}/force_src/{id}
Удалить force Delete a domain force source домена
URL parameters
Name | Type |
|---|---|
|
|
|
|
...
POST /admin/domain/{domain_id}/force_dst/
Добавить force desination доменаAdd a domain force destination
URL parameters
Name | Type |
|---|---|
|
|
JSON parameters
Поля Domain force destination доменаfields
Response fields
Поля Domain force destination доменаfields
GET /admin/domain/{domain_id}/force_dst/
Получить список force desination доменаGet a list of domain force destination
URL parameters
Name | Type |
|---|---|
|
|
Response fields
Поля Domain force destination доменаfields
...
PUT /admin/domain/{domain_id}/force_dst/{id}
Обновить force desination доменаUpdate a domain force destination
URL parameters
Name | Type |
|---|---|
|
|
|
|
JSON parameters
Поля Domain force destination доменаfields
Response fields
Поля Domain force destination доменаfields
GET /admin/domain/{domain_id}/force_dst/{id}
Получить force desination доменаGet a domain force destination
URL parameters
Name | Type |
|---|---|
|
|
|
|
Response fields
Поля Domain force destination доменаfields
DELETE /admin/domain/{domain_id}/force_dst/{id}
Удалить force desination доменаDelete a domain force destination
URL parameters
Name | Type |
|---|---|
|
|
|
|