WAwavix
Voice campaigns

Trigger a scenario

Changed on

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

post/v1/voice-campaigns

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/voice-campaigns
  • Auth
    HTTP bearer

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"
  }
}

Changes

  • d4db3aae3627Revision changes
    • breaking

      the request's body type changed from no type to object

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status