curl --request POST \
--url https://api.revring.ai/v1/calls/{id}/instructions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"instruction": "The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.",
"speak": false
}
EOFimport requests
url = "https://api.revring.ai/v1/calls/{id}/instructions"
payload = {
"instruction": "The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.",
"speak": 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({
instruction: 'The caller\'s refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.',
speak: false
})
};
fetch('https://api.revring.ai/v1/calls/{id}/instructions', 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/{id}/instructions",
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([
'instruction' => 'The caller\'s refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.',
'speak' => 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/{id}/instructions"
payload := strings.NewReader("{\n \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": 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/{id}/instructions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/calls/{id}/instructions")
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 \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"callId": "<string>",
"delivered": true,
"speak": true
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Send Instruction
Tell the agent something while the call is in progress, from your own system: new information (“the caller’s order shipped today”), a change of direction (“offer the Thursday slot instead”), or something to say right away. With speak: false (default) the instruction shapes the agent’s next reply. With speak: true the agent says it now, in its own words; if the agent is mid-sentence it says it as soon as it finishes. Instructions are recorded in the call transcript as instruction items.
curl --request POST \
--url https://api.revring.ai/v1/calls/{id}/instructions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"instruction": "The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.",
"speak": false
}
EOFimport requests
url = "https://api.revring.ai/v1/calls/{id}/instructions"
payload = {
"instruction": "The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.",
"speak": 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({
instruction: 'The caller\'s refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.',
speak: false
})
};
fetch('https://api.revring.ai/v1/calls/{id}/instructions', 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/{id}/instructions",
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([
'instruction' => 'The caller\'s refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.',
'speak' => 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/{id}/instructions"
payload := strings.NewReader("{\n \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": 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/{id}/instructions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/calls/{id}/instructions")
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 \"instruction\": \"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days.\",\n \"speak\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"callId": "<string>",
"delivered": true,
"speak": true
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
API key for authentication. Generate API keys from the RevRing dashboard.
Body
What the agent should know or say, in plain language, written for the agent
1 - 2000"The caller's refund was approved a minute ago. Let them know it should arrive in 3 to 5 days."
true: the agent says it now. false: it shapes the next reply.
Response
Delivered to the live call
Show child attributes
Show child attributes