Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 4.62 KB

File metadata and controls

26 lines (23 loc) · 4.62 KB

CallState

Properties

Name Type Description Notes
application_id string The application id associated with the call. [optional]
account_id string The account id associated with the call. [optional]
call_id string The programmable voice API call ID. [optional]
parent_call_id string The A-leg call id, set only if this call is the B-leg of a `<Transfer>`. [optional]
to string The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI. [optional]
from string The phone number that made the call, in E.164 format (e.g. +15555555555). [optional]
direction \Bandwidth\Model\CallDirectionEnum [optional]
state string The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. [optional]
stir_shaken array<string,string> For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. Property
identity string The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. [optional]
enqueued_time \DateTime The time this call was placed in queue. [optional]
start_time \DateTime The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. [optional]
answer_time \DateTime Populated once the call has been answered, with the time in ISO 8601 format. [optional]
end_time \DateTime Populated once the call has ended, with the time in ISO 8601 format. [optional]
disconnect_cause string Cause
error_message string Populated only if the call ended with an error, with text explaining the reason. [optional]
error_id string Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. [optional]
last_update \DateTime The last time the call had a state update, in ISO 8601 format. [optional]

[Back to Model list] [Back to API list] [Back to README]