Campaign

Submit Campaign

Changed on

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).

post/10dlc/campaignBuilder

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/10dlc/campaignBuilder
  • Auth
    HTTP bearer

Request body

ageGatedboolean

Age gated message content in campaign.

autoRenewalboolean

Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.

brandIdstring required

Alphanumeric identifier of the brand associated with this campaign.

descriptionstring required

Summary description of this campaign.

directLendingboolean

Direct lending or loan arrangement

embeddedLinkboolean

Does message generated by the campaign include URL link in SMS?

embeddedPhoneboolean

Does message generated by the campaign include phone number in SMS?

helpKeywordsstring

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessagestring

Help message of the campaign.

messageFlowstring

Message flow description.

mnoIdsinteger[]

Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.

numberPoolboolean

Does campaign utilize pool of phone numbers?

optinKeywordsstring

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

optinMessagestring

Subscriber opt-in message.

optoutKeywordsstring

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

optoutMessagestring

Subscriber opt-out message.

referenceIdstring

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

resellerIdstring

Alphanumeric identifier of the reseller that you want to associate with this campaign.

sample1string

Message sample. Some campaign tiers require 1 or more message samples.

sample2string

Message sample. Some campaign tiers require 2 or more message samples.

sample3string

Message sample. Some campaign tiers require 3 or more message samples.

sample4string

Message sample. Some campaign tiers require 4 or more message samples.

sample5string

Message sample. Some campaign tiers require 5 or more message samples.

subUsecasesstring[]

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases

subscriberHelpboolean

Does campaign responds to help keyword(s)?

subscriberOptinboolean

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptoutboolean

Does campaign support subscriber opt-out keyword(s)?

tagstring[]

Tags to be set on the Campaign.

termsAndConditionsboolean

Is terms and conditions accepted?

privacyPolicyLinkstring

Link to the campaign's privacy policy.

termsAndConditionsLinkstring

Link to the campaign's terms and conditions.

embeddedLinkSamplestring

Sample of an embedded link that will be sent to subscribers.

usecasestring required

Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.

webhookURLstring

Webhook to which campaign status updates are sent.

webhookFailoverURLstring

Failover webhook to which campaign status updates are sent.

Example request

{
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "webhookFailoverURL": "https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963"
}

Response

Successful Response

ageGatedboolean

Age gated content in campaign.

autoRenewalboolean

Campaign subscription auto-renewal status.

billedDatestring

Campaign recent billed date.

brandIdstring required

Unique identifier assigned to the brand.

brandDisplayNamestring

Display or marketing name of the brand.

campaignIdstring required

Unique identifier for a campaign.

tcrBrandIdstring

Unique identifier assigned to the brand by the registry.

tcrCampaignIdstring

Unique identifier assigned to the campaign by the registry.

createDatestring

Unix timestamp when campaign was created.

cspIdstring required

Alphanumeric identifier of the CSP associated with this campaign.

descriptionstring required

Summary description of this campaign.

directLendingboolean
embeddedLinkboolean

Does message generated by the campaign include URL link in SMS?

embeddedPhoneboolean

Does message generated by the campaign include phone number in SMS?

helpKeywordsstring

Subscriber help keywords. Multiple keywords are comma separated without space.

helpMessagestring

Help message of the campaign.

messageFlowstring

Message flow description.

mockboolean required

Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.

nextRenewalOrExpirationDatestring

When the campaign would be due for its next renew/bill date.

numberPoolboolean

Does campaign utilize pool of phone numbers?

optinKeywordsstring

Subscriber opt-in keywords. Multiple keywords are comma separated without space.

optinMessagestring

Subscriber opt-in message.

optoutKeywordsstring

Subscriber opt-out keywords. Multiple keywords are comma separated without space.

optoutMessagestring

Subscriber opt-out message.

referenceIdstring

Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.

resellerIdstring

Alphanumeric identifier of the reseller that you want to associate with this campaign.

sample1string

Message sample. Some campaign tiers require 1 or more message samples.

sample2string

Message sample. Some campaign tiers require 2 or more message samples.

sample3string

Message sample. Some campaign tiers require 3 or more message samples.

sample4string

Message sample. Some campaign tiers require 4 or more message samples.

sample5string

Message sample. Some campaign tiers require 5 or more message samples.

statusstring

Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

subUsecasesstring[] required

Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases

subscriberHelpboolean

Does campaign responds to help keyword(s)?

subscriberOptinboolean

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptoutboolean

Does campaign support subscriber opt-out keyword(s)?

termsAndConditionsboolean required

Is terms & conditions accepted?

usecasestring required

Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.

verticalstring

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.

webhookURLstring

Webhook to which campaign status updates are sent.

webhookFailoverURLstring

Failover webhook to which campaign status updates are sent.

isTMobileRegisteredboolean

Indicates whether the campaign is registered with T-Mobile.

isTMobileSuspendedboolean

Indicates whether the campaign is suspended with T-Mobile.

isTMobileNumberPoolingEnabledboolean

Indicates whether the campaign has a T-Mobile number pool ID associated with it.

failureReasonsstring

Failure reasons if campaign submission failed

submissionStatus'CREATED' | 'FAILED' | 'PENDING'

Campaign submission status

campaignStatus'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'

Campaign status

privacyPolicyLinkstring

Link to the campaign's privacy policy.

termsAndConditionsLinkstring

Link to the campaign's terms and conditions.

embeddedLinkSamplestring

Sample of an embedded link that will be sent to subscribers.

Example response

{
  "brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
  "brandDisplayName": "ABC Mobile",
  "campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
  "tcrBrandId": "BBRAND1",
  "tcrCampaignId": "CCAMP1",
  "webhookURL": "https://example.com/webhook",
  "webhookFailoverURL": "https://example.com/failover-webhook",
  "campaignStatus": "TCR_ACCEPTED"
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status