Disallowed codes

List block codes

List block codes.

get

/disallowed_codes

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

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

200

4XX

200

{
  "count": 100,
  "items": [
    {
      "number_prefix": "text",
      "description": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

OK

Create a block code

Create a block code.

post

/disallowed_codes

Authorizations

Body

number_prefixstring · min: 1 · max: 16

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024

The description of blocked code.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/disallowed_codes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number_prefix": "text",
    "description": "text"
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve blocked code

Retrieve details of blocked code by it's unique ID.

get

/disallowed_codes/{id}

Authorizations

Path parameters

idstringrequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

{
  "number_prefix": "text",
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

OK

Update a blocked code

Update a blocked code by it's ID.

post

/disallowed_codes/{id}

Authorizations

Path parameters

idstringrequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

number_prefixstring · min: 1 · max: 16

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024

The description of blocked code.

idall of

The unique ID of blocked code.

The unique ID of the resource.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/disallowed_codes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "number_prefix": "text",
    "description": "text",
    "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
  }'

200

4XX

200

No body

OK