Request a call to a person
curl --request POST \
--url http://localhost:3000/api/v1/prox/calls/request \
--header 'Content-Type: application/json' \
--data '
{
"force": true,
"person": "<string>",
"phone": "<string>",
"priority": "<string>",
"profile": "<string>",
"reason": "<string>",
"skipOriginNotify": true,
"var": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/v1/prox/calls/request"
payload = {
"force": True,
"person": "<string>",
"phone": "<string>",
"priority": "<string>",
"profile": "<string>",
"reason": "<string>",
"skipOriginNotify": True,
"var": ["<string>"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
force: true,
person: '<string>',
phone: '<string>',
priority: '<string>',
profile: '<string>',
reason: '<string>',
skipOriginNotify: true,
var: ['<string>']
})
};
fetch('http://localhost:3000/api/v1/prox/calls/request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/prox/calls/request",
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([
'force' => true,
'person' => '<string>',
'phone' => '<string>',
'priority' => '<string>',
'profile' => '<string>',
'reason' => '<string>',
'skipOriginNotify' => true,
'var' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/prox/calls/request"
payload := strings.NewReader("{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/prox/calls/request")
.header("Content-Type", "application/json")
.body("{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/prox/calls/request")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{}prox
Request a call to a person
POST
/
api
/
v1
/
prox
/
calls
/
request
Request a call to a person
curl --request POST \
--url http://localhost:3000/api/v1/prox/calls/request \
--header 'Content-Type: application/json' \
--data '
{
"force": true,
"person": "<string>",
"phone": "<string>",
"priority": "<string>",
"profile": "<string>",
"reason": "<string>",
"skipOriginNotify": true,
"var": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/api/v1/prox/calls/request"
payload = {
"force": True,
"person": "<string>",
"phone": "<string>",
"priority": "<string>",
"profile": "<string>",
"reason": "<string>",
"skipOriginNotify": True,
"var": ["<string>"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
force: true,
person: '<string>',
phone: '<string>',
priority: '<string>',
profile: '<string>',
reason: '<string>',
skipOriginNotify: true,
var: ['<string>']
})
};
fetch('http://localhost:3000/api/v1/prox/calls/request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/prox/calls/request",
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([
'force' => true,
'person' => '<string>',
'phone' => '<string>',
'priority' => '<string>',
'profile' => '<string>',
'reason' => '<string>',
'skipOriginNotify' => true,
'var' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/prox/calls/request"
payload := strings.NewReader("{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/prox/calls/request")
.header("Content-Type", "application/json")
.body("{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/prox/calls/request")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"force\": true,\n \"person\": \"<string>\",\n \"phone\": \"<string>\",\n \"priority\": \"<string>\",\n \"profile\": \"<string>\",\n \"reason\": \"<string>\",\n \"skipOriginNotify\": true,\n \"var\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{}Body
application/json
Bypass call rules for an explicit operator-requested live call
Target person ID
Target phone number in E.164 format (temporary MVP, e.g. +5511999999999)
Priority level (low, normal, high, urgent)
Call profile ID
Reason for the call
Do not inform the originating session when the call reaches a terminal state
Dynamic variable sent to the voice agent; accepts repeated key=value pairs
Response
Success — no @Returns schema declared; payload shape is loose.
The response is of type object.