Get campaign
Returns one campaign with its agent, calling window, status and statistics. status tells whether it is running, paused or completed; when the platform paused it, paused_reason says why. For a campaign created in the app without declaring where the right to call comes from, contact_origin is null and the campaign cannot be started through the API. Required scope: campaigns:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.
Authentication
Path parameters
Id of the campaign, as returned by POST /campaigns or GET /campaigns.
Headers
API version for this request; defaults to the version the key is pinned to.
Response
Always campaign.
Id of the campaign: use it in GET /campaigns/{campaign_id} and in the other campaign operations.
draft: created and not started yet. running: the campaign is calling its contacts. paused: stopped, it can be started again with POST /campaigns/{campaign_id}/start. completed: finished, it cannot be started or paused again. simulated: only with a test key, nothing was changed.
Set when the platform, and not you, paused the campaign; null otherwise. feature_not_available: the platform paused the campaign because the plan no longer includes outbound campaigns. agent_suspended: the agent was suspended; resuming it restarts the campaign.
The declaration made when the campaign was created; null for a campaign created in the app without one (it cannot be started through the API).
true with a test key: the operation was only checked and nothing was changed. After POST /campaigns with a test key the id does not exist.