Skip to content
Docs
Voice PBX
All endpoints

Smart IVR AI callback

Deliver the Smart IVR analysis result for a call

No authentication required
token query · string *
Opaque per-call token issued by SmartIvrSendScript, validated against the channel

Request body · required

Request schema
call_id*string
Echoed back from the analyze request — the channel name
pbx_idstring
Not used by this controller
statusstring
complete or failed — not used directly, see recommended_route
eligible_extensionsarray
Not used by this controller
[]object
recommended_routeobject
Null on failure or no match (-> hangup). Otherwise transfer to .number
typestring
idstring
numberstring
Extension routed to via INCOMING-{instance}
recommended_extensionobject
Not used by this controller
Free-form object
errorobject
Not used directly by this controller
Free-form object

Responses

Channel redirected
Response schema
successboolean
Bad Request - Request validation failed
Response schema
No response body.
Channel/token invalid, or the call already ended before this callback arrived
Response schema
successboolean
post https://{username}.voxbi.cloud/api/{version}/smartIvr/callback
Base URL https://{username}.voxbi.cloud/api/{version}
Request sample 
curl -X POST 'https://{username}.voxbi.cloud/api/{version}/smartIvr/callback'
const response = await fetch('https://{username}.voxbi.cloud/api/{version}/smartIvr/callback', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.post('https://{username}.voxbi.cloud/api/{version}/smartIvr/callback')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://{username}.voxbi.cloud/api/{version}/smartIvr/callback', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
No request example provided.
No example for this status.
No example for this status.
No example for this status.