Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 5.38 KB

CallState.md

File metadata and controls

54 lines (47 loc) · 5.38 KB

CallState

Properties

Name Type Description Notes
applicationId string The application id associated with the call. [optional] [default to undefined]
accountId string The account id associated with the call. [optional] [default to undefined]
callId string The programmable voice API call ID. [optional] [default to undefined]
parentCallId string The A-leg call id, set only if this call is the B-leg of a `<Transfer>`. [optional] [default to undefined]
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] [default to undefined]
from string The phone number that made the call, in E.164 format (e.g. +15555555555). [optional] [default to undefined]
direction CallDirectionEnum [optional] [default to undefined]
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] [default to undefined]
stirShaken { [key: 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] [default to undefined]
enqueuedTime string The time this call was placed in queue. [optional] [default to undefined]
startTime string The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. [optional] [default to undefined]
answerTime string Populated once the call has been answered, with the time in ISO 8601 format. [optional] [default to undefined]
endTime string Populated once the call has ended, with the time in ISO 8601 format. [optional] [default to undefined]
disconnectCause string Cause
errorMessage string Populated only if the call ended with an error, with text explaining the reason. [optional] [default to undefined]
errorId string Populated only if the call ended with an error, with a Bandwidth internal id that references the error event. [optional] [default to undefined]
lastUpdate string The last time the call had a state update, in ISO 8601 format. [optional] [default to undefined]

Example

import { CallState } from 'bandwidth-sdk';

const instance: CallState = {
    applicationId,
    accountId,
    callId,
    parentCallId,
    to,
    from,
    direction,
    state,
    stirShaken,
    identity,
    enqueuedTime,
    startTime,
    answerTime,
    endTime,
    disconnectCause,
    errorMessage,
    errorId,
    lastUpdate,
};

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