Get campaign description

This API is used to fetch all configured campaign settings and values, including its status, dialer parameters, and agent group assignments.

Prerequisites

You must have access to your contact center API key.
You must know the campaign ID of the campaign you wish to retrieve.

Endpoint

GET /api/v1/campaigns/{campaign_id}

Path parameters

Parameter	Description	Type	Required
`campaign_id`	The numeric ID of the campaign to retrieve.	number	Yes

Authentication

This endpoint requires authentication using the Call Center Bearer Token. The token must be included in the request header:

Authorization: Bearer {callcenter_token}

Response

Returns the complete configuration and status of the specified campaign.

Field	Description	Type
`id`	Unique campaign ID.	number
`name`	Name of the campaign.	string
`status`	Current status of the campaign (`active`, `paused`, `completed`, etc.).	string
`dialer_mode`	Dialer mode used for the campaign.	string
`assigned_agent_group_ids`	List of agent group IDs assigned to the campaign.	array
`start_time`	Timestamp indicating when the campaign starts.	string (ISO 8601)
`end_time`	Timestamp indicating when the campaign ends.	string (ISO 8601)
`timezone`	Timezone of the campaign’s schedule.	string
`max_attempts`	Maximum number of contact attempts per number.	number
`caller_id`	Caller ID used for outbound dialing.	string
`wrapup_time`	Configured wrap-up time between calls, in seconds.	number
`retry_strategy`	Strategy used to retry failed calls.	object
`created_at`	Timestamp of when the campaign was created.	string
`updated_at`	Timestamp of the last update to the campaign.	string

The full structure of the response may vary depending on the dialer mode or campaign type.

Response example

{
  "id": 12345,
  "name": "Product Launch Follow-up",
  "status": "active",
  "dialer_mode": "predictive",
  "assigned_agent_group_ids": [3, 7],
  "start_time": "2024-10-01T09:00:00Z",
  "end_time": "2024-10-05T17:00:00Z",
  "timezone": "America/New_York",
  "max_attempts": 3,
  "caller_id": "15551234567",
  "wrapup_time": 30,
  "retry_strategy": {
    "delay_seconds": 60,
    "max_retries": 2
  },
  "created_at": "2024-09-28T15:22:10Z",
  "updated_at": "2024-10-01T08:59:00Z"
}

Errors

Code	Message	Description
401	`Unauthorized`	Missing or invalid bearer token.
404	`Campaign not found`	No campaign exists with the specified ID.