Trigger a scenario

curl --request POST \
  --url 'https://api.wavix.com/v1/voice-campaigns?appid=' \
  --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": "in_progress",
    "timestamp": "2023-08-03T09:04:12.000Z",
    "caller_id": "13123310912",
    "contact": "16729923812"
  }
}

POST

voice-campaigns

Trigger a scenario

curl --request POST \
  --url 'https://api.wavix.com/v1/voice-campaigns?appid=' \
  --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": "in_progress",
    "timestamp": "2023-08-03T09:04:12.000Z",
    "caller_id": "13123310912",
    "contact": "16729923812"
  }
}

Authorizations

appid

string

query

required

An API key to authorize your request

Body

application/json

Trigger an automatic call request

voice_campaign

VoiceCampaign · object

required

Show child attributes

voice_campaign.callflow_id

integer<int32>

required

Unique identifier of the Call flow to be launched. You can find it on the Calls flows page. Note that every scenario must be pre-approved by the Wavix Service Operations team before it can be used in production.

Example:

3212

voice_campaign.caller_id

string

required

A phone number on your Wavix account. Will be used as Caller ID when placing an outbound call.

Example:

"13123310912"

voice_campaign.contact

string

required

A phone number to place an outbound the call to

Example:

"16729923812"

voice_campaign.callback_url

string

A webhook URL to receive campaign status updates

Example:

"https://you-site.com/webhook"

Response

A launched voice campaign object

voice_campaign

object

Show child attributes

voice_campaign.id

integer

Unique identifier of the voice campaign

Example:

2321423

voice_campaign.status

string

The status of the voice campaign

Example:

"in_progress"

voice_campaign.timestamp

string<date-time>

The timestamp when the voice campaign was created

Example:

"2023-08-03T09:04:12.000Z"

voice_campaign.caller_id

string

The caller ID used for the voice campaign

Example:

"13123310912"

voice_campaign.contact

string

The number called using the voice campaign

Example:

"16729923812"

Get asynchronous validation results

Get a specific voice campaign

Using the APIs

API reference

Trigger a scenario

Authorizations

Body

Response