Create a campaign
curl --request POST \
--url https://api.wave.sa/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"callflow_name": "<string>",
"recipients": [
{
"phone": "<string>",
"reference": "<string>"
}
],
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"max_attempts": 3,
"retry_after_minutes": 30,
"max_concurrent": 2,
"voicemail_message": {
"type": "play",
"url": "<string>"
}
}
'import requests
url = "https://api.wave.sa/v1/campaigns"
payload = {
"name": "<string>",
"callflow_name": "<string>",
"recipients": [
{
"phone": "<string>",
"reference": "<string>"
}
],
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"max_attempts": 3,
"retry_after_minutes": 30,
"max_concurrent": 2,
"voicemail_message": {
"type": "play",
"url": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
callflow_name: '<string>',
recipients: [{phone: '<string>', reference: '<string>'}],
caller_id: '<string>',
start_at: '2023-11-07T05:31:56Z',
max_attempts: 3,
retry_after_minutes: 30,
max_concurrent: 2,
voicemail_message: {type: 'play', url: '<string>'}
})
};
fetch('https://api.wave.sa/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wave.sa/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'callflow_name' => '<string>',
'recipients' => [
[
'phone' => '<string>',
'reference' => '<string>'
]
],
'caller_id' => '<string>',
'start_at' => '2023-11-07T05:31:56Z',
'max_attempts' => 3,
'retry_after_minutes' => 30,
'max_concurrent' => 2,
'voicemail_message' => [
'type' => 'play',
'url' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wave.sa/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wave.sa/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wave.sa/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "scheduled",
"callflow_name": "<string>",
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"start": "<string>",
"end": "<string>"
},
"max_attempts": 123,
"retry_after_minutes": 123,
"max_concurrent": 123,
"voicemail_message": {
"type": "play",
"url": "<string>",
"text": "<string>",
"language": "<string>"
},
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"recipients_accepted": 123,
"duplicates_removed": 123
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}Campaigns
Create a campaign
Creates a campaign: Wave calls each recipient, paces the calls under your concurrency cap and call limits, retries the ones that did not answer, and runs machine detection first on each answered call. A person hears the stored callflow callflow_name; a machine gets the optional voicemail_message after the beep. Recipients: 1 to 10000 KSA numbers (5 with a sandbox key), each with an optional reference (at most 64 characters, never spoken). Duplicates are removed; the response gives the accepted and removed counts. caller_id must be a number your account owns (a sandbox key always presents the shared sandbox number). max_concurrent defaults to half your concurrency cap and must be below it. Without start_at (or with a past one) the campaign starts at once. calling_window is a daily window in KSA time. The body may be up to 2 MB. Requires the campaigns:write scope, and stored callflows to be enabled (409 CAMPAIGN_NEEDS_IVR). Needs campaigns to be enabled on the environment (503 until then); not available in production yet.
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \
--url https://api.wave.sa/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"callflow_name": "<string>",
"recipients": [
{
"phone": "<string>",
"reference": "<string>"
}
],
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"max_attempts": 3,
"retry_after_minutes": 30,
"max_concurrent": 2,
"voicemail_message": {
"type": "play",
"url": "<string>"
}
}
'import requests
url = "https://api.wave.sa/v1/campaigns"
payload = {
"name": "<string>",
"callflow_name": "<string>",
"recipients": [
{
"phone": "<string>",
"reference": "<string>"
}
],
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"max_attempts": 3,
"retry_after_minutes": 30,
"max_concurrent": 2,
"voicemail_message": {
"type": "play",
"url": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
callflow_name: '<string>',
recipients: [{phone: '<string>', reference: '<string>'}],
caller_id: '<string>',
start_at: '2023-11-07T05:31:56Z',
max_attempts: 3,
retry_after_minutes: 30,
max_concurrent: 2,
voicemail_message: {type: 'play', url: '<string>'}
})
};
fetch('https://api.wave.sa/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wave.sa/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'callflow_name' => '<string>',
'recipients' => [
[
'phone' => '<string>',
'reference' => '<string>'
]
],
'caller_id' => '<string>',
'start_at' => '2023-11-07T05:31:56Z',
'max_attempts' => 3,
'retry_after_minutes' => 30,
'max_concurrent' => 2,
'voicemail_message' => [
'type' => 'play',
'url' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wave.sa/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wave.sa/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wave.sa/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"callflow_name\": \"<string>\",\n \"recipients\": [\n {\n \"phone\": \"<string>\",\n \"reference\": \"<string>\"\n }\n ],\n \"caller_id\": \"<string>\",\n \"start_at\": \"2023-11-07T05:31:56Z\",\n \"max_attempts\": 3,\n \"retry_after_minutes\": 30,\n \"max_concurrent\": 2,\n \"voicemail_message\": {\n \"type\": \"play\",\n \"url\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "scheduled",
"callflow_name": "<string>",
"caller_id": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"calling_window": {
"start": "<string>",
"end": "<string>"
},
"max_attempts": 123,
"retry_after_minutes": 123,
"max_concurrent": 123,
"voicemail_message": {
"type": "play",
"url": "<string>",
"text": "<string>",
"language": "<string>"
},
"sandbox": true,
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"recipients_accepted": 123,
"duplicates_removed": 123
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"error_code": "INVALID_API_KEY",
"message": "<string>",
"message_ar": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}Authorizations
Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.
Body
application/json
Required string length:
1 - 100Required string length:
1 - 100Required array length:
1 - 10000 elementsShow child attributes
Show child attributes
Maximum string length:
20Show child attributes
Show child attributes
Required range:
1 <= x <= 5Required range:
10 <= x <= 1440Required range:
x >= 1- Option 1
- Option 2
Show child attributes
Show child attributes
Response
The campaign; no call is placed yet
Available options:
scheduled, running, paused, stopped, completed Show child attributes
Show child attributes
Show child attributes
Show child attributes