SMS Consent: checks whether SMS may be sent to a number in 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.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/twilio/sms-consent/check?PhoneNumber=PHONE_NUMBER" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-consent/check?PhoneNumber=PHONE_NUMBER' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MessagingApi } from '@winkpg/winkpg-api';

const api = new MessagingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.smsConsentCheck("PHONE_NUMBER");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/sms-consent/check?PhoneNumber=PHONE_NUMBER', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MessagingApi(config);
var result = await api.SmsConsentCheckAsync("PHONE_NUMBER");

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/sms-consent/check?PhoneNumber=PHONE_NUMBER");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MessagingApi(client)
    result = api.sms_consent_check("PHONE_NUMBER")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/twilio/sms-consent/check?PhoneNumber=PHONE_NUMBER",
    headers=headers,
)
response.raise_for_status()
data = response.json()

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 caller's own merchant is used.
`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.