Skip to main content
Wavix Campaign Builder lets you create custom flows for outbound calls using an intuitive, drag-and-drop interface. With the Wavix Campaign Builder API, you can trigger automatic calls programmed to follow a specific scenario.
The Wavix Campaign Builder API is available exclusively for Flex Pro users.

​
Prerequisites

Before you can access the Wavix Campaign Builder API, you need to sign up for Wavix.

​
Create a Wavix account

  1. Sign up for a Wavix account using your business email address.
  2. Confirm your email address and phone number during the sign-up process.
  3. Wait for your account to be approved by the Wavix team.
  4. After approval, choose either the Wavix Flex or Flex Pro account level.
Once your account is approved, you can access the Wavix app and APIs.

​
Find your API key

Wavix uses API keys to authenticate requests. To find API keys associated with your account:
  1. Sign in to your Wavix account.
  2. Go to Administration → API Keys.
  3. Copy the API key you want to use, or create a new one by clicking Create new.

​
How to launch a campaign

Before placing an automatic call, sign in to your Wavix account and create a Call Flow using the app at https://app.wavix.com/calling/flows. Once the Call Flow is approved, you can use it with the Wavix Campaign Builder API. To launch a call, get the Call Flow’s unique identifier:
  1. Go to https://app.wavix.com/calling/flows.
  2. Find the approved Call Flow you want to launch.
  3. The Call Flow ID appears in the ID column.
To trigger a call, use the following method: 
POST https://api.wavix.com/v1/voice-campaigns?appid=your_api_key
Request body example: 
{
    "voice_campaign": {
        "callflow_id": callflow_id,
        "contact": "contact",
        "caller_id": "caller_id"
    }
}
  • callflow_id - the unique identifier of the Call Flow to launch
  • contact - a phone number in E.164 format, with or without the leading “+”
  • caller_id - an active phone number on your Wavix account. This number will be used as the Caller ID
All parameters are required. If successful, the service returns HTTP 201 Created. The response body contains the placed call details. 
{
   "voice_campaign": {
       "id": 1,
       "caller_id": "4420xxxxxxxx",
       "contact": "4477xxxxxxxx",
       "status": "in_progress",
       "timestamp": "2021-12-09T09:47:18Z"
   }
}
After the call is completed, you can query its details using the Wavix CDR API.
⌘I