List all 10DLC Campaigns associated with a Brand

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands/{brand_id}/campaigns?appid='

{
  "items": [
    {
      "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"
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

GET

10dlc

brands

{brand_id}

campaigns

List all 10DLC Campaigns associated with a Brand

curl --request GET \
  --url 'https://api.wavix.com/v1/10dlc/brands/{brand_id}/campaigns?appid='

{
  "items": [
    {
      "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"
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

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"

Query Parameters

name

string

Filter results by the Campaign name

Example:

"Name"

usecase

string

Filter results by the use case

Example:

"2FA"

status

string

Filter results by Campaign status

Example:

"APPROVED"

mock

boolean

default:false

Show only mock Campaigns

Example:

true

created_before

string<date>

Filter results by specifying the end date for the Campaign creation date range in the yyyy-mm-dd format

Example:

"2024-08-22T00:00:00.000Z"

created_after

string<date>

Filter results by specifying the start date for the Campaign creation date range in the yyyy-mm-dd format

Example:

"2024-08-22T00:00:00.000Z"

page

integer<int32>

The requested page

Example:

1

per_page

integer<int32>

The number of records per page

Example:

25

Response

A list of 10DLC Campaigns

items

10DLCCampaign · object[]

required

A paginated list of 10DLC Campaign matching the filter criteria

Show child attributes

items.affiliate_marketing

boolean

required

Indicates whether the Campaign is used for affiliate marketing

Example:

false

items.age_gated

boolean

required

Indicates whether the Campaign messages contain age-gated content

Example:

false

items.auto_renewal

boolean

required

Indicates whether the Campaign should be automatically renewed

Example:

true

items.last_bill_date

string

required

The date and time the Campaign was billed

Example:

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

items.next_bill_date

string

required

The date and time the Campaign will be billed next time

Example:

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

items.direct_lending

boolean

required

Indicates whether the Campaign messages contain direct lending content

Example:

true

items.embedded_links

boolean

required

Indicates whether the Campaign messages contain embedded links

Example:

true

items.embedded_phones

boolean

required

Indicates whether the Campaign messages contain embedded phone numbers

Example:

true

items.embedded_link_sample

string | null

required

An embedded link sample

items.brand_id

string

required

Unique identified of the Brand the Campaign is associated with

Example:

"BM20QP9"

items.campaign_id

string

required

Unique identified of the Campaign

Example:

"CKLCK95"

items.description

string

required

The Campaign description

Example:

"Our campaign aims to …"

items.optin_workflow

string

required

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

Example:

"Our SMS ..."

items.feedback

string | null

required

The feedback associated with the Campaign, if any

items.help

boolean

required

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

Example:

true

items.help_keywords

string

required

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

Example:

"help"

items.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."

items.optin

boolean

required

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

Example:

true

items.optin_keywords

string

required

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

Example:

"begin,start"

items.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"

items.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

items.optout_keywords

string

required

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

Example:

"stop,quit,unsubscribe"

items.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"

items.name

string

required

A user-defined Campaign name

Example:

"My first campaign"

items.created_at

string

required

Date and time the Campaign was created

Example:

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

items.sample1

string

required

Message sample

Example:

"Your verification code is XXXXXX"

items.sample2

string | null

required

Message sample

items.sample3

string | null

required

Message sample

items.sample4

string | null

required

Message sample

items.sample5

string | null

required

Message sample

items.updated_at

string

required

Date and time the Campaign was last updated

Example:

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

items.mock

boolean

required

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

Example:

false

items.usecase

string

required

The Campaign use case

Example:

"2FA"

items.monthly_fee

string

required

Monthly fee for the Campaign

Example:

"10.0"

items.terms_conditions

string

required

A link to the Campaign terms and conditions

Example:

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

items.status

string

required

The Campaign status

Example:

"APPROVED"

items.phone_numbers

string[]

required

A list of phone numbers associated with the Campaign

Example:

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

items.privacy_policy

string

A link to the Campaign privacy policy

Example:

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

pagination

Pagination · object

required

Pagination details

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

List all 10DLC Campaigns on your account

Using the APIs

API reference

List all 10DLC Campaigns associated with a Brand

Authorizations

Path Parameters

Query Parameters

Response