latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

blacklist

Check if a number is in a user's blacklist

Checks whether a specific phone number is present in a user's personal blacklist. Returns 200 with the blacklist entry (including comment) if the number is found, or 404 if it is not blacklisted. Use this for quick lookups before deciding to add or remove a number.

Permission: Users Read required.

Monitoring impact:

  • OFF: Can only check your own blacklist. Requesting another user's blacklist returns 401.
  • ON: Can check any user's blacklist.
get/users/{userId}/blacklists/numbers/{phoneNumber}

Path parameters

userIdinteger required
Example:123456

The identifier of the user

phoneNumberinteger required
Example:33612345678

Phone number in E.164 format without the + prefix (e.g., 33612345678).

Response

The phone number is blacklisted by this user

user_idinteger

Your user identifier

team_idinteger

Your team identifier

numberinteger

A blacklisted number

commentstring nullable

The comment about this blacklisted number, can be null.

directionstring

IN or OUT for blacklisted numbers (direction of the call)

Example response

{
  "user_id": 12345,
  "team_id": 123456,
  "number": 33184800000,
  "comment": "Unfriendly",
  "direction": "IN"
}