Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 5.1 KB

CallState.md

File metadata and controls

46 lines (37 loc) · 5.1 KB
Raw

CallState

Properties

Name Type Description Notes
application_id str The application id associated with the call. [optional]
account_id str The account id associated with the call. [optional]
call_id str The programmable voice API call ID. [optional]
parent_call_id str The A-leg call id, set only if this call is the B-leg of a `<Transfer>`. [optional]
to str 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]
var_from str The phone number that made the call, in E.164 format (e.g. +15555555555). [optional]
direction CallDirectionEnum [optional]
state str 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 Dict[str, str] 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 str 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 str Cause
error_message str Populated only if the call ended with an error, with text explaining the reason. [optional]
error_id str 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]

Example

from bandwidth.models.call_state import CallState

# TODO update the JSON string below
json = "{}"
# create an instance of CallState from a JSON string
call_state_instance = CallState.from_json(json)
# print the JSON string representation of the object
print(CallState.to_json())

# convert the object into a dict
call_state_dict = call_state_instance.to_dict()
# create an instance of CallState from a dict
call_state_from_dict = CallState.from_dict(call_state_dict)

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