ConsentCheckRequest
Asks whether an address may be contacted on a channel (1.61.0); the address travels in the body, never in a query string, and the answer never repeats it.
An object with 4 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
address | ConsentAddress | yes | |
channel | one of "voice", "sms", "whatsapp", "email", "app_push" | yes | An address channel. |
purpose | ConsentPurpose | no | all when omitted, which an opt-out of any purpose refuses. |
sender | ConsentSenderInput | no | The sender to check as well: the caller ID number of a Call, or the Connection of a message. Organization scope only when omitted. |
Used by
The operations whose parameters, request body or responses name this shape directly.