Retrieve the number blacklist

GET /number_blacklist/list

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 does not specify value for this field.

Sample Request

https://example.com/api/number_blacklist/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 does not specify value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • black_numbers

    array

    required

    Collection of blacklisted numbers.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "black_numbers": [
        {
            "black_number": "101",
            "description": "xxxx"
        },
        {
            "black_number": "102",
            "description": "xxxx"
        }
    ]
}

Add an extension number to blacklist

POST /number_blacklist/create
Placeholders

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Extension numbers in blacklist.
  • description

    string

    required

    Remarks for the blacklisted number.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "black_number": "101",
    "description": "xxxx"
}

Response

Placeholders

Sample Response

Remove an extension number from blacklist

POST /number_blacklist/destroy
Placeholders

Request

Placeholders
  • access_token

    string

    required

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

    string

    required

    Extension number to be removed from blacklist.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "black_number": "101"
}

Response

Placeholders

Sample Response