API Reference
API Reference

Verify Twilio Us A2P Compliance

Return whether Twilio shows this number on a US A2P messaging path with an approved brand.

POST/api/v1/channels/twilio/{channel_id}/numbers/verify-a2p-compliance

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

channel_id integer path required

Request body

application/json

body A2pMessagingPathCheckRequest required
1 field
phonestringrequired

E.164 phone number exactly as Twilio stores it for this incoming number.

Request example
{
  "phone": "string"
}

Responses

200Successful Response

application/json

response A2pMessagingPathCheckResponse required
1 field
a2p_approvedbooleanrequired

True when the number is on a Messaging Service with a US A2P registration whose brand is approved and campaign is verified on the same registration.

Response example
{
  "a2p_approved": true
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}