CallEvent
Constants
Connected
Triggered after a call has been successfully connected.
Listener is called with CallConnected and payload:
Parameters
callId:
string
Call id
headers:
Record<string, string>
OptionalOptional headers passed with the event
Disconnected
Triggered after a call has been disconnected.
Listener is called with CallDisconnected and payload:
Parameters
callId:
string
Call id
headers:
Record<string, string>
OptionalOptional headers passed with the event
reason:
Reason that the call ended
Failed
Triggered if a call failed.
Listener is called with CallFailed and payload:
Parameters
callId:
string
Call id
code:
number
Call status code
headers:
Record<string, string>
OptionalOptional headers passed with the event
reason:
string
Call failure reason
InfoReceived
Triggered when an INFO message is received within a call.
Listener is called with CallInfoReceived and payload:
Parameters
body:
string
Body of an INFO message
callId:
string
Call id
headers:
Record<string, string>
OptionalOptional headers passed with the event
mimeType:
${string}/${string}
MIME type of an INFO message
MessageReceived
Triggered when a message is received within a call.
Listener is called with CallMessageReceived and payload:
Parameters
callId:
string
Call id
message:
string
Content of the message
RemoteMediaAdded
Triggered when another call participant has added an audio or video stream to a call.
Listener is called with CallRemoteMediaAdded and payload:
Parameters
callId:
string
Call id
stream:
Remote media stream
type:
Remote media stream type
RemoteMediaRemoved
Triggered when another call participant has removed an audio or video stream from a call.
Listener is called with CallRemoteMediaRemoved and payload:
Parameters
callId:
string
Call id
stream:
Remote media stream
type:
Remote media stream type
StartRinging
Triggered when the Call.ring method is called on the scenario side.
Listener is called with CallStartRinging and payload:
Parameters
callId:
string
Call id
StatsReport
Triggered when call statistics are available for a call.
Listener is called with CallStatsReport and payload:
Parameters
connection:
Media connectivity statistics.
localAudio:
Statistics for all active outgoing audio streams in a call at the moment of the statistics collection.
localVideo:
Statistics for all active outgoing video streams in a call at the moment of the statistics collection.
remote:
{ audio: RemoteAudioStreamStatsReport, video: RemoteVideoStreamStatsReport }
Statistics for all incoming audio and video streams of a call at the moment of the statistics collection.
timestamp:
number
Time at which the call statistics are collected, relative to the UNIX epoch (Jan 1, 1970, UTC), in microseconds.
StopRinging
Triggered when the Call.answer or Call.startEarlyMedia method is called on the scenario side.
Listener is called with CallStopRinging and payload:
Parameters
callId:
string
Call id