Consent

The pre-dial check: may an AI call be placed to this number?

Call it right before dialing and dial only when allowed is true. The answer is written to the record, so it shows the check happened before the call, and the response carries the opening line the call must start with. POST only, so no phone number lands in a URL.

post/api/consent/check

Request

  • Base URL: https://botnotice.app
  • URL: https://botnotice.app/api/consent/check
  • Auth: HTTP bearer

Request body

phonestring required
scope'marketing' | 'informational'
call_refstring

Your call id, written to the record

Response

OK

allowedboolean

Dial only when true

reason'consent_on_file' | 'no_consent' | 'revoked' | 'wrong_scope' | 'invalid_number'
messagestring
disclosurestring

The line the call must open with

policyVersioninteger nullable

Changes

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