Campaign
List Campaigns
Retrieve a list of campaigns associated with a supplied brandId.
get/10dlc/campaign
Query parameters
brandIdstring required
Filter results by brand id.
pageinteger
The 1-indexed page number to get. The default value is 1.
The 1-indexed page number to get. The default value is 1.
recordsPerPageinteger
The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.
The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.
sort'assignedPhoneNumbersCount' | '-assignedPhoneNumbersCount' | 'campaignId' | '-campaignId' | 'createdAt' | '-createdAt' | 'status' | '-status' | 'tcrCampaignId' | '-tcrCampaignId'
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
Response
Successful Response
Example response
{
"records": [
{
"assignedPhoneNumbersCount": 3,
"brandDisplayName": "ABC Mobile",
"brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
"campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
"campaignStatus": "TCR_ACCEPTED",
"tcrBrandId": "BBRAND1",
"tcrCampaignId": "CCAMP1",
"webhookFailoverURL": "https://example.com/failover-webhook",
"webhookURL": "https://example.com/webhook"
}
]
}