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
Name | Type | Description |
---|---|---|
event_type Required | string | The value will be "calling.call.state". |
event_channel Required | string | ID for the event channel on which these room session's events are reported. |
timestamp Required | number | Time of the event. |
space_id Required | string | ID for the SignalWire space associated with the call. |
project_id Required | string | ID for the project associated with the call. |
params Required | Object | Event-specific parameters. This object contains the following eight fields. |
params.node_id Required | string | ID for the node this call is on. |
params.call_id Required | string | ID for the call. |
params.tag Optional | string[] | Client data this call is tagged with. Optional. |
params.device Required | object | Protocol-specific connection information including the device type , from_number , and to_number . |
params.parent Optional | object | Information on the call that created this call including the parent device_type , node_id , and call_id . Optional. |
params.peer Optional | object | Information on the peer call this call is actively connected with including the peer node_id and call_id . Optional. |
params.call_state Required | string | The current state that triggered this event. Possible values are created , ringing , answered , ending , and ended . |
params.created_by Optional | string | The method associated with this call state change. Optional. Possible values are "dial", "connect", and "receive". |