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:

• Call.connect
• Call.connectPhone
• Call.connectSip
• Call.dial
• Call.dialPhone
• Call.dialSip

Parameters

Name	Type	Description
event_typeRequired	string	The value will be "calling.call.state".
event_channelRequired	string	ID for the event channel on which these room session's events are reported.
timestampRequired	number	Time of the event.
space_idRequired	string	ID for the SignalWire space associated with the call.
project_idRequired	string	ID for the project associated with the call.
paramsRequired	Object	Event-specific parameters. This object contains the following eight fields.
params.node_idRequired	string	ID for the node this call is on.
params.call_idRequired	string	ID for the call.
params.tagOptional	string[]	Client data this call is tagged with. Optional.
params.deviceRequired	object	Protocol-specific connection information including the device type, from_number, and to_number.
params.parentOptional	object	Information on the call that created this call including the parent device_type, node_id, and call_id. Optional.
params.peerOptional	object	Information on the peer call this call is actively connected with including the peer node_id and call_id. Optional.
params.call_stateRequired	string	The current state that triggered this event. Possible values are created, ringing, answered, ending, and ended.
params.created_byOptional	string	The method associated with this call state change. Optional. Possible values are "dial", "connect", and "receive".