curl --request POST \
--url https://api.revring.ai/v1/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "<string>",
"fromNumber": "<string>",
"variables": {},
"callerIdName": "<string>",
"skipQueue": false
}
'import requests
url = "https://api.revring.ai/v1/calls"
payload = {
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "<string>",
"fromNumber": "<string>",
"variables": {},
"callerIdName": "<string>",
"skipQueue": False
}
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({
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toNumber: '<string>',
fromNumber: '<string>',
variables: {},
callerIdName: '<string>',
skipQueue: false
})
};
fetch('https://api.revring.ai/v1/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.revring.ai/v1/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([
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toNumber' => '<string>',
'fromNumber' => '<string>',
'variables' => [
],
'callerIdName' => '<string>',
'skipQueue' => false
]),
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://api.revring.ai/v1/calls"
payload := strings.NewReader("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\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://api.revring.ai/v1/calls")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/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 \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromNumber": "<string>",
"toNumber": "<string>",
"initiatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"continuedFromCallId": "<string>",
"agentCallerIdName": "<string>",
"agentName": "<string>",
"variables": {},
"recordingUrl": "<string>",
"hangupCause": "<string>",
"errorMessage": "<string>",
"transcript": [
{}
],
"summary": "<string>",
"metrics": {},
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"durationSeconds": 123
}
}{
"error": "invalid_body",
"details": {}
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}{
"error": "agent_not_found"
}{
"error": "concurrency_limit"
}Send Call
Initiate an outbound call with an agent
curl --request POST \
--url https://api.revring.ai/v1/calls \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "<string>",
"fromNumber": "<string>",
"variables": {},
"callerIdName": "<string>",
"skipQueue": false
}
'import requests
url = "https://api.revring.ai/v1/calls"
payload = {
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toNumber": "<string>",
"fromNumber": "<string>",
"variables": {},
"callerIdName": "<string>",
"skipQueue": False
}
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({
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toNumber: '<string>',
fromNumber: '<string>',
variables: {},
callerIdName: '<string>',
skipQueue: false
})
};
fetch('https://api.revring.ai/v1/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.revring.ai/v1/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([
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toNumber' => '<string>',
'fromNumber' => '<string>',
'variables' => [
],
'callerIdName' => '<string>',
'skipQueue' => false
]),
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://api.revring.ai/v1/calls"
payload := strings.NewReader("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\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://api.revring.ai/v1/calls")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/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 \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toNumber\": \"<string>\",\n \"fromNumber\": \"<string>\",\n \"variables\": {},\n \"callerIdName\": \"<string>\",\n \"skipQueue\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromNumber": "<string>",
"toNumber": "<string>",
"initiatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"continuedFromCallId": "<string>",
"agentCallerIdName": "<string>",
"agentName": "<string>",
"variables": {},
"recordingUrl": "<string>",
"hangupCause": "<string>",
"errorMessage": "<string>",
"transcript": [
{}
],
"summary": "<string>",
"metrics": {},
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"durationSeconds": 123
}
}{
"error": "invalid_body",
"details": {}
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}{
"error": "agent_not_found"
}{
"error": "concurrency_limit"
}Authorizations
API key for authentication. Generate API keys from the RevRing dashboard.
Body
Destination number (E.164)
^\+[1-9]\d{1,14}$Caller ID number (E.164)
^\+[1-9]\d{1,14}$Template variables for this call
Caller ID name displayed to the recipient (max 15 characters)
1 - 15When true, returns a 429 error immediately if the concurrency limit is reached instead of queuing the call
Override the agent's voicemail behavior for this call only. 'leave_message' leaves the agent's configured voicemail when an answering machine is detected; 'hangup' ends the call without leaving a message. Omit to use the agent's saved setting. The agent must have voicemail detection enabled for this to take effect. Useful for multi-attempt outreach where only the final attempt should leave a voicemail.
hangup, leave_message Response
Outbound call initiated
Phone call record
Show child attributes
Show child attributes