List_campaigns
- 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
List_campaigns
- Updated on 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/dialer/v1/campaigns
Returns a list of all callcenter campaigns data based on callcenter API key.
Header parameters
Authorization: Bearer token
stringRequired
Contact center API key
Query parameters
filter[name]
string
One of campaigns name
Examplecampaign name
filter[strategy]
string
Campaign strategy (simple, advanced, predictive_ai)
Exampleadvanced
filter[status]
string
Campaign status (draft, active, paused, stopping, completed, processing, stopped, auto_paused, pausing, auto_pausing, import_error)
Exampleactive
filter[method]
string
Campaign method of numbers uploading (csv, bitrix_crm, dynamics_crm, falcon_crm, hubspot_crm, panda_crm, popcorn_crm, proftit_crm, puma_crm, salesforce_crm, zoho_crm)
Examplecsv
filter[live]
boolean
Is campaign live?
ExampleFalse
Responses
200
Success
object
campaigns
Array of object (campaign)
object
id
integer
Campaign ID
Example1
name
string
campaign name
Exampletest dialer campaign
status
string
campaign status
Exampleactive
strategy
string
campaign strategy
Examplesimple
method
string
campaign import method, CSV file or specific CRM
Examplecsv
created_at
string
campaign created at at specific format
Example2023-07-24T15:44:47.465Z
live
boolean
campaign live or not
ExampleTrue
metadata
object (offset_based_pagination_metadata)
limit
integer
The number of results
Example25
offset
integer
The number of records that need to be skipped
Example0
total
integer
The total count of items
Example10
400
Invalid parameters
Invalid or nonexistent Callcenter API Key
{
"error": "The API key specified is invalid"
}Invalid campaign strategy
{
"errors": {
"strategy": "is not included in the list (simple, advanced, and predictive_ai)"
}
}Invalid campaign status
{
"errors": {
"status": "is not included in the list (draft, active, paused, stopping, completed, processing, stopped, auto_paused, pausing, auto_pausing, and import_error)"
}
}Invalid campaign method
{
"errors": {
"method": "is not included in the list (csv, bitrix_crm, dynamics_crm, falcon_crm, hubspot_crm, panda_crm, popcorn_crm, proftit_crm, puma_crm, salesforce_crm, and zoho_crm)"
}
}Invalid live option
{
"errors": {
"strategy": "must be a boolean"
}
}Was this article helpful?
