Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

A2P 10DLC - UsAppToPersonUsecase Resource


(warning)

Warning

This API Reference page is meant to supplement the ISV API Onboarding Guides. Do not attempt to use this API Resource without following the appropriate guide, or you may incur delays in registration and unintended fees.

The UsAppToPersonUsecase resource provides a list of possible A2P 10DLC Use Cases that a specific Brand can use when creating an A2P 10DLC Campaign.


UsAppToPersonUsecase Properties

usapptopersonusecase-properties page anchor
us_app_to_person_usecasesarray
Not PII

Human readable name, code, description and post_approval_required (indicates whether or not post approval is required for this Use Case) of A2P Campaign Use Cases.


List possible A2P 10DLC Use Cases

list-possible-a2p-10dlc-use-cases page anchor
GET https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases

This request returns a list of possible A2P 10DLC Use Cases for a given Messaging Service and A2P 10DLC Brand.

You need to provide one of the code values when creating a UsAppToPerson resource.

Path parameters

path-parameters page anchor
MessagingServiceSidSID<MG>required

The SID of the Messaging Service(link takes you to an external page) to fetch the resource from.

Pattern: ^MG[0-9a-fA-F]{32}$Min length: 34Max length: 34
BrandRegistrationSidSID<BN>

The unique string to identify the A2P brand.

Pattern: ^BN[0-9a-fA-F]{32}$Min length: 34Max length: 34

List possible A2P 10DLC Use Cases for a specific BrandRegistration and Messaging Service

list-possible-a2p-10dlc-use-cases-for-a-specific-brandregistration-and-messaging-service page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.messaging.v1.services('MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.usAppToPersonUsecases
_11
.fetch({brandRegistrationSid: 'BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'})
_11
.then(us_app_to_person_usecase => console.log(us_app_to_person_usecase.usAppToPersonUsecases));

Output

_126
{
_126
"us_app_to_person_usecases": [
_126
{
_126
"code": "2FA",
_126
"name": "Two-Factor authentication (2FA)",
_126
"description": "Two-Factor authentication, one-time use password, password reset",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "ACCOUNT_NOTIFICATION",
_126
"name": "Account Notification",
_126
"description": "All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "AGENTS_FRANCHISES",
_126
"name": "Agents and Franchises",
_126
"description": "For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office.",
_126
"post_approval_required": true
_126
},
_126
{
_126
"code": "CHARITY",
_126
"name": "Charity",
_126
"description": "Includes: 5013C Charity
_126
Does not include: Religious organizations",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "PROXY",
_126
"name": "Proxy",
_126
"description": "Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe)
_126
Supporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)",
_126
"post_approval_required": true
_126
},
_126
{
_126
"code": "CUSTOMER_CARE",
_126
"name": "Customer Care",
_126
"description": "All customer care messaging, including account management and support",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "DELIVERY_NOTIFICATION",
_126
"name": "Delivery Notification",
_126
"description": "Information about the status of the delivery of a product or service",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "EMERGENCY",
_126
"name": "Emergency",
_126
"description": "Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies",
_126
"post_approval_required": true
_126
},
_126
{
_126
"code": "FRAUD_ALERT",
_126
"name": "Fraud Alert Messaging",
_126
"description": "Fraud alert notification",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "HIGHER_EDUCATION",
_126
"name": "Higher Education",
_126
"description": "For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any \"free to the consumer\" messaging model",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "K12_EDUCATION",
_126
"name": "K-12 Education",
_126
"description": "Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools.",
_126
"post_approval_required": true
_126
},
_126
{
_126
"code": "LOW_VOLUME",
_126
"name": "Low Volume Mixed",
_126
"description": "Low throughput, any combination of use-cases. Examples include: test, demo accounts",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "MARKETING",
_126
"name": "Marketing",
_126
"description": "Any communication with marketing and/or promotional content",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "MIXED",
_126
"name": "Mixed",
_126
"description": "Mixed messaging reserved for specific consumer service industry",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "POLITICAL",
_126
"name": "Political",
_126
"description": "Part of organized effort to influence decision making of specific group. All campaigns to be verified",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "POLLING_VOTING",
_126
"name": "Polling and voting",
_126
"description": "Polling and voting",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "PUBLIC_SERVICE_ANNOUNCEMENT",
_126
"name": "Public Service Announcement",
_126
"description": "An informational message that is meant to raise the audience awareness about an important issue",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "SECURITY_ALERT",
_126
"name": "Security Alert",
_126
"description": "A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take",
_126
"post_approval_required": false
_126
},
_126
{
_126
"code": "SOCIAL",
_126
"name": "Social",
_126
"description": "Communication within or between closed communities (For example: influencers alerts)",
_126
"post_approval_required": true
_126
},
_126
{
_126
"code": "SWEEPSTAKE",
_126
"name": "Sweepstake",
_126
"description": "Sweepstake",
_126
"post_approval_required": true
_126
}
_126
]
_126
}


Rate this page: