Blocked Numbers

List blocked numbers

get/blocked-numbers

Request

Base URL
https://api.bulksms.com/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/bulksms/apis/bulksms-json-rest-api/docs/blocked-numbers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

min-idunknown

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.

limitunknown

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.