CallEventTypes
Constants
CallOperationFailed
Event is triggered due to a call operation failure by the Call.hold, Call.sendVideo and Call.receiveVideo methods. The handler function receives an event with the following parameters as an argument.
Parameters
code:
Error code
message:
string
Error description
name:
string
Name of the event
CallReconnected
Event is triggered when the connection to the Voximplant Cloud is restored and media stream are active in the call.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
CallReconnecting
Event is triggered when the connection to the Voximplant Cloud is lost due to a network issue and media streams may be interrupted in the call. Until CallEventTypes.CallReconnected event is invoked, the following API calls will fail with CallError.RECONNECTING error:
Parameters
call:
Call that triggered the event
name:
string
Name of the event
Connected
Event is triggered when a realible connection is established for the call. Depending on network conditions there can be a 2-3 seconds delay between first audio data and this event. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
headers:
object
Optional SIP headers are received with the event
name:
string
Name of the event
Disconnected
Event is triggered when a call was disconnected. The handler function receives an event with the following parameters as an argument.
Parameters
answeredElsewhere:
boolean
True if the call was answered on another device via SIP forking, false otherwise
call:
Call that triggered the event
headers:
object
Optional SIP headers are received with the event
name:
string
Name of the event
EndpointAdded
Event is triggered when a new Endpoint is created. Endpoint represents an another participant in your call or conference. The handler function receives an event with the following parameters as an argument.
Failed
Event is triggered due to a call failure. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
code:
number
Call status code
headers:
object
Optional SIP headers are received with the event
name:
string
Name of the event
reason:
string
Status message of a call failure (i.e. Busy Here)
ICECompleted
Event is triggered when ICE connection is complete. Handler function receives CallEventTypes.ICECompleted params as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
ICETimeout
Event is triggered when connection was not established due to a network connection problem between 2 peers. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
InfoReceived
Event is triggered when INFO message is received. The handler function receives an event with the following parameters as an argument.
LocalVideoStreamAdded
Event is triggered when local video is added to the call. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
videoStream:
Local video stream
LocalVideoStreamRemoved
Event is triggered when local video is removed from the call. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
videoStream:
Local video stream
MessageReceived
Event is triggered when a text message is received. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event
text:
string
Content of the message
ProgressToneStart
Event is triggered when a progress tone playback starts. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
headers:
object
Optional SIP headers are received with the event
name:
string
Name of the event
ProgressToneStop
Event is triggered when a progress tone playback stops. The handler function receives an event with the following parameters as an argument.
Parameters
call:
Call that triggered the event
name:
string
Name of the event