Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 4.55 KB

CallState.md

File metadata and controls

30 lines (22 loc) · 4.55 KB

CallState

Properties

Name Type Description Notes
applicationId String The application id associated with the call. [optional]
accountId String The account id associated with the call. [optional]
callId String The programmable voice API call ID. [optional]
parentCallId 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 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]
stirShaken Map<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]
enqueuedTime OffsetDateTime The time this call was placed in queue. [optional]
startTime OffsetDateTime The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. [optional]
answerTime OffsetDateTime Populated once the call has been answered, with the time in ISO 8601 format. [optional]
endTime OffsetDateTime Populated once the call has ended, with the time in ISO 8601 format. [optional]
disconnectCause String Cause
errorMessage String Populated only if the call ended with an error, with text explaining the reason. [optional]
errorId String Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. [optional]
lastUpdate OffsetDateTime The last time the call had a state update, in ISO 8601 format. [optional]