Retrieve a 10DLC Campaign

curl --request GET \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}', 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/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": [
    "14358684439",
    "13193337776",
    "12673296046"
  ]
}

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

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

GET

10dlc

brands

{brand_id}

campaigns

{campaign_id}

Retrieve a 10DLC Campaign

curl --request GET \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}', 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/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": [
    "14358684439",
    "13193337776",
    "12673296046"
  ]
}

{
  "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"

campaign_id

string

required

The unique ID of the 10DLC Campaign.

Example:

"CKLCK95"

Response

Returns the 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