Blacklisted numbers

List blacklisted numbers

get

Authorizations

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/blacklisted_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "number": "text",
      "expire_at": "2017-07-21T17:32:28Z",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:32:28Z",
      "description": "text"
    }
  ]
}

Create new blacklisted number

post

Authorizations

Body

numberstring · min: 1 · max: 64Required

An alphanumeric sequence beginning with an optional plus sign.

expire_atall ofOptional

Blacklisted number's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

descriptionstring · max: 255Optional

Remarks for the blacklisted number.

Responses

201

Created

application/json

4XX

Error

post

HTTPcURLJavaScriptPython

POST /api/blacklisted_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Show blacklisted number

get

Authorizations

Path parameters

idall ofRequired

The unique ID of this blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/blacklisted_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "created_at": "2017-07-21T17:32:28Z",
  "updated_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

Update blacklisted number

post

Authorizations

Path parameters

idall ofRequired

The unique ID of this blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

numberstring · min: 1 · max: 64Optional

An alphanumeric sequence beginning with an optional plus sign.

expire_atall ofOptional

Blacklisted number's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

descriptionstring · max: 255Optional

Remarks for the blacklisted number.

Responses

200

OK

4XX

Error

post

HTTPcURLJavaScriptPython

POST /api/blacklisted_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

No content