Leveraging Public APIs with 10 DLC
Objective
Leveraging Vonage public APIs with 10 DLC.
Applies To
- 10 DLC
- Public APIs
Procedure
For a description of the available APIs, see our developer documentation.
1. Calls to Perform to Create a Brand
All brands created will be verified by the TCR (The Campaign Registry). This verification only allows to create campaigns, but will limit the brand to the lowest throughput possible. In order to ensure the best throughput is assigned to your campaigns, you will need to vet the brand.
Note that any brand failing the verification will also need to go through vetting.
- Create a brand
- Apply for vetting
The vetting can take a few days, depending on the home country of the entity to vet or the need to manually verify some details. To ensure the best outcomes, please make sure to provide the information as they appear on the official records for your home country.
If the vetting fails, you can appeal. Please reach out to our support teams.
- Alternative: Import existing vetting
Leveraging the endpoint: PUT
https://api-eu.vonage.com/v1/10dlc/brands/:brand_id/vetting/requests/
In order to import an existing vetting, you will need to know the following details:
evp_id (vetting agency), vetting_id, vetting_token
Campaign Verify (CV) political vets can only be imported via this endpoint into Vonage currently.
For more information on how to obtain a CV political vet, please check their website.
Important information: Vets are not transferrable between service providers due to regulatory limitations. We will let you know if this changes in the future.
Customers may be able to import such vet via the vetting import endpoint if they can obtain the required information.
Wait until the vetting steps are completed before moving to the next part and creating campaigns.
2. Calls to Perform to Create a Campaign
Before you can create a campaign, you need to make sure that your brand is qualified to create campaigns for this use-case. This is a required step for all new use-case.
- Verify the brand is qualified (required for each new campaign use case)
- Create a campaign
Once the campaign has been created, a request is sent for approval to all the US carriers. Please note that you cannot link numbers to your campaign until all carriers have approved the campaign. It can take up to 7 days for all carriers to approve the campaign.
3. Link Number(s) to Your Campaign
Once all carriers have approved the campaign, you can link numbers to it. Please note that all campaigns (except special use cases) have their throughput limit set at the campaign level, so having more than 1 number linked to the campaign will not increase the amount of messages that can be sent.
Important Consideration
If you have a need for more than 50 numbers to be linked to a single campaign, you need to set number_pool to true when declaring the campaign. In addition to that, you will need to open a support ticket to create a Special Business Review sent to T-mobile for approval. Currently those fees are waived, but in time T-mobile will charge $2000 for these SBRs.
Comments
0 comments
Please sign in to leave a comment.