Finalize a recording captured by an IVR record node
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"recording_url": "https://recordings.jambonz.example/ivr-5f9c3b1a.wav",
"duration": 18.2
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize"
payload = {
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"recording_url": "https://recordings.jambonz.example/ivr-5f9c3b1a.wav",
"duration": 18.2
}
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({
call_sid: '5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c',
recording_url: 'https://recordings.jambonz.example/ivr-5f9c3b1a.wav',
duration: 18.2
})
};
fetch('https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize', 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.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize",
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([
'call_sid' => '5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c',
'recording_url' => 'https://recordings.jambonz.example/ivr-5f9c3b1a.wav',
'duration' => 18.2
]),
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://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize"
payload := strings.NewReader("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\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://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize")
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 \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\n}"
response = http.request(request)
puts response.read_body[
{
"verb": "say",
"text": "Thanks, your message has been saved. Goodbye."
},
{
"verb": "hangup"
}
]API Reference
Finalize a recording captured by an IVR record node
Internal jambonz record action-hook for voicemail and record nodes in the IVR flow-builder. jambonz calls it once the recording finishes; the handler stores and transcribes the audio through the shared recording pipeline, attaches it to the call, and returns the next verb sequence in the flow (a continuation node or a hangup). Signed with the jambonz webhook HMAC and not intended for direct client use. Fails OPEN with a clean hangup when the recording body is empty or malformed so the call always ends cleanly.
POST
/
api
/
v1
/
jambonz
/
ivr-record-finalize
Finalize a recording captured by an IVR record node
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"recording_url": "https://recordings.jambonz.example/ivr-5f9c3b1a.wav",
"duration": 18.2
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize"
payload = {
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"recording_url": "https://recordings.jambonz.example/ivr-5f9c3b1a.wav",
"duration": 18.2
}
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({
call_sid: '5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c',
recording_url: 'https://recordings.jambonz.example/ivr-5f9c3b1a.wav',
duration: 18.2
})
};
fetch('https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize', 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.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize",
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([
'call_sid' => '5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c',
'recording_url' => 'https://recordings.jambonz.example/ivr-5f9c3b1a.wav',
'duration' => 18.2
]),
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://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize"
payload := strings.NewReader("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\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://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/jambonz/ivr-record-finalize")
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 \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"recording_url\": \"https://recordings.jambonz.example/ivr-5f9c3b1a.wav\",\n \"duration\": 18.2\n}"
response = http.request(request)
puts response.read_body[
{
"verb": "say",
"text": "Thanks, your message has been saved. Goodbye."
},
{
"verb": "hangup"
}
]Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Response
200 - application/json
The jambonz verbs to continue the IVR flow after the recording is queued for processing, or a hangup verb when the flow ends.
⌘I