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.

When Vobiz makes a synchronous HTTP request to your application, it expects an XML document in response. Vobiz sends parameters with the request that your application can use before responding. Note: The maximum allowed size of the XML document in response to an HTTP request from Vobiz is 100 KB.

​
Voice calls

​
Parameters Vobiz sends for voice calls

| CallUUID | | A unique identifier for this call. | | From | The phone number of the party that initiated the call, including the country code. For inbound calls, this is the caller’s caller ID. For outbound calls initiated via the API, this is the phone number you specified as the caller ID. To The phone number of the called party, including the country code. For inbound calls, this is your incoming phone number. For outbound calls, this is the destination phone number you provided. ForwardedFrom Set only when the received call is a forwarded call. Its value depends on the caller’s carrier. Not all carriers pass this information. CallStatus The status of the call. The value is set to ringing, in-progress, or completed. If the call is hung up, CallStatus is set to completed for inbound calls and to completed, busy, failed, timeout, or no-answer for outbound calls. Direction The direction of the call. In most cases this is inbound and the call is in a ringing state. If you are using the Call API, the direction is outbound and the call is in an answered state. ALegUUID A unique identifier for the first leg of an outbound call. Not present for inbound calls. ALegRequestUUID A unique request identifier that Vobiz returns for an API request during an outbound call. Not present for inbound calls. HangupCause The standard telephony hangup cause for the call (inbound and outbound). Not present if the call has not been hung up. Duration The duration of the call in seconds. Not present if the call has not been hung up. BillDuration The billed duration of the call in seconds. Not present if the call has not been hung up.