List emergency numbers

GET /e164/emergency_numbers/list
List emergency numbers

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.

Sample Request

https://example.com/api/e164/emergency_numbers/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user has not specified value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • emergency_numbers

    array

    required

    Placeholder
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "emergency_numbers": [
        {
            "number_prefix": 64,
            "description": 64
        },
        {
            "number_prefix": 128,
            "description": 128
        }
    ]
}

Create new emergency numbers

POST /e164/emergency_numbers/create
Create new emergency numbers

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • number_prefix

    string

    required

    Placeholder
  • description

    string

    required

    Placeholder

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "number_prefix": 64,
    "description": 64
}

Response

Placeholders

Sample Response

Delete emergency numbers

POST /e164/emergency_numbers/destroy
Delete emergency numbers

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • number_prefix

    string

    required

    Placeholder

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "number_prefix": 64
}

Response

Placeholders

Sample Response

Retrieve numbers processing for PortSIP PBX

GET /e164/numbers_processing/show
Retrieves the numbers processing of PortSIP PBX.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/e164/numbers_processing/show?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholder
  • international_code

    string

    required

    Placeholder
  • enable_remove_particular_character

    boolean

    required

    Placeholder
  • enable_process_e164

    boolean

    required

    Placeholder
  • enable_remove_if_same_country

    boolean

    required

    Placeholder
  • country

    string

    required

    Placeholder
  • enable_remove_if_same_area_code

    boolean

    required

    Placeholder
  • area_code

    string

    required

    Placeholder
  • national_code

    string

    required

    Placeholder
  • prefix

    string

    required

    Placeholder

Sample Response

{
    "international_code": "00",
    "enable_remove_particular_character": true,
    "enable_process_e164": true,
    "enable_remove_if_same_country": true,
    "country": "+86",
    "enable_remove_if_same_area_code": true,
    "area_code": "11",
    "prefix": "00",
    "national_code": "123"
}

Update numbers processing for PortSIP PBX

POST /e164/numbers_processing/update
Modify the global numbers processing of PortSIP PBX.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • international_code

    string

    required

    Placeholder
  • enable_remove_particular_character

    boolean

    required

    Placeholder
  • enable_process_e164

    boolean

    required

    Placeholder
  • enable_remove_if_same_country

    boolean

    required

    Placeholder
  • country

    string

    required

    Placeholder
  • enable_remove_if_same_area_code

    boolean

    required

    Placeholder
  • area_code

    string

    required

    Placeholder
  • national_code

    string

    required

    Placeholder
  • prefix

    string

    required

    Placeholder

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "international_code": "00",
    "enable_remove_particular_character": true,
    "enable_process_e164": true,
    "enable_remove_if_same_country": true,
    "country": "+86",
    "enable_remove_if_same_area_code": true,
    "area_code": "11",
    "prefix": "00",
    "national_code": "123"
}

Response

Placeholders

Sample Response