The Get campaign endpoint returns detailed information about a specific Dialer campaign.

Requirements: Base URL, Authentication, Error codes

Scope: campaigns.read

What this does

When you send a Get campaign request with a campaign ID, Voiso returns the campaign object.

You can get the campaign ID from the Campaigns page in Voiso, or by using the Get list of campaigns endpoint.

Endpoint


GET /api/v4/campaigns/{campaign_id}

Path parameters

campaign_id
The unique identifier of the campaign.

Example request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/campaigns/3" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a campaign object.

{
  "campaign": {
    "id": 3,
    "name": "Summer Outreach Campaign",
    "status": "active",
    "strategy": "simple",
    "dial_level": 1
  }
}

Campaign fields shown above come from the Campaign schema: id, name, status, strategy, and dial_level.

Notes

status values include: draft, active, paused, stopping, completed, processing, stopped, auto_paused, pausing, auto_pausing, import_error.
strategy values include simple and predictive_ai.

Troubleshooting

401 Unauthorized

Returned if the API key is missing or invalid.

403 Forbidden

Returned if the API key does not have access to campaign resources.

404 Not found

Returned if the campaign ID does not exist or is not accessible.

429 Too many requests

Returned if requests are rate limited.

200OK

401Unauthorized

403Forbidden

404Not found

429Too many requests