Handle expiry of the softphone park timer
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"reason": "timeout"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed"
payload = {
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"reason": "timeout"
}
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', reason: 'timeout'})
};
fetch('https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed', 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/pause-elapsed",
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',
'reason' => 'timeout'
]),
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/pause-elapsed"
payload := strings.NewReader("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"reason\": \"timeout\"\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/pause-elapsed")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"reason\": \"timeout\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed")
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 \"reason\": \"timeout\"\n}"
response = http.request(request)
puts response.read_body[
{
"verb": "say",
"text": "The party you are calling is not available. Please leave a message after the tone."
},
{
"verb": "record",
"action_hook": "/api/v1/jambonz/voicemail-store"
}
]API Reference
Handle expiry of the softphone park timer
Internal jambonz gather action-hook, fired when the softphone park timer expires without the agent’s softphone accepting the call. If no accept or decline has already claimed the call it records a timeout disposition and returns the route’s fallback verbs; if the call was already answered or declined it returns an empty verb array so the existing redirect drives the leg. Signed with the jambonz webhook HMAC.
POST
/
api
/
v1
/
jambonz
/
pause-elapsed
Handle expiry of the softphone park timer
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"reason": "timeout"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed"
payload = {
"call_sid": "5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c",
"reason": "timeout"
}
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', reason: 'timeout'})
};
fetch('https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed', 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/pause-elapsed",
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',
'reason' => 'timeout'
]),
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/pause-elapsed"
payload := strings.NewReader("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"reason\": \"timeout\"\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/pause-elapsed")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"call_sid\": \"5f9c3b1a-2d4e-4f6a-8b0c-1e2d3f4a5b6c\",\n \"reason\": \"timeout\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/jambonz/pause-elapsed")
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 \"reason\": \"timeout\"\n}"
response = http.request(request)
puts response.read_body[
{
"verb": "say",
"text": "The party you are calling is not available. Please leave a message after the tone."
},
{
"verb": "record",
"action_hook": "/api/v1/jambonz/voicemail-store"
}
]Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Response
200 - application/json
The route's jambonz fallback verbs when the park timed out, or an empty array when the call was already accepted or declined.
⌘I