Skip to content

Click2CallCheckBlacklistPhone

GET click2call/blacklist/check

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

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

Access Control

Allowed roles: admin, leader, manager.

Request

GET request
GET https://{broker_domain}/click2call/blacklist/check?phone=+380950000000
Authorization: <JWT_TOKEN>
{
  "command": "Click2CallCheckBlacklistPhone",
  "extID": "1",
  "data": {
    "phone": "+380950000000"
  }
}
const res = await platform.Click2CallCheckBlacklistPhone({
  phone: "+380950000000"
});

Request Data

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

Response Data

entry is null for a number that is not listed, so the reason is available in the same call that answers the question.

{
  "phone": "380950000000",
  "country": { "iso": "UA", "name": "Ukraine", "dialCode": "380" },
  "blacklisted": true,
  "entry": {
    "id": 31,
    "phone": "380950000000",
    "source": "CUSTOMER_REQUEST",
    "reason": "Customer asked not to be contacted",
    "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