Skip to main content
GET
/
v3
/
10dlc
/
brands
/
{brand_id}
/
campaigns
List Brand Campaigns
curl --request GET \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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"
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

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"

Query Parameters

​
name
string

Filters Campaigns by name. Matches partial values.

Example:

"Name"

​
usecase
string

Filters Campaigns by use case.

Example:

"2FA"

​
status
string

Filters Campaigns by status.

Example:

"APPROVED"

​
mock
boolean
default:false

When true, returns only mock Campaigns used for testing. Default false.

Example:

true

​
created_before
string<date>

Returns Campaigns created on or before this date, in YYYY-MM-DD format.

Example:

"2024-08-22"

​
created_after
string<date>

Returns Campaigns created on or after this date, in YYYY-MM-DD format.

Example:

"2024-08-22"

​
page
integer<int32>

Page number to retrieve. Default 1.

Example:

1

​
per_page
integer<int32>

Number of records to return per page. Default 25.

Example:

25

Response

Returns a paginated list of 10DLC Campaigns.

Paginated list of 10DLC Campaigns.

​
items
TenDLCCampaign · object[]
required

10DLC Campaigns on the current page that match the filter criteria.

​
pagination
Pagination · object
required

Pagination metadata for the result set.