The Wavix 10DLC API is available for Flex Pro users only.
Prerequisites
Create a Wavix account
- Sign up for a Wavix account using your business email address.
- Confirm your email address and phone number during the sign-up process.
- Wait for your account to be approved by the Wavix team.
- After approval, choose either the Wavix Flex or Flex Pro account level.
Find your API key
Wavix uses API keys to authenticate requests. To find API keys associated with your account:- Sign in to your Wavix account.
- Go to Administration → API Keys.
- Copy the API key you want to use, or create a new one by clicking Create new.
What is 10DLC?
10DLC (10-digit long code) allows businesses to send A2P (application-to-person) messages using standard, local U.S. 10-digit phone numbers as sender IDs.What is The Campaign Registry (TCR)?
The Campaign Registry (TCR) is the central hub for registering A2P messaging campaigns in the U.S.- Each brand registration must be pre-approved by mobile carriers.
- Message throughput is determined by carriers after registration and depends on brand details and message content.
You only need to register a 10DLC brand and campaign if you use 10-digit local phone numbers as sender IDs. This does not apply to toll-free numbers or short codes.
Brand and Campaign registration flow
- Register a brand on your account.
- After brand verification, register one or more campaigns for the brand.
- After campaign approval, associate one or more local U.S. phone numbers with the campaigns.
Subscribe to 10DLC webhooks
Subscribe to webhooks to be notified about events related to brands, campaigns, and phone numbers.subscription_category
: Event category to subscribe to (brand
,campaign
, ornumber
).url
: Webhook URL to send events to.
subscription_category
the following JSON objects will be sent to the webhook.
- If subscription_category is brand Brands status updates will be posted to your webhook
brand_id
: the unique identifier of the Brandstatus
: the updated status of the Brand
- If subscription_category is campaign Campaigns status updates will be posted to your webhook
brand_id
: the unique identifier of the Brandcampaign_id
: the unique identifier of the Campaignstatus
: the updated status of the Campaign
Register a 10DLC brand
Entity types supported:private-profit
, public-profit
, non-profit
, government
.
GOVERNMENT
: Only US government agencies can register a brand under this entity type. For government entities outside the US, use thePRIVATE_PROFIT
entity type.NON_PROFIT
: Only US-based non-profit organizations can register under this entity type. Non-profit organizations outside the US should use thePRIVATE_PROFIT
entity type.PUBLIC_PROFIT
: When registering a brand under this entity type, you must specify the stock exchange and provide the brand’s stock ticker.
Ensure all brand information is accurate and up-to-date. The details you submit will be subject to an Identity Verification process conducted by the TCR. Any inconsistencies or mismatches between the submitted information and official records will result in the rejection of the Brand. The TCR specifically verifies the EIN/Tax ID, company legal name, and company legal address.
HTTP 201 OK
status. The response will include the newly created Brand object.
Appeal a brand identity verification
If your brand isUNVERIFIED
, review and update details. If you believe the information is correct, you can submit an appeal for the Brand identity verifications and optionally upload supporting documents.
brand_id
: Unique identifier of the brand.appeal_categories
: Array of appeal categories.evidence
: Array of evidence UUIDs (optional).explanation
: Justification for your appeal (optional).
VERIFY_TAX_ID
: ForPRIVATE_PROFIT
,PUBLIC_PROFIT
,NON_PROFIT
, andGOVERNMENT
entities with an identity verification status ofUNVERIFIED
.VERIFY_NON_PROFIT
: ForNON_PROFIT
entities with an identity verification status ofUNVERIFIED
orVERIFIED
but missing theTax Exempt
status.VERIFY_GOVERNMENT
: ForGOVERNMENT
entities with an identity verification status ofUNVERIFIED
orVERIFIED
but missing theGovernment Entity
status.
Brand vetting
Apply for brand vetting to access special use cases, improve throughput, or pass verification. You can import external vettings. Use the following method to request external vetting for the Brand:brand_id
: Unique identifier of the brand.evp_id
: External vetting provider code (AEGIS
,CV
,WMC
).vetting_class
: Requested vetting type (STANDARD
,ENHANCED
,POLITICAL
).
Register a 10DLC campaign
You can register a campaign after your brand isVERIFIED
or VETTED_VERIFIED
.
As mandated by US MNOs (Mobile Network Operators), you must declare a use case for your Campaign. Select the most appropriate use case and include additional details in the Сampaign description. Wavix supports two types of use case categories:
- Standard use cases: Available for all qualified brands.
- Special use cases: Sensitive/critical, may require vetting or approval.
Once a campaign is created, the use case cannot be changed.
- Campaign description - give a clear, detailed description of the Campaign’s purpose.
- Opt-in workflow - describe the process through which consumers opt-in to the Campaign, ensuring they give informed consent to receive messages. This description should be explicit and inform consumers about the nature of the program. If there are multiple opt-in methods, include them all.
- Message samples - provide at least one sample message for the Campaign. Some Campaign types require a minimum of two samples. Use the ‘Qualify a 10 DLC Brand for a Use Case’ method to check the required number of samples.
- Message content attributes - specify the attributes of the message content to help MNOs better what will be sent.
- Opt-in, opt-out, and help keywords and acknowledgments: include keywords for opting in, opting out, and seeking help, along with any required acknowledgments
HTTP 201 OK
status. The response will include the created Campaign object.
All campaigns require a minimum 3-month commitment. Wavix bills for the first three months upfront. Afterward, campaigns renew monthly. Political campaigns are renewed monthly with no minimum commitment.
Associate phone numbers with a campaign
After campaign registration, associate phone numbers with the campaign. Sender IDs are created automatically once numbers are activated.You can associate phone numbers before campaign registration is complete, but outbound messaging is only enabled after successful registration.
brand_id
: Unique identifier of the brand.campaign_id
: Unique identifier of the campaign.number
: Phone number to associate with the campaign.