v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
Voice campaigns

Trigger a scenario

Launches a voice campaign that places an outbound call using a pre-configured scenario. Track progress with the returned voice campaign id.

post/v1/voice-campaigns

Request body

Example request

{
  "voice_campaign": {
    "callflow_id": 3212,
    "caller_id": "13123310912",
    "contact": "16729923812",
    "callback_url": "https://you-site.com/webhook"
  }
}

Response

Returns the launched voice campaign.

Example response

{
  "voice_campaign": {
    "id": 2321423,
    "status": "in_progress",
    "timestamp": "2023-08-03T09:04:12.000Z",
    "caller_id": "13123310912",
    "contact": "16729923812"
  }
}