Skip to main content
POST
/
api
/
v1
/
Account
/
{auth_id}
/
Call
Make an outbound call
curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "from": "14155551234",
  "to": "+919876543210",
  "answer_url": "https://example.com/answer",
  "answer_method": "POST"
}
'
{
  "api_id": "5a9fcfee-3d4c-11ef-bef9-0242ac110005",
  "request_uuid": "5a9fd4a0-3d4c-11ef-bef9-0242ac110005",
  "message": "Call fired"
}

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.

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/
Initiate an outbound call to a PSTN number or a SIP endpoint, and make simultaneous bulk calls.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Use < to separate multiple destinations (max 1000). Example: 14157654321<14153464321<sip:john1234@api.vobiz.ai

​
Required Parameters

FieldTypeRequiredDescription
fromstringYesThe caller ID phone number in E.164 format (e.g., 14157654321).
tostringYesDestination number(s) or SIP URI(s). Use < to separate multiple destinations (max 1000). Examples: 14157654321, sip:john1234@api.vobiz.ai
answer_urlstringYesURL called when the call is answered. Must return valid XML.

​
Callback Parameters

FieldTypeRequiredDescription
answer_methodstringNoHTTP verb for answer_url. Default is POST.
ring_urlstringNoOptional URL notified when the call starts ringing.
ring_methodstringNoHTTP verb for ring_url. Default is POST.
hangup_urlstringNoOptional URL notified when the call is hung up.
hangup_methodstringNoHTTP verb for hangup_url. Default is POST.
fallback_urlstringNoInvoked if answer_url fails after 3 retries or 60s timeout.
fallback_methodstringNoHTTP verb for fallback_url. Default is POST.

​
Machine Detection Parameters

For detailed machine detection documentation, see the Machine Detection page.
FieldTypeRequiredDescription
machine_detectionstringNoDetect machine on answer. Values: true, hangup.
machine_detection_timeintegerNoTime in ms to detect machine. Default: 5000. Allowed: 2000–10000.
machine_detection_urlstringNoCallback URL for asynchronous machine detection.
machine_detection_methodstringNoHTTP verb for machine_detection_url. Default: POST.
machine_detection_maximum_speech_lengthintegerNoMax speech duration in ms. Default: 5000. Allowed: 1000–6000.
machine_detection_initial_silenceintegerNoMax silence after answer (ms). Default: 4500. Allowed: 2000–10000.
machine_detection_maximum_wordsintegerNoMax number of sentences. Default: 3. Allowed: 2–10.
machine_detection_initial_greetingintegerNoMax greeting length (ms). Default: 1500. Allowed: 1000–5000.

​
Advanced Parameters

FieldTypeRequiredDescription
caller_namestringNoSets caller name (up to 50 characters). Defaults to caller’s name.
send_digitsstringNoDTMF digits to send after the call connects. Use w (0.5s wait) or W (1s wait). Example: 1w2W3 or 123@1000 (1000ms tone).
send_on_preanswerbooleanNoIf true, sends send_digits during pre-answer. Default: false.
time_limitintegerNoMax duration of call in seconds (after answered). Default: 14400 (4 hours). Calls ≥ 86400s are disconnected at 24h.
hangup_on_ringintegerNoMax duration (in seconds) from start of ringing to hangup.

​
Request Example

{
  "from": "14155551234",
  "to": "14155555678",
  "answer_url": "https://example.com/answer",
  "answer_method": "POST",
  "ring_timeout": "30",
  "time_limit": "3600",
  "hangup_url": "https://example.com/hangup",
  "hangup_method": "POST",
  "caller_name": "John Doe",
  "machine_detection": "false"
}

​
Response Example

Success Response (201 Created)
{
  "api_id": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
  "message": "call fired",
  "request_uuid": "9834029e-58b6-11e1-b8b7-a5bd0e4e126f"
}
The call_uuid (also referred to as request_uuid) is the unique identifier for the call. Both are equivalent and can be used interchangeably.

​
Parameters Sent to Callback URLs

For every voice call you make and receive, Vobiz sends a status update to your configured callback URLs. Read and store this information for analysis, and use the values to change the flow of ongoing calls.

​
Parameters Sent to ring_url

FieldTypeDescription
FromstringCaller ID number used to initiate the call.
TostringThe destination being called.
RequestUUIDstringUnique identifier for the call request.
ALegRequestUUIDstringIdentifier for the first leg of the call (multi-leg calls).
CallUUIDstringUnique identifier for the call.
DirectionstringDirection of the call. Always "outbound".
EventstringEvent that triggered this notification. Always "Ring".
CallStatusstringStatus of the call. Always "ringing".
SessionStartstringTimestamp when early media started. Format: YYYY-MM-DD HH:mm:ss.sssss UTC.
STIRAttestationstringAttestation details assigned to the call by Vobiz.

​
Parameters Sent to answer_url and fallback_url

FieldTypeDescription
FromstringCaller ID number used to initiate the call.
TostringThe destination being called.
CallerNamestringCaller display name, present when the call originates from a SIP endpoint.
RequestUUIDstringUnique identifier for the call request.
ALegRequestUUIDstringIdentifier for the first leg of the call (multi-leg calls).
CallUUIDstringUnique identifier for the call.
DirectionstringDirection of the call. Always "outbound".
ALegUUIDstringUnique identifier for the A leg of the call.
EventstringEvent that triggered this notification. Always "StartApp".
STIRVerificationstringAttestation details. Possible values: Verified, Not Verified, Not Applicable.
CallStatusstringStatus of the call. Always "in-progress".
SessionStartstringTimestamp when early media started. Format: YYYY-MM-DD HH:mm:ss.sssss UTC.
STIRAttestationstringAttestation details assigned to the call by Vobiz.

​
Parameters Sent to hangup_url

FieldTypeDescription
FromstringCaller ID number used to initiate the call.
TostringThe destination being called.
RequestUUIDstringUnique identifier for the call request.
ALegRequestUUIDstringIdentifier for the first leg of the call (multi-leg calls).
CallUUIDstringUnique identifier for the call.
DirectionstringDirection of the call. Always "outbound".
ALegUUIDstringUnique identifier for the A leg of the call.
EventstringEvent that triggered this notification. Always "Hangup".
stir_verificationstringAttestation details. Possible values: Verified, Not Verified, Not Applicable.
CallStatusstringStatus of the call. Always "completed".
StartTimestringTimestamp when the call was initiated. Format: yyyy-MM-dd HH:mm:ss (local time).
AnswerTimestringTimestamp when the call was answered. Format: yyyy-MM-dd HH:mm:ss (local time).
SessionStartstringTimestamp when early media started. Format: YYYY-MM-DD HH:mm:ss.sssss UTC.
EndTimestringTimestamp when the call ended. Format: yyyy-MM-dd HH:mm:ss (local time).
STIRAttestationstringAttestation details assigned to the call by Vobiz.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Body

application/json
​
from
string
required
​
to
string
required
​
answer_url
string
required
​
answer_method
string
required

Response

200 - application/json

Call initiated

​
api_id
string
required
​
message
string
required
​
request_uuid
string
required