Checks whether SMS may be sent to a phone number for the caller's merchant scope.
GET
/api/twilio/sms-consent/check
deprecated
Requires: Twilio.SmsConsent.View, merchant scope.
A send UI calls this to disable the SMS channel for a recipient who has opted out, before attempting a send. The result reports whether a consent record exists, its status, and whether a send is currently allowed. Scoping is enforced server-side from the caller's operating context.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
PhoneNumber
required |
query | string | Recipient phone number in any common format; normalized to E.164 before lookup. |
MerchantId
required |
query | string (uuid) | Merchant scope for the check. Honoured only when the caller holds `SmsConsent.ViewAllMerchants`; otherwise the app service substitutes the operating-context merchant. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.