Submit Campaign
Before creating a campaign, use the Qualify By Usecase endpoint to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. Please note: After campaign creation, you’ll only be able to edit the campaign’s sample messages. Creating a campaign will entail an upfront, non-refundable three month’s cost that will depend on the campaign’s use case (see 10DLC Costs section for details).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
CampaignRequest object describes the campaign to be submitted via '/campaignBuilder/brand/{brandId}/usecase/{usecase}' operation. It is also used in operations for retrieving status of campaign request and for updating a pending request.
Alphanumeric identifier of the brand associated with this campaign.
Summary description of this campaign.
Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.
Age gated message content in campaign.
Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.
Direct lending or loan arrangement
Does message generated by the campaign include URL link in SMS?
Does message generated by the campaign include phone number in SMS?
Subscriber help keywords. Multiple keywords are comma separated without space.
Help message of the campaign.
Message flow description.
Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.
Does campaign utilize pool of phone numbers?
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
Subscriber opt-in message.
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
Subscriber opt-out message.
Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.
Alphanumeric identifier of the reseller that you want to associate with this campaign.
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5 or more message samples.
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases
Does campaign responds to help keyword(s)?
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Tags to be set on the Campaign.
Is terms and conditions accepted?
Link to the campaign's privacy policy.
Link to the campaign's terms and conditions.
Sample of an embedded link that will be sent to subscribers.
Webhook to which campaign status updates are sent.
"https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93"
Failover webhook to which campaign status updates are sent.
"https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963"
Response
Successful Response
Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including usecase, vertical, brandId and cspId.
Unique identifier assigned to the brand.
"d2ca9d69-641b-4131-83fa-5d0744f4c8a9"
Unique identifier for a campaign.
"823d6b1a-6ed6-41a3-9c50-c8ff41b682ba"
Alphanumeric identifier of the CSP associated with this campaign.
Summary description of this campaign.
Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases
Is terms & conditions accepted?
Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.
Age gated content in campaign.
Campaign subscription auto-renewal status.
Campaign recent billed date.
Display or marketing name of the brand.
"ABC Mobile"
Unique identifier assigned to the brand by the registry.
"BBRAND1"
Unique identifier assigned to the campaign by the registry.
"CCAMP1"
Unix timestamp when campaign was created.
Does message generated by the campaign include URL link in SMS?
Does message generated by the campaign include phone number in SMS?
Subscriber help keywords. Multiple keywords are comma separated without space.
Help message of the campaign.
Message flow description.
When the campaign would be due for its next renew/bill date.
Does campaign utilize pool of phone numbers?
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
Subscriber opt-in message.
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
Subscriber opt-out message.
Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.
Alphanumeric identifier of the reseller that you want to associate with this campaign.
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5 or more message samples.
Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.
Does campaign responds to help keyword(s)?
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.
This field is deprecated.
Webhook to which campaign status updates are sent.
"https://example.com/webhook"
Failover webhook to which campaign status updates are sent.
"https://example.com/failover-webhook"
Indicates whether the campaign is registered with T-Mobile.
Indicates whether the campaign is suspended with T-Mobile.
Indicates whether the campaign has a T-Mobile number pool ID associated with it.
Failure reasons if campaign submission failed
Campaign submission status
CREATED, FAILED, PENDING Campaign status
TCR_PENDING, TCR_SUSPENDED, TCR_EXPIRED, TCR_ACCEPTED, TCR_FAILED, TELNYX_ACCEPTED, TELNYX_FAILED, MNO_PENDING, MNO_ACCEPTED, MNO_REJECTED, MNO_PROVISIONED, MNO_PROVISIONING_FAILED "TCR_ACCEPTED"
Link to the campaign's privacy policy.
Link to the campaign's terms and conditions.
Sample of an embedded link that will be sent to subscribers.