Wavix Docs | Tutorials, How-to Guides, API Reference

Query a specific 10DLC Campaign

curl --request GET \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "brand_id": "BM20QP9",
  "campaign_id": "CKLCK95",
  "created_at": "2024-08-14T11:57:41.000Z",
  "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.000Z",
  "mock": false,
  "monthly_fee": "10.0",
  "name": "My first campaign",
  "next_bill_date": "2024-11-14T00:00:00.000Z",
  "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.000Z",
  "usecase": "2FA",
  "phone_numbers": [
    "14358684439",
    "13193337776",
    "12673296046"
  ]
}

GET

10dlc

brands

{brand_id}

campaigns

{campaign_id}

Query a specific 10DLC Campaign

curl --request GET \
  --url https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns/{campaign_id}

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "brand_id": "BM20QP9",
  "campaign_id": "CKLCK95",
  "created_at": "2024-08-14T11:57:41.000Z",
  "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.000Z",
  "mock": false,
  "monthly_fee": "10.0",
  "name": "My first campaign",
  "next_bill_date": "2024-11-14T00:00:00.000Z",
  "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.000Z",
  "usecase": "2FA",
  "phone_numbers": [
    "14358684439",
    "13193337776",
    "12673296046"
  ]
}

Authorizations

appid

string

query

required

An API key to authorize your request

Path Parameters

brand_id

string

required

Unique identifier of a Brand

Example:

"BM20QP9"

campaign_id

string

required

Unique identifier of a Campaign

Example:

"CKLCK95"

Response

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<date-time>

required

The date and time the Campaign was billed

Example:

"2024-08-14T11:57:42.000Z"

next_bill_date

string<date-time>

required

The date and time the Campaign will be billed next time

Example:

"2024-08-14T11:57:42.000Z"

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

An embedded link sample

brand_id

string

required

Unique identified of the Brand the Campaign is associated with

Example:

"BM20QP9"

campaign_id

string

required

Unique identified of the Campaign

Example:

"CKLCK95"

description

string

required

The Campaign description

Example:

"Our campaign aims to …"

optin_workflow

string

required

The opt-in workflow - the process through which consumers opt-in to the Campaign

Example:

"Our SMS ..."

feedback

string | null

required

The feedback associated with the Campaign, if any

help

boolean

required

Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not.

Example:

true

help_keywords

string

required

A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.

Example:

"help"

help_message

string

required

An acknowledgement to be sent when a HELP keyword is received

Example:

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

optin

boolean

required

Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not.

Example:

true

optin_keywords

string

required

A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.

Example:

"begin,start"

optin_message

string

required

An acknowledgement to be sent when an OPT-IN keyword is received

Example:

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

optout

boolean

required

Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not.

Example:

true

optout_keywords

string

required

A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.

Example:

"stop,quit,unsubscribe"

optout_message

string

required

An acknowledgement to be sent when an OPT-OUT keyword is received

Example:

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

name

string

required

A user-defined Campaign name

Example:

"My first campaign"

created_at

string<date-time>

required

Date and time the Campaign was created

Example:

"2024-08-14T11:57:41.000Z"

sample1

string

required

Message sample

Example:

"Your verification code is XXXXXX"

sample2

string | null

required

Message sample

sample3

string | null

required

Message sample

sample4

string | null

required

Message sample

sample5

string | null

required

Message sample

updated_at

string<date-time>

required

Date and time the Campaign was last updated

Example:

"2024-08-14T11:57:47.000Z"

mock

boolean

required

Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic

Example:

false

usecase

string

required

The Campaign use case

Example:

"2FA"

monthly_fee

string

required

Monthly fee for the Campaign

Example:

"10.0"

terms_conditions

string

required

A link to the Campaign terms and conditions

Example:

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

status

string

required

The Campaign status

Example:

"APPROVED"

phone_numbers

string[]

required

A list of phone numbers associated with the Campaign

Example:

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

privacy_policy

string

A link to the Campaign privacy policy

Example:

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

Update a 10DLC Campaign

⌘I

Using the APIs

API reference

Query a specific 10DLC Campaign

Authorizations

Path Parameters

Response