Campaign - Create - api

Search…

Overview

SDK

SMS

Delivery Notifications

MMS

Sending - Embedded

Sending - w/ URL

Order Phone Numbers

List Ratecenters

List Local Numbers

List Tollfree Numbers

Order Single Number

Search Vanity Tollfree

Tollfree Vanity Order

International Numbers

Call Detail Reports

Get Call Records

Get SMS Records

Billing Detail Summary

My Phone Numbers

SIP Users/Endpoints

Register - Create

Register - List

Register - Update

Register - Remove

IP Endpoint - Create

IP Endpoint - List

IP Endpoint - Remove

Channel Groups

Account Information

LNP / Portability

Get Specific Information

Check Number Portability

Check Number Portability - Bulk

Submit Signature

Request CSV List

Customer Features

Customer - Create

Customer - List

Customer - Enable Account

Customer - Disable Account

Customer - Show Rates

Customer - Add Funds

Customer - Update Account

Customer - Update Branding

Customer - Remove CSS

Customer - Remove Logo

Customer - Update Rates

Customer - Set Credit Line

Customer - Reset Password

Customer - Set Channel Limits

Reseller Features

Overview - Complex

Reseller - Create

Reseller - List

Reseller - Enable Account

Reseller - Disable Account

Reseller - Show Rates

Reseller - Add Funds

Reseller - Update Account

Reassign Number to Reseller/Customer

Reseller - Update Branding

Reseller - Remove CSS

Reseller - Remove Logo

Reseller - Update Rates

Reseller - Set Credit Line

Reseller - Reset Password

Reseller - Get Token

Reseller - Enable Offnet

Reseller - Set Channel Limits

Fax Features

List all Faxes for a #

Download Fax File

Delete Fax File

List all Emails on Fax #

Add an Email to Fax #

Remove an Email on a #

Voicemail Features

Create Voicemail Account

Get Voicemail Account

List all Voicemail Accounts

Update Voicemail Account

Remove Voicemail Account

Add Inbox Email

Remove Inbox Email

List Voicemails

Remove Voicemail

Offnet Provisioning

Verify Capability

List Offnet Numbers

Status of Submit

List Job Numbers

Telecom Lookup Tools

Ownership Lookup

911 Emergency

Create 911 Record

Lookup 911 Record

List 911 Records

Update 911 Record

Remove 911 Record

Validate 911 Record

Overview - Alert Groups

Create 911 Alert Group

List 911 Alert Groups

Lookup 911 Alert Group

Remove Alert Group

Assign # to 911 Alert Group

Unassign # 911 Alert Group

Add Notification to AG

Remove Notify from Alert Group

Restricted Users

Special Hooks & Options

Client Libraries

Call Recordings

List Recordings

Get a Recording

Remove a Recording

Campaign Registry

Brand - Qualify

Brand - Order vetting

Brand - Import vetting

Brand - List vettings

Brand - Get feedback

Campaign - List

Campaign - Create

Campaign - Update

Campaign - Delete

Campaign - Assign numbers

Campaign - Remove numbers

Campaign - Get numbers

Campaign - Get operation status

Campaign - Get MNO metadata

Campaign - Get OSR attributes

Campaign - Get sharing status

Reseller - List

Reseller - Create

Reseller - Update

Reseller - Delete

Enum - Usecases

Enum - Verticals

Enum - Optional Attribute Names

Enum - Alternative Business ID Types

Enum - Brand Identity Statuses

Enum - Brand Relationship Types

Enum - Campaign Statuses

Enum - Entity types

Enum - External Vetting Providers

Enum - Vetting Status

Enum - Brand Statuses

Enum - Operation Statuses

Enum - Approved Public Companies

Enum - Stock Exchanges

Enum - Vetting Classes

Webhook - Set URL

Campaign Registry - TCR Registered

Submit Campaign

FAQ

Powered By GitBook

Campaign - Create

Full Url
​https://apiv1.teleapi.net/10dlc/campaign/create​
Arguments
token (required)
brand_id (required)
vertical (required)
usecase (required)
description (required)
sub_usecases (optional, example ['2FA', 'SECURITY_ALERT'])
reseller_id (optional)
embedded_link (optional)
embedded_phone (optional)
number_pool  (optional, boolean, default false) 
age_gated (optional, boolean, default false) 
direct_lending (optional, boolean, default false) 
subscriber_optin (required, boolean) 
subscriber_optout (required, boolean)
subscriber_help (required, boolean) 
sample1 (required)
sample2 (optional)
sample3 (optional)
sample4 (optional)
sample5 (optional)
message_flow (optional)
help_message (optional)
mno_ids (optional, example [10037,10043]
reference_id (optional)
auto_renewal (optional, boolean, default true) 
affiliate_marketing (optional, boolean, default false) 
​
Info
Creates a new TCR campaign. If the submitted campaign request meets the requirement for at least one MNO, the Campaign is provisioned in TCR and the campaign registration fee will be charged to the customer account. The newly created campaign is assigned a 'campaign_id' in TCR. Additionally, the JSON response contains MNO metadata pertaining to the submitted campaign. Please refer to the response JSON data structure description for more information about MNO metadata. Standard use-case campaigns are approved upon submission while some special use-case campaigns require manual approval by MNOs. You can query for campaign MNO operation status via an API call to /campaign/operation/status. 

Example Success
1
{
2
code: 200,
3
status: "success",
4
data: {
5
      "campaign_id":"COWUSRK",
6
      "mno_metadata":{
7
         "10017":{
8
            "tpm_scope":"CAMPAIGN",
9
            "min_msg_samples":1,
10
            "msg_class":"E",
11
            "req_subscriber_optout":false,
12
            "mno_review":false,
13
            "no_embedded_phone":false,
14
            "mno":"AT&T",
15
            "tpm":240,
16
            "req_subscriber_help":true,
17
            "req_subscriber_optin":true,
18
            "mno_support":true,
19
            "no_embedded_link":false,
20
            "qualify":true
21
         },
22
         "10035":{
23
            "min_msg_samples":1,
24
            "req_subscriber_help":true,
25
            "req_subscriber_optout":false,
26
            "brand_daily_cap":2000,
27
            "req_subscriber_optin":true,
28
            "mno_review":false,
29
            "mno_support":true,
30
            "brand_tier":"LOW",
31
            "no_embedded_link":false,
32
            "no_embedded_phone":false,
33
            "qualify":true,
34
            "mno":"T-Mobile"
35
         }
36
      }
37
}
Copied!

Campaign Registry - Previous

Campaign - List

Next - Campaign Registry

Campaign - Update

Last modified 24d ago

Copy link

Contents

Example Success