Versions Compared

Key

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

This resource is designed to create and manage domains and their aliases.

Table of Contents
minLevel1
maxLevel3

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

name

string

Domain name. Cannot be changed after the domain has been created.

trueYes

domain_prefix

string

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

trueYes

comment

string

Comment

falseNo

null

id

integer

Unique domain id. Read only.

-

-

Anchor
domain_alias_fields
domain_alias_fields

...

Name

Type

Description

Required

Default value

name

string

A domain alias, which can be in the “From” field in place of the domain. Can be a domain IP address.

trueYes

comment

string

Comment

falseNo

null

id

integer

Unique domain alias id. Read only.

-

-

Anchor
force_source_fields
force_source_fields

...

Name

Type

Description

Required

Default value

ip

string

IP address, requests from which will be considered related to this domain.

trueYes

comment

string

Comment

falseNo

null

id

integer

Unique domain Force Source id. Read only.

-

-

Anchor
force_dst_fields
force_dst_fields

...

Name

Type

Description

Required

Default value

ip

string

The IP address in the “From” field that will map the request to this domain.

trueYes

comment

string

Comment

falseNo

null

id

integer

Unique domain Force Destination id. Read only.

-

-

Resources section "Admin"

POST /admin/domain/

Add Create a new domain

JSON params

Domain fields

...

PUT /admin/domain/{domain_id}

Update a domain

URL parameters

Name

Type

domain_id

integer

...

GET /admin/domain/{domain_id}

Get a domain by its id

URL parameters

...

DELETE /admin/domain/{domain_id}

Delete a domain

URL parameters

Name

Type

domain_id

integer

...

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

Add a domain alias

URL parameters

...

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

Get a list of the domain aliases

URL parameters

...


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

Update a domain alias

URL parameters

...

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

Get a domain alias by its id

URL parameters

...

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

Delete a domain alias

URL parameters

...

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

Add a domain force source

URL parameters

...

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

Get a list of domain force source

...

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

Update a domain force source

URL parameters

...

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

Get a domain force source

URL parameters

...

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

Delete a domain force source

URL parameters

...

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

Add a domain force destination

URL parameters

...

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

Update a domain force destination

URL parameters

...

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

Get a domain force destination

URL parameters

...

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

Delete a domain force destination

URL parameters

...