Skip to contentSkip to navigationSkip to topbar
Twilio Docs
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

Property nameTypePIIDescription
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

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

Property nameTypeRequiredPIIDescription
MessagingServiceSidSID<MG>required
Not PII

The SID of the Messaging Service to fetch the resource from.

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

Query parameters

Property nameTypeRequiredPIIDescription
BrandRegistrationSidSID<BN>Optional
Not PII

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

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_20
// Download the helper library from https://www.twilio.com/docs/node/install
_20
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20
// Find your Account SID and Auth Token at twilio.com/console
_20
// and set the environment variables. See http://twil.io/secure
_20
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20
const authToken = process.env.TWILIO_AUTH_TOKEN;
_20
const client = twilio(accountSid, authToken);
_20
_20
async function fetchUsAppToPersonUsecase() {
_20
const usAppToPersonUsecase = await client.messaging.v1
_20
.services("MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
_20
.usAppToPersonUsecases.fetch({
_20
brandRegistrationSid: "BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20
});
_20
_20
console.log(usAppToPersonUsecase.usAppToPersonUsecases);
_20
}
_20
_20
fetchUsAppToPersonUsecase();

Output

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

Rate this page: