curl --request POST \
--url https://app.freyavoice.ai/api/v2/call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phoneNumber": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"callerNumber": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": {},
"attemptNumber": 123,
"externalCallId": "<string>",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipE164Normalization": true
}
'import requests
url = "https://app.freyavoice.ai/api/v2/call"
payload = {
"phoneNumber": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"callerNumber": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": {},
"attemptNumber": 123,
"externalCallId": "<string>",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipE164Normalization": True
}
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({
phoneNumber: '<string>',
workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
callerNumber: '<string>',
campaignId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
properties: {},
attemptNumber: 123,
externalCallId: '<string>',
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
skipE164Normalization: true
})
};
fetch('https://app.freyavoice.ai/api/v2/call', 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://app.freyavoice.ai/api/v2/call",
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([
'phoneNumber' => '<string>',
'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'callerNumber' => '<string>',
'campaignId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'properties' => [
],
'attemptNumber' => 123,
'externalCallId' => '<string>',
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'skipE164Normalization' => true
]),
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://app.freyavoice.ai/api/v2/call"
payload := strings.NewReader("{\n \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\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://app.freyavoice.ai/api/v2/call")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/call")
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 \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"success": true,
"callId": "<string>",
"jobUuid": "<string>",
"job_uuid": "<string>",
"message": "<string>",
"error": "<string>"
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}Initiate call
Initiates an outbound call. Requires phoneNumber, callerNumber, and workspaceId. Add campaignId to trigger the campaign call flow. Routes via Asterisk ARI or FreeSWITCH ESL based on phone number trunk config.
curl --request POST \
--url https://app.freyavoice.ai/api/v2/call \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phoneNumber": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"callerNumber": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": {},
"attemptNumber": 123,
"externalCallId": "<string>",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipE164Normalization": true
}
'import requests
url = "https://app.freyavoice.ai/api/v2/call"
payload = {
"phoneNumber": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"callerNumber": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"properties": {},
"attemptNumber": 123,
"externalCallId": "<string>",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipE164Normalization": True
}
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({
phoneNumber: '<string>',
workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
callerNumber: '<string>',
campaignId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
properties: {},
attemptNumber: 123,
externalCallId: '<string>',
assistantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
skipE164Normalization: true
})
};
fetch('https://app.freyavoice.ai/api/v2/call', 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://app.freyavoice.ai/api/v2/call",
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([
'phoneNumber' => '<string>',
'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'callerNumber' => '<string>',
'campaignId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'properties' => [
],
'attemptNumber' => 123,
'externalCallId' => '<string>',
'assistantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'skipE164Normalization' => true
]),
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://app.freyavoice.ai/api/v2/call"
payload := strings.NewReader("{\n \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\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://app.freyavoice.ai/api/v2/call")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/call")
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 \"phoneNumber\": \"<string>\",\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callerNumber\": \"<string>\",\n \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"properties\": {},\n \"attemptNumber\": 123,\n \"externalCallId\": \"<string>\",\n \"assistantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"skipE164Normalization\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"success": true,
"callId": "<string>",
"jobUuid": "<string>",
"job_uuid": "<string>",
"message": "<string>",
"error": "<string>"
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Customer/destination phone number
Workspace ID
Caller ID phone number (used to look up SIP/trunk config). Required for regular calls; campaign calls derive it from the campaign
Campaign ID (presence triggers campaign call flow)
Custom properties to pass to the agent
Show child attributes
Show child attributes
Campaign attempt number (1 = initial call); surfaced to the agent as 0-based call.retry_number
External call ID for client-side tracking
1 - 255Override campaign assistant ID
Version ID of the entity (agent/workflow) active during the call
Skip E.164 normalization of the phone number (default: false)