Campaigns
Get Campaigns
Campaigns
Get Campaigns
Get a list of campaigns
GET
/
campaigns
curl --request GET \
--url https://my.cald.ai/client/api/v1/campaigns \
--header 'Authorization: <api-key>'
{
"campaigns": [
{
"campaignId": "<string>",
"name": "<string>",
"listId": "<string>",
"agentId": "<string>",
"status": "<string>",
"stats": {
"totalCalls": 123,
"completedCalls": 123,
"failedCalls": 123,
"pendingCalls": 123,
"pickedUpCalls": 123,
"ivrCalls": 123,
"voicemailCalls": 123,
"unansweredCalls": 123,
"disconnectedCalls": 123
}
}
]
}
Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Response
200 - application/json
List of available campaigns
The campaign ID of the campaign
The name given to the campaign in the MyCald Dashboard
The list ID of the list used for the campaign
The agent ID of the agent used for the campaign
The status of the campaign, can be pending
, active
, not_funded
, finished
, cancelled
Total number of calls in the campaign
Number of calls that have been completed
Number of calls that have failed
Number of calls that are pending
Number of calls that have been picked up
Number of calls that have been answered by an IVR
Number of calls that have been answered by a voicemail
Number of calls that have been unanswered
Number of calls that have been disconnected
curl --request GET \
--url https://my.cald.ai/client/api/v1/campaigns \
--header 'Authorization: <api-key>'
{
"campaigns": [
{
"campaignId": "<string>",
"name": "<string>",
"listId": "<string>",
"agentId": "<string>",
"status": "<string>",
"stats": {
"totalCalls": 123,
"completedCalls": 123,
"failedCalls": 123,
"pendingCalls": 123,
"pickedUpCalls": 123,
"ivrCalls": 123,
"voicemailCalls": 123,
"unansweredCalls": 123,
"disconnectedCalls": 123
}
}
]
}