SmsGetBlacklist¶

GET sms/blacklist/list

Returns the do-not-message entries of the brand: number, where the block came from, why, and when it expires.

Filtering by source separates opt-outs from regulator lists — a marketing report needs the first, a compliance audit the second.

Access Control¶

Allowed roles: admin, leader.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/blacklist/list?limit=100&orderBy=%5B%22id%22%2C%22DESC%22%5D&count=%5B%22id%22%5D
Authorization: <JWT_TOKEN>

{
  "command": "SmsGetBlacklist",
  "extID": "1",
  "data": {
    "limit": 100,
    "orderBy": [
      "id",
      "DESC"
    ],
    "count": [
      "id"
    ]
  }
}

const res = await platform.SmsGetBlacklist({
  limit: 100,
  orderBy: [
    "id",
    "DESC"
  ],
  count: [
    "id"
  ]
});

Request Data¶

Field	Type	Required	Description
`limit`	int	No	Page size, `1..1000`, default `100`
`offset`	int	No	Rows to skip
`orderBy`	array	No	Sorting, for example `["id", "DESC"]`
`count`	array	No	Row count aggregate, `["id"]`
`where`	object	No	Filters, see Table filter syntax

Response Data¶

{
  "rows": [
    {
      "id": 31,
      "brand": "default",
      "phone": "380950000000",
      "countryCode": "380",
      "countryIso": "UA",
      "source": "OPT_OUT",
      "reason": "Recipient replied STOP",
      "expiresAt": null,
      "createdAt": "2026-08-24 13:44:02",
      "createdBy": 10
    }
  ],
  "count": [ { "id": 1 } ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Session may not read the blacklist