The Call Object
The Call object contains all information about a voice call, including metadata, status, duration, and billing details.
A Call object is created when an outbound call is initiated or when an inbound call is received. You can use the Call object to interact with ongoing calls, retrieve details about completed calls, and transfer ongoing calls, thereby building custom call flows.
Note: Call objects are automatically created for both inbound and outbound calls. Each call has a unique call_uuid (also referred to as request_uuid) that can be used to retrieve call details or perform operations on the call.
Attributes
Call Object Attributes
| Parameter | Type | Description |
|---|---|---|
answer_timeoptional | string | The timestamp when the call was answered. Timezone: Local timezone as set in the Vobiz console. Format: yyyy-MM-dd HH:mm:ss |
bill_durationoptional | integer | The duration of the call in seconds. |
billed_durationoptional | integer | The billed duration of the call in seconds. May differ from bill_duration depending on the billing interval of the destination. |
call_directionoptional | string | Direction of the call — either outbound or inbound. |
call_durationoptional | integer | Duration of the call in seconds. |
call_uuidoptional | string | Unique identifier for the call (also referred to as request_uuid). |
end_timeoptional | string | The timestamp when the call ended. Timezone: Local timezone as set in the Vobiz console. Format: yyyy-MM-dd HH:mm:ss |
from_numberoptional | string | Caller ID used to initiate the call. |
hangup_cause_codeoptional | integer | Integer code for the hangup cause. See hangup causes |
hangup_cause_nameoptional | string | Reason the call was hung up. See hangup causes |
hangup_sourceoptional | string | Entity that triggered the hangup. Possible sources: Caller, Callee, Vobiz, API Request, Answer XML, Error, Unknown. See hangup causes |
initiation_timeoptional | string | The timestamp when the call was initiated. Timezone: Local timezone as set in the Vobiz console. Format: yyyy-MM-dd HH:mm:ss |
parent_call_uuidoptional | string | UUID of the A-leg of the call. |
resource_urioptional | string | URI of the requested resource. |
source_ipoptional | string | IP address from which the call request originated. Useful for monitoring misuse or unauthorized access. |
stir_verificationoptional | string | STIR/SHAKEN attestation info: Outbound: Attestation assigned by Vobiz. Inbound: Attestation received on the inbound call to your Vobiz number. Possible values: Verified: Call is from a verified caller (Attestation A). Not Verified: Caller is not verified or uncertain (Attestation B or C). Not Applicable: STIR/SHAKEN doesn't apply (e.g. non-US calls, cloud calls). Read more about STIR/SHAKEN |
to_numberoptional | string | Number to which the call was initiated. |
total_amountoptional | string | Total amount charged for the call. |
total_rateoptional | string | Per-minute rate based on the destination number. |