Chamadas
Tocar áudio na chamada (web)
Toca um arquivo de áudio dentro de uma chamada ativa. Body: — URL http(s) pública de um .mp3/.wav/.opus (a mídia viaja por URL, como todo envio de mídia em números web). Se a chamada ainda não estiver ativa, o áudio entra em fila e toca assim que conectar. SOMENTE números web/não-oficiais — números Meta retornam 400 FEATURE_NOT_SUPPORTED (a mídia deles flui via WebRTC).
Requer uma chave com escopo de número.
POST
/
v1
/
calls
/
{callId}
/
play
Tocar áudio na chamada (web)
curl --request POST \
--url https://pilotstatus.com.br/v1/calls/{callId}/play \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mediaUrl": "https://cdn.example.com/ivr-greeting.mp3"
}
'import requests
url = "https://pilotstatus.com.br/v1/calls/{callId}/play"
payload = { "mediaUrl": "https://cdn.example.com/ivr-greeting.mp3" }
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({mediaUrl: 'https://cdn.example.com/ivr-greeting.mp3'})
};
fetch('https://pilotstatus.com.br/v1/calls/{callId}/play', 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/v1/calls/{callId}/play",
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([
'mediaUrl' => 'https://cdn.example.com/ivr-greeting.mp3'
]),
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/v1/calls/{callId}/play"
payload := strings.NewReader("{\n \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\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/v1/calls/{callId}/play")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/calls/{callId}/play")
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 \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": "call_01HZX...",
"status": "ACCEPTED"
}{
"error": "Validation error"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Parâmetros de caminho
Id do Pilot Status (call_...) ou id do provedor (CallID).
Corpo
application/json
URL pública do áudio a tocar (.mp3, .wav ou .opus).
Exemplo:
"https://cdn.example.com/ivr-greeting.mp3"
Resposta
Tocar áudio
Esta página foi útil?
⌘I
Tocar áudio na chamada (web)
curl --request POST \
--url https://pilotstatus.com.br/v1/calls/{callId}/play \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"mediaUrl": "https://cdn.example.com/ivr-greeting.mp3"
}
'import requests
url = "https://pilotstatus.com.br/v1/calls/{callId}/play"
payload = { "mediaUrl": "https://cdn.example.com/ivr-greeting.mp3" }
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({mediaUrl: 'https://cdn.example.com/ivr-greeting.mp3'})
};
fetch('https://pilotstatus.com.br/v1/calls/{callId}/play', 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/v1/calls/{callId}/play",
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([
'mediaUrl' => 'https://cdn.example.com/ivr-greeting.mp3'
]),
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/v1/calls/{callId}/play"
payload := strings.NewReader("{\n \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\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/v1/calls/{callId}/play")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/calls/{callId}/play")
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 \"mediaUrl\": \"https://cdn.example.com/ivr-greeting.mp3\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"id": "call_01HZX...",
"status": "ACCEPTED"
}{
"error": "Validation error"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Too many requests"
}