Do Not Call

Add a number to the Do Not Call list

Add a number. Send opted_out: true when the person asked not to be called: it becomes a permanent opt-out and their AI-call consent is revoked. Adding a number already on the list returns the existing entry with status 200.

post/do-not-call

Request

  • Base URL: https://vocenya.com/api/public/v1
  • URL: https://vocenya.com/api/public/v1/do-not-call
  • Auth: HTTP bearer

Request body

phone_numberstring required
notestring nullable
opted_outboolean

The person asked not to be called. Recorded as a permanent opt-out that can never be removed, and any AI-call consent they gave is revoked.

Example request

{
  "note": "Asked us to stop calling"
}

Response

The number was already on the list: the existing entry.

Example response

{
  "data": {
    "phone_number": "+15125550123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.