Blacklisted numbers

List blacklisted numbers

GEThttp://127.0.0.1:8888/api/blacklisted_numbers

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/blacklisted_numbers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "number": "text",
      "expire_at": {},
      "created_at": {},
      "updated_at": {},
      "description": "text"
    }
  ]
}

Create new blacklisted number

POSThttp://127.0.0.1:8888/api/blacklisted_numbers

Body

application/json

number*string

An alphanumeric sequence beginning with an optional plus sign.

expire_atall of

Blacklisted number's expire time.

descriptionstring

Remarks for the blacklisted number.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of this blacklisted number.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/blacklisted_numbers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "number": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Show blacklisted number

GEThttp://127.0.0.1:8888/api/blacklisted_numbers/{id}

Path parameters

id*all of

The unique ID of this blacklisted number.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of this blacklisted number.

numberstring

An alphanumeric sequence beginning with an optional plus sign.

expire_atall of

Blacklisted number's expire time.

created_atall of

Blacklisted number's creation time.

updated_atall of

Blacklisted number's last updated time.

descriptionstring

Remarks for the blacklisted number.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/blacklisted_numbers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "number": "text",
  "expire_at": {},
  "created_at": {},
  "updated_at": {},
  "description": "text"
}

Update blacklisted number

POSThttp://127.0.0.1:8888/api/blacklisted_numbers/{id}

Path parameters

id*all of

The unique ID of this blacklisted number.

Body

application/json

numberstring

An alphanumeric sequence beginning with an optional plus sign.

expire_atall of

Blacklisted number's expire time.

descriptionstring

Remarks for the blacklisted number.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/blacklisted_numbers/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();