Initiate an outbound WhatsApp Business Call (Phase 5)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"from_phone_number_id": "<string>",
"conversation_id": "<string>",
"recording_consent": true,
"biz_opaque_callback_data": "<string>",
"sdp_offer": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls"
payload = {
"to": "<string>",
"from_phone_number_id": "<string>",
"conversation_id": "<string>",
"recording_consent": True,
"biz_opaque_callback_data": "<string>",
"sdp_offer": "<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({
to: '<string>',
from_phone_number_id: '<string>',
conversation_id: '<string>',
recording_consent: true,
biz_opaque_callback_data: '<string>',
sdp_offer: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls', 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.orbit.devotel.io/api/v1/whatsapp/calling/calls",
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([
'to' => '<string>',
'from_phone_number_id' => '<string>',
'conversation_id' => '<string>',
'recording_consent' => true,
'biz_opaque_callback_data' => '<string>',
'sdp_offer' => '<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.orbit.devotel.io/api/v1/whatsapp/calling/calls"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\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.orbit.devotel.io/api/v1/whatsapp/calling/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls")
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 \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"meta_call_id": "<string>",
"status": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}WhatsApp Calling
Initiate an outbound WhatsApp Business Call (Phase 5)
Initiate a WhatsApp Business outbound call. Walks pre-flight gates: connection lookup + access-token decrypt, country block-list (WA_CALLING_BLOCKED_COUNTRIES), calling-enabled flag on the WABA, and recipient call-permission grant. Permission-missing returns 422 with code WHATSAPP_CALLING_NO_PERMISSION; the dashboard surfaces a CTA to send the call-permission template first.
POST
/
api
/
v1
/
whatsapp
/
calling
/
calls
Initiate an outbound WhatsApp Business Call (Phase 5)
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"from_phone_number_id": "<string>",
"conversation_id": "<string>",
"recording_consent": true,
"biz_opaque_callback_data": "<string>",
"sdp_offer": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls"
payload = {
"to": "<string>",
"from_phone_number_id": "<string>",
"conversation_id": "<string>",
"recording_consent": True,
"biz_opaque_callback_data": "<string>",
"sdp_offer": "<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({
to: '<string>',
from_phone_number_id: '<string>',
conversation_id: '<string>',
recording_consent: true,
biz_opaque_callback_data: '<string>',
sdp_offer: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls', 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.orbit.devotel.io/api/v1/whatsapp/calling/calls",
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([
'to' => '<string>',
'from_phone_number_id' => '<string>',
'conversation_id' => '<string>',
'recording_consent' => true,
'biz_opaque_callback_data' => '<string>',
'sdp_offer' => '<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.orbit.devotel.io/api/v1/whatsapp/calling/calls"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\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.orbit.devotel.io/api/v1/whatsapp/calling/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls")
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 \"to\": \"<string>\",\n \"from_phone_number_id\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"recording_consent\": true,\n \"biz_opaque_callback_data\": \"<string>\",\n \"sdp_offer\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"meta_call_id": "<string>",
"status": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Recipient phone number (E.164, optional leading +).
Required string length:
1 - 64Meta phone_number_id of the sender WABA number.
Required string length:
1 - 64Required string length:
1 - 64Echoed back on every webhook event for the call (correlation handle).
Required string length:
1 - 512SDP offer for browser-side WebRTC. Omit for server-bridged calls.
Required string length:
1 - 16384⌘I