SmsConsentCaptureMethod
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
How a consent or opt-out record came to be. Part of the proof-of-consent evidence retained per the Twilio Messaging Policy record-keeping requirement, and useful for triage when a recipient disputes having opted in or out.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Unknown |
Capture method was not supplied. Treated as the least-authoritative evidence. |
WebForm |
Recipient opted in through a public web form (e.g. a hosted checkout consent checkbox). |
VirtualTerminal |
An operator captured consent while taking the payment in the Virtual Terminal. |
HostedPaymentPage |
Consent was captured on a Hosted Payment Page flow. |
Import |
The record was created from a bulk import of prior consent evidence. |
ApiRequest |
Consent or opt-out was recorded through the API by an integrating system. |
AdminEntry |
An administrator recorded the consent or opt-out manually. |
CarrierBackfill |
Opt-out was back-filled from a carrier send-time signal (Twilio error 21610 on send). The platform learned of the revocation from the carrier rather than capturing it directly. Inbound STOP / START replies use InboundKeyword instead, which keeps a more precise evidence trail. |
InboundKeyword |
Consent transition was captured from an inbound SMS keyword the recipient texted to the platform number (STOP / UNSUBSCRIBE / START / etc.), received on the Twilio inbound webhook. The inbound message SID is retained as the evidence reference. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.