Skip to main content

CallState

Payload for call state events that are triggered by the change in state of an active Relay-controlled call.

Obtain instances of this state Callback request by including a call_state_url parameter when starting a call with one of the following methods:

Parameters

NameTypeDescription
event_typeRequiredstringThe value will be "calling.call.state".
event_channelRequiredstringID for the event channel on which these room session's events are reported.
timestampRequirednumberTime of the event.
space_idRequiredstringID for the SignalWire space associated with the call.
project_idRequiredstringID for the project associated with the call.
paramsRequiredObjectEvent-specific parameters. This object contains the following eight fields.
params.node_idRequiredstringID for the node this call is on.
params.call_idRequiredstringID for the call.
params.tagOptionalstring[]Client data this call is tagged with. Optional.
params.deviceRequiredobjectProtocol-specific connection information including the device type, from_number, and to_number.
params.parentOptionalobjectInformation on the call that created this call including the parent device_type, node_id, and call_id. Optional.
params.peerOptionalobjectInformation on the peer call this call is actively connected with including the peer node_id and call_id. Optional.
params.call_stateRequiredstringThe current state that triggered this event. Possible values are created, ringing, answered, ending, and ended.
params.created_byOptionalstringThe method associated with this call state change. Optional. Possible values are "dial", "connect", and "receive".