This guide shows you how to create a mock US A2P 10DLC Brand and Campaign that you can use to test and develop applications with. While the creation process of mock and real Brands and Campaigns is similar, there are some key differences to keep in mind:
There are no A2P 10DLC fees from The Campaign Registry (TCR) or billing events for creating mock Brands and Campaigns because there is no vetting or validation of the submitted data.
Mock Campaigns are not functional and cannot be used to send SMS traffic.
Mock Sole Proprietor Brands cannot have mock Campaigns created for them and a one-time password (OTP) email will not be sent during mock Brand creation.
Before you begin
Before you can create a mock Brand and Campaign, you'll need to create a real Customer Profile as an ISV-type customer.
First, determine if you'll want to register a mock Standard, Low Volume Standard, or Sole Proprietor Brand with your Customer Profile. If you're not sure which Brand type to choose, check out this Support article for a detailed look at the differences. Note that mock Sole Proprietor Brands cannot have mock Campaigns created for them, because the OTP (one time password) will not be sent to the designated contact during Brand creation.
For a mock Standard or Low Volume Standard Brand:
Complete all steps before
3. Create a BrandRegistrationin this API walkthrough
, then proceed to Step 1.
For a mock Sole Proprietor Brand:
Complete all steps before
3. Create a new Sole Proprietor A2P Brandin this API walkthrough
, then proceed to Step 1.
Step 1. Create a mock Brand
Now that your Customer Profile is set up and linked to an A2P Messaging Profile, you can create a mock Brand.
The process for creating a mock Brand is almost identical to creating a real Brand. The key difference is that you'll need to set the mock request body parameter to True when making the POST request to the Messaging API BrandRegistration Resource. If mock is not specified or set to False, a real Brand will be created.
For a mock Standard or Low Volume Standard Brand:
Reference step
3. Create a BrandRegistrationin this API walkthrough
for constructing your API request, and set
mock
to
True
.
For a mock Sole Proprietor Brand:
Reference step
3. Create a new Sole Proprietor A2P Brandin this API walkthrough
for constructing your API request, and set
mock
to
True
.
Parameter
Valid Values
Description
mock
True, False
Will create a mock Brand if set to True or a real Brand if either set to False or not specified.
Create a mock Standard Brand
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_15
// Download the helper library from https://www.twilio.com/docs/node/install
_15
// Find your Account SID and Auth Token at twilio.com/console
_15
// and set the environment variables. See http://twil.io/secure
If you created a mock Sole Proprietor Brand, you will not be able to create mock Campaigns and can skip the remaining steps.
Step 2. Create a Messaging Service
(error)
Danger
We highly discourage the use of existing Messaging Services with Senders in the Sender Pool to avoid any risks of your US messages failing.
Now you will need a Messaging Service to associate with the mock Campaign you are about to create. We recommend creating a new Messaging Service without any Senders. To do that, follow step 4. Create a Messaging Servicein this API walkthrough.
Step 3. Create a mock Campaign
Now that you've created a mock Brand and Messaging Service, you can create an associated mock Campaign. A Campaign represents a single messaging use case or the intent of the messages you wish to send. For example, your Campaign's use case might be to send marketing or account notifications.
The process for creating a mock Campaign is identical to creating a real Campaign. Any Campaign that is associated with a mock Brand automatically becomes a mock Campaign, so there is no need to pass in a mock request parameter during Campaign creation.
Reference step 5. Create an A2P Campaignin this API walkthrough when constructing your API request.
Create a mock Standard Campaign
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
"description": "Send marketing messages about sales and offers",
_46
"message_samples": [
_46
"Book your next OWL FLIGHT for just 1 EUR"
_46
],
_46
"us_app_to_person_usecase": "STANDARD",
_46
"has_embedded_links": true,
_46
"has_embedded_phone": false,
_46
"subscriber_opt_in": false,
_46
"age_gated": false,
_46
"direct_lending": false,
_46
"campaign_status": "PENDING",
_46
"campaign_id": "CFOOBAR",
_46
"is_externally_registered": false,
_46
"rate_limits": {
_46
"att": {
_46
"mps": 600,
_46
"msg_class": "A"
_46
},
_46
"tmobile": {
_46
"brand_tier": "TOP"
_46
}
_46
},
_46
"message_flow": "End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in.",
_46
"opt_in_message": "Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP",
_46
"opt_out_message": "You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number.",
_46
"help_message": "Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.",
You can confirm that the new Campaign you created is a mock by checking for "mock": true in the response.
Mock deletion
Mock Brands cannot be manually deleted. They will expire and be automatically deleted 30 days after initial creation, along with all mock Campaigns associated with them.
Mock Campaigns can be deleted using the Messaging API with the US A2P identifier QE2c6890da8086d771620e9b13fadeba0b as seen in the example below. This request will remove the mock Campaign associated with the specified Messaging Service.
Delete a mock Campaign
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl
_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure