Meta Cloud API
Call action
WhatsApp Business Calling control. action: connect / pre_accept / accept / reject / terminate. Requires a Tier 2K+ number with calling enabled.
POST
/
{phoneNumberId}
/
calls
Call action
curl --request POST \
--url https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messaging_product": "whatsapp",
"action": "connect",
"to": "5511999999999",
"call_id": "<string>",
"session": {
"sdp_type": "offer",
"sdp": "v=0..."
}
}
'import requests
url = "https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls"
payload = {
"messaging_product": "whatsapp",
"action": "connect",
"to": "5511999999999",
"call_id": "<string>",
"session": {
"sdp_type": "offer",
"sdp": "v=0..."
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messaging_product: 'whatsapp',
action: 'connect',
to: '5511999999999',
call_id: '<string>',
session: {sdp_type: 'offer', sdp: 'v=0...'}
})
};
fetch('https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/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([
'messaging_product' => 'whatsapp',
'action' => 'connect',
'to' => '5511999999999',
'call_id' => '<string>',
'session' => [
'sdp_type' => 'offer',
'sdp' => 'v=0...'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls"
payload := strings.NewReader("{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}"
response = http.request(request)
puts response.read_body{
"messaging_product": "whatsapp",
"calls": [
{
"id": "wacid.ABC..."
}
]
}{
"error": {
"message": "(#131030) Recipient phone number not in allowed list",
"type": "OAuthException",
"code": 131030,
"fbtrace_id": "A..."
}
}Authorizations
Your Pilot Status API key (ps_...). You may also send Authorization: Bearer ps_... or ?access_token=ps_....
Path Parameters
Meta phone-number id of the number linked to your API key.
Body
application/json
Always whatsapp.
Available options:
whatsapp Example:
"whatsapp"
Call control action.
Available options:
connect, pre_accept, accept, reject, terminate Example:
"connect"
Callee MSISDN (for connect).
Example:
"5511999999999"
Existing call id (accept/reject/terminate/pre_accept).
WebRTC session (connect/accept/pre_accept).
Show child attributes
Show child attributes
Example:
{ "sdp_type": "offer", "sdp": "v=0..." }
Was this page helpful?
⌘I
Call action
curl --request POST \
--url https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messaging_product": "whatsapp",
"action": "connect",
"to": "5511999999999",
"call_id": "<string>",
"session": {
"sdp_type": "offer",
"sdp": "v=0..."
}
}
'import requests
url = "https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls"
payload = {
"messaging_product": "whatsapp",
"action": "connect",
"to": "5511999999999",
"call_id": "<string>",
"session": {
"sdp_type": "offer",
"sdp": "v=0..."
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messaging_product: 'whatsapp',
action: 'connect',
to: '5511999999999',
call_id: '<string>',
session: {sdp_type: 'offer', sdp: 'v=0...'}
})
};
fetch('https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/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([
'messaging_product' => 'whatsapp',
'action' => 'connect',
'to' => '5511999999999',
'call_id' => '<string>',
'session' => [
'sdp_type' => 'offer',
'sdp' => 'v=0...'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls"
payload := strings.NewReader("{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messaging_product\": \"whatsapp\",\n \"action\": \"connect\",\n \"to\": \"5511999999999\",\n \"call_id\": \"<string>\",\n \"session\": {\n \"sdp_type\": \"offer\",\n \"sdp\": \"v=0...\"\n }\n}"
response = http.request(request)
puts response.read_body{
"messaging_product": "whatsapp",
"calls": [
{
"id": "wacid.ABC..."
}
]
}{
"error": {
"message": "(#131030) Recipient phone number not in allowed list",
"type": "OAuthException",
"code": 131030,
"fbtrace_id": "A..."
}
}