SmsCheckBlacklistPhone¶

GET sms/blacklist/check

Checks one number against the do-not-message list. It exists so the CRM can disable the send button up front instead of letting a manager type a message and read an error.

The check normalizes the number the same way sending does, so what the UI sees here is what SmsSendMessage would decide.

Access Control¶

Allowed roles: admin, leader, manager.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/blacklist/check?phone=+380950000000
Authorization: <JWT_TOKEN>

{
  "command": "SmsCheckBlacklistPhone",
  "extID": "1",
  "data": {
    "phone": "+380950000000"
  }
}

const res = await platform.SmsCheckBlacklistPhone({
  phone: "+380950000000"
});

Request Data¶

Field	Type	Required	Description
`phone`	string	Yes	Number in any human format

Response Data¶

entry.source matters for the UI: an OPT_OUT still allows a TRANSACTIONAL message, while a regulator or manual block does not.

{
  "phone": "380950000000",
  "country": { "iso": "UA", "name": "Ukraine", "dialCode": "380" },
  "blacklisted": true,
  "entry": {
    "id": 31,
    "phone": "380950000000",
    "source": "OPT_OUT",
    "reason": "Recipient replied STOP",
    "expiresAt": null,
    "createdAt": "2026-08-24 13:44:02"
  }
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Number is too short to be a phone number