Register a 10DLC Campaign

curl --request POST \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": "https://site.com/verify",
  "embedded_links": false,
  "embedded_phones": false,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "mock": false,
  "name": "My first campaign",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": "Your code is XXXXXX, valid for 10 minutes",
  "sample4": "Use code XXXXXX to confirm your login",
  "sample5": "XXXXXX is your one-time passcode",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "usecase": "2FA"
}
'

import requests

url = "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns"

payload = {
    "affiliate_marketing": False,
    "age_gated": False,
    "auto_renewal": False,
    "description": "Our campaign aims to …",
    "direct_lending": False,
    "embedded_link_sample": "https://site.com/verify",
    "embedded_links": False,
    "embedded_phones": False,
    "help": True,
    "help_keywords": "help",
    "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
    "mock": False,
    "name": "My first campaign",
    "optin": True,
    "optin_keywords": "begin,start",
    "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
    "optin_workflow": "Our SMS ...",
    "optout": True,
    "optout_keywords": "stop,quit,unsubscribe",
    "optout_message": "You are now opted out and will receive no further messages",
    "privacy_policy": "https://site.com/privacy-policy",
    "sample1": "Your verification code is XXXXXX",
    "sample2": "XXXX is your verification code",
    "sample3": "Your code is XXXXXX, valid for 10 minutes",
    "sample4": "Use code XXXXXX to confirm your login",
    "sample5": "XXXXXX is your one-time passcode",
    "terms_conditions": "https://site.com/terms-and-conditions",
    "usecase": "2FA"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    affiliate_marketing: false,
    age_gated: false,
    auto_renewal: false,
    description: 'Our campaign aims to …',
    direct_lending: false,
    embedded_link_sample: 'https://site.com/verify',
    embedded_links: false,
    embedded_phones: false,
    help: true,
    help_keywords: 'help',
    help_message: 'For help, please visit www.site.com. To opt-out, reply STOP.',
    mock: false,
    name: 'My first campaign',
    optin: true,
    optin_keywords: 'begin,start',
    optin_message: 'You are now opted-in for help please reply HELP, to stop please reply STOP',
    optin_workflow: 'Our SMS ...',
    optout: true,
    optout_keywords: 'stop,quit,unsubscribe',
    optout_message: 'You are now opted out and will receive no further messages',
    privacy_policy: 'https://site.com/privacy-policy',
    sample1: 'Your verification code is XXXXXX',
    sample2: 'XXXX is your verification code',
    sample3: 'Your code is XXXXXX, valid for 10 minutes',
    sample4: 'Use code XXXXXX to confirm your login',
    sample5: 'XXXXXX is your one-time passcode',
    terms_conditions: 'https://site.com/terms-and-conditions',
    usecase: '2FA'
  })
};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'affiliate_marketing' => false,
    'age_gated' => false,
    'auto_renewal' => false,
    'description' => 'Our campaign aims to …',
    'direct_lending' => false,
    'embedded_link_sample' => 'https://site.com/verify',
    'embedded_links' => false,
    'embedded_phones' => false,
    'help' => true,
    'help_keywords' => 'help',
    'help_message' => 'For help, please visit www.site.com. To opt-out, reply STOP.',
    'mock' => false,
    'name' => 'My first campaign',
    'optin' => true,
    'optin_keywords' => 'begin,start',
    'optin_message' => 'You are now opted-in for help please reply HELP, to stop please reply STOP',
    'optin_workflow' => 'Our SMS ...',
    'optout' => true,
    'optout_keywords' => 'stop,quit,unsubscribe',
    'optout_message' => 'You are now opted out and will receive no further messages',
    'privacy_policy' => 'https://site.com/privacy-policy',
    'sample1' => 'Your verification code is XXXXXX',
    'sample2' => 'XXXX is your verification code',
    'sample3' => 'Your code is XXXXXX, valid for 10 minutes',
    'sample4' => 'Use code XXXXXX to confirm your login',
    'sample5' => 'XXXXXX is your one-time passcode',
    'terms_conditions' => 'https://site.com/terms-and-conditions',
    'usecase' => '2FA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns"

	payload := strings.NewReader("{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}"

response = http.request(request)
puts response.read_body

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "brand_id": "BM20QP9",
  "campaign_id": "CKLCK95",
  "created_at": "2024-08-14T11:57:41",
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": null,
  "embedded_links": false,
  "embedded_phones": false,
  "feedback": null,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "last_bill_date": "2024-08-14T11:57:42",
  "mock": false,
  "monthly_fee": "10.0",
  "name": "My first campaign",
  "next_bill_date": "2024-11-14T00:00:00",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": null,
  "sample4": null,
  "sample5": null,
  "status": "APPROVED",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "updated_at": "2024-08-14T11:57:47",
  "usecase": "2FA",
  "phone_numbers": []
}

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "Request failed. The feature is disabled for the account."
}

{
  "success": false,
  "message": "Request failed. The Brand is not found."
}

POST

10dlc

brands

{brand_id}

campaigns

curl --request POST \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": "https://site.com/verify",
  "embedded_links": false,
  "embedded_phones": false,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "mock": false,
  "name": "My first campaign",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": "Your code is XXXXXX, valid for 10 minutes",
  "sample4": "Use code XXXXXX to confirm your login",
  "sample5": "XXXXXX is your one-time passcode",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "usecase": "2FA"
}
'

import requests

url = "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns"

payload = {
    "affiliate_marketing": False,
    "age_gated": False,
    "auto_renewal": False,
    "description": "Our campaign aims to …",
    "direct_lending": False,
    "embedded_link_sample": "https://site.com/verify",
    "embedded_links": False,
    "embedded_phones": False,
    "help": True,
    "help_keywords": "help",
    "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
    "mock": False,
    "name": "My first campaign",
    "optin": True,
    "optin_keywords": "begin,start",
    "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
    "optin_workflow": "Our SMS ...",
    "optout": True,
    "optout_keywords": "stop,quit,unsubscribe",
    "optout_message": "You are now opted out and will receive no further messages",
    "privacy_policy": "https://site.com/privacy-policy",
    "sample1": "Your verification code is XXXXXX",
    "sample2": "XXXX is your verification code",
    "sample3": "Your code is XXXXXX, valid for 10 minutes",
    "sample4": "Use code XXXXXX to confirm your login",
    "sample5": "XXXXXX is your one-time passcode",
    "terms_conditions": "https://site.com/terms-and-conditions",
    "usecase": "2FA"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    affiliate_marketing: false,
    age_gated: false,
    auto_renewal: false,
    description: 'Our campaign aims to …',
    direct_lending: false,
    embedded_link_sample: 'https://site.com/verify',
    embedded_links: false,
    embedded_phones: false,
    help: true,
    help_keywords: 'help',
    help_message: 'For help, please visit www.site.com. To opt-out, reply STOP.',
    mock: false,
    name: 'My first campaign',
    optin: true,
    optin_keywords: 'begin,start',
    optin_message: 'You are now opted-in for help please reply HELP, to stop please reply STOP',
    optin_workflow: 'Our SMS ...',
    optout: true,
    optout_keywords: 'stop,quit,unsubscribe',
    optout_message: 'You are now opted out and will receive no further messages',
    privacy_policy: 'https://site.com/privacy-policy',
    sample1: 'Your verification code is XXXXXX',
    sample2: 'XXXX is your verification code',
    sample3: 'Your code is XXXXXX, valid for 10 minutes',
    sample4: 'Use code XXXXXX to confirm your login',
    sample5: 'XXXXXX is your one-time passcode',
    terms_conditions: 'https://site.com/terms-and-conditions',
    usecase: '2FA'
  })
};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'affiliate_marketing' => false,
    'age_gated' => false,
    'auto_renewal' => false,
    'description' => 'Our campaign aims to …',
    'direct_lending' => false,
    'embedded_link_sample' => 'https://site.com/verify',
    'embedded_links' => false,
    'embedded_phones' => false,
    'help' => true,
    'help_keywords' => 'help',
    'help_message' => 'For help, please visit www.site.com. To opt-out, reply STOP.',
    'mock' => false,
    'name' => 'My first campaign',
    'optin' => true,
    'optin_keywords' => 'begin,start',
    'optin_message' => 'You are now opted-in for help please reply HELP, to stop please reply STOP',
    'optin_workflow' => 'Our SMS ...',
    'optout' => true,
    'optout_keywords' => 'stop,quit,unsubscribe',
    'optout_message' => 'You are now opted out and will receive no further messages',
    'privacy_policy' => 'https://site.com/privacy-policy',
    'sample1' => 'Your verification code is XXXXXX',
    'sample2' => 'XXXX is your verification code',
    'sample3' => 'Your code is XXXXXX, valid for 10 minutes',
    'sample4' => 'Use code XXXXXX to confirm your login',
    'sample5' => 'XXXXXX is your one-time passcode',
    'terms_conditions' => 'https://site.com/terms-and-conditions',
    'usecase' => '2FA'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns"

	payload := strings.NewReader("{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"affiliate_marketing\": false,\n  \"age_gated\": false,\n  \"auto_renewal\": false,\n  \"description\": \"Our campaign aims to …\",\n  \"direct_lending\": false,\n  \"embedded_link_sample\": \"https://site.com/verify\",\n  \"embedded_links\": false,\n  \"embedded_phones\": false,\n  \"help\": true,\n  \"help_keywords\": \"help\",\n  \"help_message\": \"For help, please visit www.site.com. To opt-out, reply STOP.\",\n  \"mock\": false,\n  \"name\": \"My first campaign\",\n  \"optin\": true,\n  \"optin_keywords\": \"begin,start\",\n  \"optin_message\": \"You are now opted-in for help please reply HELP, to stop please reply STOP\",\n  \"optin_workflow\": \"Our SMS ...\",\n  \"optout\": true,\n  \"optout_keywords\": \"stop,quit,unsubscribe\",\n  \"optout_message\": \"You are now opted out and will receive no further messages\",\n  \"privacy_policy\": \"https://site.com/privacy-policy\",\n  \"sample1\": \"Your verification code is XXXXXX\",\n  \"sample2\": \"XXXX is your verification code\",\n  \"sample3\": \"Your code is XXXXXX, valid for 10 minutes\",\n  \"sample4\": \"Use code XXXXXX to confirm your login\",\n  \"sample5\": \"XXXXXX is your one-time passcode\",\n  \"terms_conditions\": \"https://site.com/terms-and-conditions\",\n  \"usecase\": \"2FA\"\n}"

response = http.request(request)
puts response.read_body

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "brand_id": "BM20QP9",
  "campaign_id": "CKLCK95",
  "created_at": "2024-08-14T11:57:41",
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": null,
  "embedded_links": false,
  "embedded_phones": false,
  "feedback": null,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "last_bill_date": "2024-08-14T11:57:42",
  "mock": false,
  "monthly_fee": "10.0",
  "name": "My first campaign",
  "next_bill_date": "2024-11-14T00:00:00",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": null,
  "sample4": null,
  "sample5": null,
  "status": "APPROVED",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "updated_at": "2024-08-14T11:57:47",
  "usecase": "2FA",
  "phone_numbers": []
}

{
  "success": false,
  "message": "Missing or invalid parameter <param_name>"
}

{
  "success": false,
  "message": "Request failed. The feature is disabled for the account."
}

{
  "success": false,
  "message": "Request failed. The Brand is not found."
}

Authorizations

Authorization

string

header

required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

brand_id

string

required

The unique ID of the 10DLC Brand.

Example:

"BM20QP9"

Body

application/json

Attributes for the new 10DLC Campaign.

affiliate_marketing

boolean

required

Indicates whether the Campaign is used for affiliate marketing.

Example:

false

age_gated

boolean

required

Indicates whether the Campaign messages contain age-gated content.

Example:

false

auto_renewal

boolean

required

Indicates whether the Campaign is automatically renewed at the end of each billing period.

Example:

true

direct_lending

boolean

required

Indicates whether the Campaign messages contain direct lending content.

Example:

true

embedded_links

boolean

required

Indicates whether the Campaign messages contain embedded links.

Example:

true

embedded_phones

boolean | null

required

Indicates whether the Campaign messages contain embedded phone numbers.

Example:

true

embedded_link_sample

string | null

required

Sample of an embedded link used in Campaign messages.

description

string

required

Description of the Campaign and its messaging purpose.

Example:

"Our campaign aims to …"

optin_workflow

string

required

Description of the workflow through which subscribers opt in to the Campaign.

Example:

"Our SMS ..."

help

boolean

required

Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword such as HELP or INFO.

Example:

true

help_keywords

string

required

Comma-separated list of help keywords. Keywords are case-insensitive.

Example:

"help"

help_message

string

required

Acknowledgement sent when a subscriber texts a help keyword.

Example:

"For help, please visit www.site.com. To opt out, reply STOP."

optin

boolean

required

Indicates whether the Campaign requires subscribers to opt in before receiving messages.

Example:

true

optin_keywords

string

required

Comma-separated list of opt-in keywords. Keywords are case-insensitive.

Example:

"begin,start"

optin_message

string

required

Acknowledgement sent when a subscriber texts an opt-in keyword.

Example:

"You are now opted-in for help please reply HELP, to stop please reply STOP"

optout

boolean

required

Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword such as STOP or QUIT.

Example:

true

optout_keywords

string

required

Comma-separated list of opt-out keywords. Keywords are case-insensitive.

Example:

"stop,quit,unsubscribe"

optout_message

string

required

Acknowledgement sent when a subscriber texts an opt-out keyword.

Example:

"You are now opted out and will receive no further messages"

name

string

required

Display name of the Campaign.

Example:

"My first campaign"

sample1

string

required

Sample message demonstrating the content sent through the Campaign.

Example:

"Your verification code is XXXXXX"

sample2

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample3

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample4

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample5

string | null

required

Sample message demonstrating the content sent through the Campaign.

mock

boolean

required

Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.

Example:

false

usecase

string

required

Registered use case for the Campaign, such as 2FA or MARKETING.

Example:

"2FA"

terms_conditions

string

required

URL of the Campaign terms and conditions.

Example:

"https://site.com/terms-and-conditions"

privacy_policy

string

URL of the Campaign privacy policy.

Example:

"https://site.com/privacy-policy"

Response

Returns the registered 10DLC Campaign.

Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic.

affiliate_marketing

boolean

required

Indicates whether the Campaign is used for affiliate marketing.

Example:

false

age_gated

boolean

required

Indicates whether the Campaign messages contain age-gated content.

Example:

false

auto_renewal

boolean

required

Indicates whether the Campaign should be automatically renewed.

Example:

true

last_bill_date

string | null

required

Date and time the Campaign was last billed in ISO 8601 format. null if the Campaign has never been billed.

Example:

"2024-08-14T11:57:42"

next_bill_date

string | null

required

Date and time the Campaign will be billed next in ISO 8601 format. null if the next billing date is not scheduled.

Example:

"2024-08-14T11:57:42"

direct_lending

boolean

required

Indicates whether the Campaign messages contain direct lending content.

Example:

true

embedded_links

boolean

required

Indicates whether the Campaign messages contain embedded links.

Example:

true

embedded_phones

boolean

required

Indicates whether the Campaign messages contain embedded phone numbers.

Example:

true

embedded_link_sample

string | null

required

Sample of an embedded link used in Campaign messages.

brand_id

string

required

Unique identifier of the Brand that owns the Campaign.

Example:

"BM20QP9"

campaign_id

string

required

Unique identifier of the Campaign assigned by the registry.

Example:

"CKLCK95"

description

string | null

required

Description of the Campaign and its messaging purpose.

Example:

"Our campaign aims to …"

optin_workflow

string | null

required

Description of the workflow through which subscribers opt in to the Campaign.

Example:

"Our SMS ..."

feedback

string | null

required

Feedback from the registry explaining the current status.

help

boolean

required

Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).

Example:

true

help_keywords

string

required

Comma-separated list of help keywords. Keywords are case-insensitive.

Example:

"help"

help_message

string | null

required

Help message sent upon receiving a help keyword.

Example:

"For help, please visit www.site.com. To opt out, reply STOP."

optin

boolean

required

Indicates whether the Campaign requires subscriber opt-in.

Example:

true

optin_keywords

string

required

Comma-separated list of opt-in keywords. Keywords are case-insensitive.

Example:

"begin,start"

optin_message

string | null

required

Opt-in message sent upon receiving an opt-in keyword.

Example:

"You are now opted-in for help please reply HELP, to stop please reply STOP"

optout

boolean

required

Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).

Example:

true

optout_keywords

string

required

Comma-separated list of opt-out keywords. Keywords are case-insensitive.

Example:

"stop,quit,unsubscribe"

optout_message

string | null

required

Opt-out message sent upon receiving an opt-out keyword.

Example:

"You are now opted out and will receive no further messages"

name

string

required

Display name of the Campaign.

Example:

"My first campaign"

created_at

string

required

Timestamp when the Campaign was created, in ISO 8601 format.

Example:

"2024-08-14T11:57:41"

sample1

string | null

required

Sample message demonstrating the content sent through the Campaign.

Example:

"Your verification code is XXXXXX"

sample2

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample3

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample4

string | null

required

Sample message demonstrating the content sent through the Campaign.

sample5

string | null

required

Sample message demonstrating the content sent through the Campaign.

updated_at

string

required

Timestamp when the Campaign was last updated, in ISO 8601 format.

Example:

"2024-08-14T11:57:47"

mock

boolean

required

Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.

Example:

false

usecase

string

required

Registered use case for the Campaign, such as 2FA or MARKETING.

Example:

"2FA"

monthly_fee

string

required

Recurring monthly fee charged for the Campaign, as a decimal string.

Example:

"10.0"

privacy_policy

string | null

required

Example:

"https://site.com/privacy-policy"

terms_conditions

string | null

required

Terms and conditions URL.

Example:

"https://site.com/terms-and-conditions"

status

string

required

Current registration status of the Campaign, such as APPROVED or PENDING.

Example:

"APPROVED"

phone_numbers

string[]

required

Phone numbers assigned to the Campaign, in E.164 format.

Example:

["14358684439", "13193337776", "12673296046"]

List Brand Campaigns

Retrieve a 10DLC Campaign

⌘I

Using the APIs

API reference

WebSocket protocol

Register a 10DLC Campaign

Authorizations

Path Parameters

Body

Response