Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Detect answering machines on outbound calls with synchronous or asynchronous detection modes.

​
Introduction

Important: Not a Separate Endpoint. Machine detection is NOT a separate API endpoint. It is configured as parameters when making a call using POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/. This page documents the machine detection parameters and callback format.
Machine detection allows you to identify when an answering machine picks up your outbound call instead of a human. You can configure Vobiz to either hang up automatically or continue the call when a machine is detected.
Machine detection is only supported on outbound calls initiated via the Make Call API. Set the machine_detection parameter to enable this feature.

​
Synchronous Machine Detection

When you set machine_detection=true or machine_detection=hangup when making a call, Vobiz analyzes the audio after the call is answered to determine if a machine answered.
FieldTypeRequiredDescription
machine_detectionstringNoSet to “true” to continue the call or “hangup” to automatically hang up when a machine is detected.
machine_detection_timeintegerNoTime in milliseconds to analyze audio. Default: 5000. Range: 2000–10000.
machine_detection_maximum_speech_lengthintegerNoMaximum speech duration in milliseconds. Default: 5000. Range: 1000–6000.
machine_detection_initial_silenceintegerNoMaximum silence after answer in milliseconds. Default: 4500. Range: 2000–10000.
machine_detection_maximum_wordsintegerNoMaximum number of sentences. Default: 3. Range: 2–10.
machine_detection_initial_greetingintegerNoMaximum greeting length in milliseconds. Default: 1500. Range: 1000–5000.

​
Asynchronous Machine Detection

To act on a detected answering machine, set the machine_detection_url parameter when making an outbound call. Vobiz detects the answering machine in the background and invokes machine_detection_url with the results.
FieldTypeRequiredDescription
machine_detection_urlstringNoCallback URL invoked when machine detection completes. Vobiz sends detection results to this URL.
machine_detection_methodstringNoHTTP method used to invoke machine_detection_url. Default: POST.
Benefit: Asynchronous detection allows your application to handle the call immediately while detection happens in the background, providing better user experience.

​
Parameters Sent to machine_detection_url

When machine detection completes, Vobiz sends these parameters to your machine_detection_url:
FieldTypeDescription
FromstringThe caller ID number used to initiate the call.
Machinebooleantrue if a machine was detected.
TostringDestination of the call.
RequestUUIDstringUnique identifier for the call request.
ALegRequestUUIDstringIdentifier for the first leg of the call (multi-leg calls).
CallUUIDstringUnique identifier for the call.
IfMachinestring"continue" or "hangup", reflecting the machine_detection value set when initiating the call.
DirectionstringDirection of the call. Always "outbound" (machine detection is only supported on outbound calls).
ALegUUIDstringUnique identifier for the A leg of the call.
EventstringEvent that triggered this notification. Always "MachineDetection".
CallStatusstringStatus of the call. Always "in-progress".

​
Example Callback Response

JSON Sent to machine_detection_url
{
  "From": "+12025550000",
  "Machine": true,
  "To": "+12025551111",
  "RequestUUID": "9834029e-58b6-11e1-b8b7-a5bd0e4e126f",
  "ALegRequestUUID": "9834029e-58b6-11e1-b8b7-a5bd0e4e126f",
  "CallUUID": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "IfMachine": "continue",
  "Direction": "outbound",
  "ALegUUID": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "Event": "MachineDetection",
  "CallStatus": "in-progress"
}