CallEventTypes
Constants
Triggered due to a call operation failure by the Call.hold, Call.sendVideo, and Call.receiveVideo methods. Handler function receives the event with the following parameters as an argument.
Parameters
code:
Error code.
message:
string
Error description.
name:
string
Name of the event.
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.
Triggered when the connection to the Voximplant cloud is lost due to a network issue and media streams may be interrupted in a call. Until CallEventTypes.CallReconnected event is triggered, the following API calls fail with CallError.RECONNECTING error:
Parameters
call:
Call that triggered the event.
name:
string
Name of the event.
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. Handler function receives the 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.
Triggered when a call has been disconnected. Handler function receives the event with the following parameters as an argument.
Parameters
answeredElsewhere:
boolean
Whether the call has been answered on another device via SIP forking.
call:
Call that triggered the event.
headers:
object
Optional SIP headers are received with the event.
name:
string
Name of the event.
Triggered when a new Endpoint is created. Endpoint represents an another participant in your call or conference. Handler function receives the event with the following parameters as an argument.
Triggered when a call has failed. Handler function receives the 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).
Triggered when the 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.
Triggered when the connection has not been established due to a network connection problem between 2 peers. Handler function receives the event with the following parameters as an argument.
Parameters
call:
Call that triggered the event.
name:
string
Name of the event.
Triggered when an INFO message is received. Handler function receives the event with the following parameters as an argument.
Triggered when the local video is added to a call. Handler function receives the 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.
Triggered when the local video is removed from a call. Handler function receives the 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.
Triggered when a text message is received. Handler function receives the 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.
Triggered when a progress tone playback should start. Handler function receives the 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.
Triggered when a progress tone playback should stop. Handler function receives the event with the following parameters as an argument.
Parameters
call:
Call that triggered the event.
name:
string
Name of the event.