Create Mock US A2P 10DLC Brands and Campaigns

The US App to Person (A2P) 10DLC Mock Brand and Campaign API allows you to develop and test applications against Twilio’s A2P Brand and Campaign APIs without incurring any A2P 10DLC related fees. Mock brands and mock campaigns are created similarly to brands and campaigns registered against the non-mock A2P APIs; however, there are some important restrictions and considerations to keep in mind when you’re using this API. Notably, TCR does not charge fees for Mock brands/campaigns because it does no vetting of their information: there is no lookup of EIN/Tax ID, no validation of websites or other information submitted with the Campaign; and in the case of Sole Proprietor, submitting a Mock Brand will not generate an OTP request to the designated contact email.

This guide will cover:

1. The prerequisites needed to get started with the Mock Brand API.
2. Creating mock brands.
3. Creating mock A2P SMS campaign use cases.
4. Deleting mock A2P SMS campaign use cases.
5. Mock Brand Registration Rules

1. Prerequisites

Before you can start testing against the Mock Brand API you will need to create a real (non-mock) customer profile and complete all steps before Step 3, "Create an A2P Brand" in one of the two Independent Software Vendor (ISV) API walkthroughs.

For the registration process for a Standard or Low-Volume Standard Brand, see this API walkthrough.

For the registration process for a Sole Proprietor Brand, see this API walkthrough. Again, however, please be aware that Mock Sole Proprietor Brand submission will not generate an OTP request as non-mock Sole Proprietor submission will.

2. Creating Mock Brands

Which API? Messaging API

After successfully creating a Customer Profile and linking it to an A2P messaging profile, you’re ready to create a mock brand. To do so, you will make a POST request to the Brand Registrations API (the Messaging API), as you would for a regular Brand submission, but pass the mock parameter set to True in the request body. Mock brand creation occurs during Step 3, "Create an A2P Brand" of the ISV Standard/Low-Volume Standard API walkthrough, and similarly Step 3 of the ISV Sole Proprietor API walkthrough.

Note the response for this request. You will see the mock parameter with the boolean value true upon successful creation of a mock brand. If you don’t pass mock your brand will be created as a real (non-mock) brand, incurring A2P 10DLC fees and billing events where applicable.

3. Creating Mock Campaigns

Which API? Messaging API

Prior to creating a mock campaign, you will need a Messaging Service to associate with the mock campaign. To do that, please see Step 4 "Create a Messaging Service"in the ISV Standard Brand API walkthrough.

Once you’ve created your mock brand and a Messaging Service, you can create an associated mock A2P SMS Campaign. An A2P SMS Campaign represents a single messaging use case or the intent of the messages you wish to send (for example: marketing or account notifications).

Mock Campaign creation corresponds to Step 5 in the Standard/Low Volume Standard as well as Sole Proprietor ISV API walkthrough.

Mock campaigns can only be created from mock brands, and they inherit the mock parameter from that mock brand. There is thus no need to pass a mock parameter in the Campaign creation step itself.

In the response for this request you will see the mock parameter with the boolean value true indicating that this campaign was created from a mock brand, making it a mock campaign.

Please note again that you must pass True for the mock attribute when creating your mock brand in order to create a mock campaign.

4. Deleting Mock Campaigns

Which API? Messaging API

Once you are finished testing your mock Campaign, you can delete it from your Messaging Service with the US A2P Compliance resource identifier QE2c6890da8086d771620e9b13fadeba0b. You can then add a new Campaign with a non-mock brand to start sending A2P messaging traffic from the Messsaging Service.

5. Mock Brand Registration Rules

Here are some additional business rules surrounding mock Brands and Campaigns:

• Sole Proprietor mock Brands will not cause generation of an OTP request, which also means that such Brands will remain in an Unverified state, and cannot have Campaigns created on top of them.
• Mock brands cannot be manually deleted, but will be expire and be automatically deleted 30 days after initial registration. Deletion will cascade across all campaigns created from mock brands.
• Campaigns created from mock brands are mock campaigns.
• Mock campaigns are not functional campaigns. You cannot run SMS traffic over mock campaigns.
• There are no billing events generated by mock Brand and/or Campaign creation