POST
/
v1
/
voice-campaigns
Trigger a scenario
curl --request POST \
  --url https://api.wavix.com/v1/voice-campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voice_campaign": {
    "callflow_id": 3212,
    "caller_id": "13123310912",
    "contact": "16729923812",
    "callback_url": "https://you-site.com/webhook"
  }
}
'
{
  "voice_campaign": {
    "id": 2321423,
    "status": "status",
    "timestamp": "2023-06-15T10:30:00Z",
    "caller_id": "org_123",
    "contact": "contact"
  }
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

Attributes for the new voice campaign.

Scenario and contact details for the campaign.

​
voice_campaign
VoiceCampaignResponse · object
required

Represents a voice campaign that places an outbound call running a pre-approved call flow.

Response

Returns the launched voice campaign.

​
voice_campaign
object