Blacklisted numbers

PreviousExport NextDestroy

Was this helpful?

List blacklisted numbers

get

/blacklisted_numbers

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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

skipinteger · int32 · default: 0

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

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

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/blacklisted_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Create new blacklisted number

post

/blacklisted_numbers

Authorizations

Body

numberstring · min: 1 · max: 64required

An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 255

Remarks for the blacklisted number.

expire_atall of

Blacklisted number's expire time.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/blacklisted_numbers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "description": "text",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Show blacklisted number

get

/blacklisted_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of this blacklisted number.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/blacklisted_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

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

Update blacklisted number

post

/blacklisted_numbers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of this blacklisted number.

The unique ID of the resource.

Body

numberstring · min: 1 · max: 64

An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 255

Remarks for the blacklisted number.

expire_atall of

Blacklisted number's expire time.

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

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/blacklisted_numbers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "text",
    "description": "text",
    "expire_at": "2017-07-21T17:32:28Z"
  }'

200

4XX

No body