blacklist

Add a number to a user's blacklist

Changed on

Adds a phone number to a user's personal blacklist. Once blacklisted, calls from this number to the user are blocked. An optional comment can be attached to explain why the number was blocked (e.g., "spam caller", "wrong number"). If the number is already blacklisted, the request returns 304 Not Modified.

Permission: Users Write required.

Monitoring impact:

  • OFF: Can only add to your own blacklist.
  • ON: Can add to any user's blacklist.
post/users/{userId}/blacklists/numbers

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/users/{userId}/blacklists/numbers
  • Auth
    API key in header Authorization

Path parameters

userIdinteger required
Example:123456

The identifier of the user

Request body

numberinteger

Phone number (E.164 format) (mandatory)

commentstring nullable

A comment about this blacklisted number

directionstring

IN (default value) or OUT for blacklisted numbers

Example request

{
  "number": 33184800000,
  "direction": "IN"
}

Response

Successful operation

Changes

  • d92d55716cc3Revision changes
    • info

      api operation id postUsersUseridBlacklistsNumbers was added

    • info

      the request property became nullable