Latest

The Call object

A Call object is created when an outbound call is initiated or when an inbound call is received. You can use a Call object to interact with completed calls.

Attributes

call_uuidstring

The unique identifier used to identify the call
from_numberstring

The caller ID using which the call was initiated.
to_numberstring

The number to which the call was initiated.
call_direction string

The direction of the call, if you want to filter results by call direction.
Allowed values: inbound, outbound
call_duration integer

The duration of the call in seconds. This might be different from the bill_duration based on the billing interval of the prefix called.
bill_durationinteger

The duration for which the call was billed in seconds.
end_time string

The timestamp when the call ended.
Format: yyyy-MM-dd HH:mm:ss
hangup_cause_namestring

The reason for the call hangup. Refer to our list of hangup causes and sources.
hangup_sourcestring

The entity that triggered the call hangup. Possible hangup sources are customer, carrier, zentrunk
total_ratestring

The per-minute rate charged based on the destination number.
total_amountstring

The total amount charged for the call.
initiation_timestring

The timestamp when the call was initiated.
Format: yyyy-MM-dd HH:mm:ss
answer_timestring

The timestamp when the call was answered.
Format: yyyy-MM-dd HH:mm:ss
trunk_domainstring

Unique domain address used to identify the Outbound trunk
from_countrystring

The ISO2 code of the caller ID from which the call was initiated.
to_countrystring

The ISO2 code of the to number to which the call was initiated.
transport_protocolstring

Transport protocol used on call to send/receive packets
srtpboolean

Indicates if the secure transport real time protocol was enabled for the call.
hangup_cause_codeinteger

The integer code for the hangup cause. Refer to our list of hangup causes and sources.
secure_trunkingboolean

Indicates if the secure trunking was enabled for the call.
secure_trunking_ratestring

The per-minute secure trunking rate charged for the call.
stir_verificationstring

For outbound calls: Gives details about the attestation assigned to the call by Plivo

For inbound calls: Gives details about the attestation received on the inbound call to your Plivo phone number.

Possible values:

  • Verified means the call is from a verified caller who has authorized access to the customer’s caller ID, and hence should be treated with confidence. Verified is equivalent to attestation level A.
  • Not Verified means that, for this call, either the caller is not verified, or it’s uncertain whether they have access to the caller ID used, or both. Not Verified means the call received attestation level B or C.
  • Not Applicable means STIR/SHAKEN doesn’t apply to this call, as would be the case if a call is not addressed to a US number or if it’s a cloud call (WebRTC or SIP).

Read more about STIR/SHAKEN.

attestation_indicatorstring

Indicates the attestation label assigned to the call
billed_durationinteger

The duration for which the call was billed in seconds. This might be different from the bill_duration based on the billing interval of the prefix called.

Response

{
  "call_uuid": "90b6eb07-796c-4d86-a4fd-44ed11667ddb",
  "from_number": "+912235328936",
  "to_number": "+919943720205",
  "call_direction": "outbound",
  "call_duration": 4,
  "bill_duration": 4,
  "end_time": "2022-12-06 07:02:00",
  "hangup_cause_name": "normal_hangup",
  "hangup_source": "carrier",
  "total_rate": "0.03000",
  "total_amount": "0.00200",
  "initiation_time": "2022-12-06 07:01:48",
  "answer_time": "2022-12-06 07:01:56",
  "trunk_domain": "93667062664669661.ap-south-1.zt.plivo.com",
  "from_country": "IN",
  "to_country": "IN",
  "transport_protocol": "udp",
  "srtp": false,
  "hangup_cause_code": 3000,
  "secure_trunking": false,
  "secure_trunking_rate": "0.00000",
  "stir_verification": "not applicable",
  "attestation_indicator": "null"
}