# GET /api/twilio/sms-consent/check

Checks whether SMS may be sent to a phone number for the caller's 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.

**Operation ID:** `GET_api_twilio_sms-consent_check`

## Authorization

Requires: Twilio.SmsConsent.View, merchant scope.

Required permissions:
- `Twilio.SmsConsent.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| PhoneNumber | query | no | string | Recipient phone number in any common format; normalized to E.164 before lookup. |
| MerchantId | query | no | 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 | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateTwilioSmsSmsConsentCheckResultDto`

**Content type:** `application/json`

Schema: `PhoeniXGateTwilioSmsSmsConsentCheckResultDto`

**Content type:** `text/json`

Schema: `PhoeniXGateTwilioSmsSmsConsentCheckResultDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.