List blacklist

GET /list
List blacklist
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    optional

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

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

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/number_blacklist/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • sort_by

    string

  • black_numbers

    array

    Show child attributes
  • pagesize

    integer

  • pagination

    integer

  • count

    integer

Sample Response

                      
{
    "sort_by": "DEFAULT",
    "pagesize": 10,
    "pagination": 8,
    "count": 100
}
                      
                    

Destroy blacklist entry

POST /destroy
Destroy blacklist entry
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    The blacklist entry id.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/number_blacklist/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation
404
User not found
400
Invalid entry ID supplied

Sample Response

                      
                      
                    

Create blacklist

POST /create
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • black_number

    string

    required

    Extension number in blacklist.
  • description

    string

    required

    Remarks for the blacklisted number.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/number_blacklist/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Created blacklist
application/json
  • id

    integer

    The blacklist entry id.

    format : int64

Sample Response

                      
{}