10DLC
List 10DLC Campaigns
Returns a paginated list of 10DLC Campaigns for the authenticated account, filtered by date, status, and use case.
get/v3/10dlc/brands/campaigns
Query parameters
namestring
Example:Name
Filters Campaigns by name. Matches partial values.
usecasestring
Example:2FA
Filters Campaigns by use case.
statusstring
Example:APPROVED
Filters Campaigns by status.
mockboolean
Example:true
When true, returns only mock Campaigns used for testing. Default false.
created_beforestring date
Example:2024-08-22
Returns Campaigns created on or before this date, in YYYY-MM-DD format.
created_afterstring date
Example:2024-08-22
Returns Campaigns created on or after this date, in YYYY-MM-DD format.
pageinteger
Example:1
Page number to retrieve. Default 1.
per_pageinteger
Example:25
Number of records to return per page. Default 25.
Response
Returns a paginated list of 10DLC Campaigns.
Example response
{
"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
}
}