v1

latestSwagger 2.02026-07-13151175.7 KB

Blocked Numbers

List blocked numbers

get/blocked-numbers

Query parameters

{"stackTrail":"paths:/blocked-numbers:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Records with an id that is greater or equal to min-id will be returned. The default value is 0. You can add 1 to an id that you previously retrieved, to return subsequent records.

{"stackTrail":"paths:/blocked-numbers:get:parameters:1:schema","oasType":"schema","type":"unknown"}

The maximum number of records to return. The default value is 10000. The value cannot be greater than 10000.

Response

A list of BlockedNumber objects

idnumber required

A unique identifier that is assigned when the BlockedNumber is created.

phoneNumberstring required

A phone number in E.164 format

createdstring date-time

The date-time when the blocked number was created. Since 1.1.0.

descriptionstring

A note describing why the number is blocked. Since 1.1.0.

Example response

{
  "id": 234,
  "phoneNumber": "44123456789"
}