Overview
Telecom Lookup Tools
Campaign - Create

Full Url

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!
Last modified 24d ago