Classes

Classes

Logger

Phone

Creates a new instance of the private class Phone.

Namespaces

browser

logManager

APIErrors

SDKErrors

Phone

Phone API for AT&T's Enhanced WebRTC functionality.

Events

call:canceled

Call canceled event fires when an outgoing call is canceled successfully or when an incoming call is canceled by the calling party

The user has to be logged in order to be able to receive this event.
There should be an unestablished incoming or outgoing call in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

call:connected

Call connected event fires when an outgoing or incoming call is connected to the other party.

The user has to be logged in order to be able to receive this event.
There should be an unestablished outgoing or incoming call in order to be able to receive this event.
This event is fired after Phone#call:connecting has been fired.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
downgrade	Boolean	<optional>	If the video call was accepted as audio by the other party.
timestamp	Date		Event fire time.

call:connecting

Call connecting event fires when an outgoing or incoming call is trying to connect to the other party.

The user has to be logged in order to be able to receive this event.
There should be an unestablished outgoing or incoming call in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

call:disconnected

Call disconnected event fires when a call has been disconnected by the other party or by the API

The user has to be logged in order to be able to receive this event.
There should be an existing call in progress in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
from	String	<optional>	The phone number/id of the calling party for incoming calls.
to	String	<optional>	The phone number/id of the called party for outgoing calls.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:disconnecting

Call disconnecting event fires immediately after user tries to hangup a call

The user has to be logged in order to be able to receive this event.
There should be an established call in order to be able to receive this event.
This event is fired in response to a successful call to hangup method.

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call or conference (audio/video).
codec	Array		The CODECs associated with the call or conference.
timestamp	Date		Event fire time.

call:held

Call held event fires when the user puts an active call on hold

The user has to be logged in order to be able to receive this event.
There should be an established outgoing or incoming call in order to be able to receive this event.
This event is fired in response to a successful call to hold method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:incoming

Call incoming event fires when a there is an incoming call

The user has to be logged in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the call in the list of existing calls.
from	String	The phone number/id of the calling party.
mediaType	String	The media type of the incoming call (audio/video).
codec	Array	The CODECs associated with the incoming call.
timestamp	Date	Event fire time.

call:media-modification

Call media-modification event gets triggered when user needs to perform an action for the incoming media modification

The user is in a call and gets a media modification request.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The existing media type of the call (audio/video).
newMediaType	String		The requested media type for the call modification (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

call:modification-in-progress

Transitional event to indicate that a call modification (Upgrade/Downgrade) is taking place.

This event fires in different scenarios:

• After successfully initiating a call modification but before the modification is complete.
• After successfully accepting or rejecting a call modification but before the modification is complete.

The event handler contains the code to execute when the modification-in-progress event is received by this Phone.

Example

// using a named function
phone.on('call:modification-in-progress', handler);

// using an anonymous function
phone.on('call:modification-in-progress', function (data) { ... });

Values

• handler is the name of the user-defined function, or an anonymous declaration
• data contains information about the event, it has the following structure:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:moved

Call moved event fires when a user wants to move the ongoing call to another browser or a mobile device where the user is logged in.

The user has to be logged in on atleast two devices or browsers to be able to receive this event.
There should be a established outgoing or incoming call and move method should be invoked in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

call:muted

Call muted event fires when the media is successfully muted.

The user has to be logged in order to be able to receive this event.
There should be an established call or conference in order to be able to receive this event.
This event is fired in response to a successful call to mute method.

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party (for an outgoing call).
from	String	<optional>	The phone number/id of the calling party or conference initiator.
mediaType	String		The media type of the call or conference (audio/video).
codec	Array		The CODECs associated with the call or conference.
timestamp	Date		Event fire time.

call:rejected

Call rejected event fires when an outgoing call is rejected by the called party or when an incoming call is rejected by the user successfully

The user has to be logged in order to be able to receive this event.
There should be an unestablished incoming or outgoing call in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

call:resumed

Call resumed event fires when the user resumes a call which was previously put on hold

The user has to be logged in order to be able to receive this event.
There should be an established outgoing or incoming call in order to be able to receive this event.
This event is fired in response to a successful call to resume method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:ringback-provided

Call ringback provided event fires when early media starts streaming for an outgoing call.

The user has to be logged in order to be able to receive this event.
There should be an unestablished outgoing call in order to be able to receive this event.
The called party should be able to provide early media or ringback.
The early media or ringback starts playing automatically when this event is fired.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
timestamp	Date	Event fire time.

call:state-changed

State Changed event fires when an media modification request was successfully accepted.

The user has to be logged in order to be able to receive this event.
There should be an existing call in progress in order to be able to receive this event.
The user should have initiated and accepted media modification request.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
operation	String	<optional>	Operation that generated the event.
generator	String	<optional>	The the side(initiator/receiver) that generated the event.
oldState	String		The previous state of the call.
newState	String		The new state of the call.
timestamp	Date		Event fire time.

call:transferred

Call transferred event fires when a call has been transferred by the transferrer party

The user has to be logged in order to be able to receive this event.
There should be at least two calls in progress in order to be able to receive this event.
The user has to initiate transfer to be able to receive this event.
The call should be transferred successfully to be to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
from	String	<optional>	The phone number/id of the calling party for incoming calls.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:transferring

Call transferring event fires when a call is being transferred by the transferrer party

The user has to be logged in order to be able to receive this event.
There should be at least two calls in progress in order to be able to receive this event.
The user has to initiate transfer to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
from	String	<optional>	The phone number/id of the calling party for incoming calls.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

call:unmuted

Call unmuted event fires when the media is successfully unmuted.

The user has to be logged in order to be able to receive this event.
There should be an established call or conference in order to be able to receive this event.
This event is fired in response to a successful call to unmute method.

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party (for an outgoing call).
from	String	<optional>	The phone number/id of the calling party or conference initiator.
mediaType	String		The media type of the call or conference (audio/video).
codec	Array		The CODECs associated with the call or conference.
timestamp	Date		Event fire time.

conference:canceled

Conference canceled fires when a conference is canceled before it starts

The user has to be logged in order to be able to receive this event.
There should be an unestablished conference in order to be able to receive this event.
This event is mainly fired participant side in response to a canceled conference.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
from	String	<optional>	The phone number/user id of the conference initiator for participant side
participants	Object	<optional>	The participants list for host side
invitations	Object	<optional>	The invitations list for host side.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:connected

Conference connected fires when a conference started by a host has connected

The user has to be logged in order to be able to receive this event.
There should be an unestablished conference started by the user in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the conference in the list of existing conferences.
mediaType	String	The media type of the conference (audio/video).
codec	Array	The CODECs associated with the conference.
timestamp	Date	Event fire time.

conference:connecting

Conference connecting fires when a participant tries to connect to a conference

The user has to be logged in order to be able to receive this event.
There should be an unestablished conference in order to be able to receive this event.
This event is fired participant-side in response to a successful call to joinConference method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the conference in the list of existing conferences.
from	Object	The conference initiator
mediaType	String	The media type of the conference (audio/video).
codec	Array	The CODECs associated with the conference.
timestamp	Date	Event fire time.

conference:disconnecting

Conference disconnecting event fires when a conference is in the process of disconnecting.

This event fires immediately when the user invokes endConference.
There should be an existing conference in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
from	String	<optional>	The phone number/user id of the conference initiator for participant side
participants	Object	<optional>	The participants list for host side
invitations	Object	<optional>	The invitations list for host side.
mediaType	String		The media type of the conference (audio or video).
codec	String		The codec used by the conference.
timestamp	Date		Event fire time.

conference:ended

Conference ended fires when a conference has ended

The user has to be logged in order to be able to receive this event.
There should be an established in conference in order to be able to receive this event.
This event is mainly fired host-side or participant side in response to a successful call to endConference method.
This event can also be fired if the conference ends due to some unexpected reason.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
from	String	<optional>	The phone number/user id of the conference initiator for participant side
participants	Object	<optional>	The participants list for host side
invitations	Object	<optional>	The invitations list for host side.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:held

Conference held fires when a conference has been put on hold

The user has to be logged in order to be able to receive this event.
There should be an established conference in order to be able to receive this event.
This event is fired in response to a successful call to hold method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:invitation-accepted

Conference invitation-accepted fires when an invitation has been accepted

The user has to be logged in order to be able to receive this event.
There should be an established conference in order to be able to receive this event.
This event is fired host-side when an invitation has been accepted by the participant.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:invitation-received

Conference invitation received event fires when a there is an incoming conference invite

The user has to be logged in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the conference in the list of existing conferences.
from	String	The phone number/id of the calling party.
mediaType	String	The media type of the incoming call (audio/video).
codec	Array	The CODECs associated with the incoming call.
timestamp	Date	Event fire time.

conference:invitation-rejected

Conference invitation-rejected fires when an invitation has been rejected

The user has to be logged in order to be able to receive this event.
There should be an established conference in order to be able to receive this event.
This event is fired host-side when an invitation has been rejected by the participant.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:invitation-sending

Conference invitation-sending fires when an invitation is being sent

This event fires immediately when the host invokes addParticipant.
There should be an existing conference in order to be able to receive this event.
This event is fired host-side in response to a successful call to the addParticipant method.
This event is followed by Phone#conference:invitation-sent

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the conference in the list of existing conferences.
invitee	Object	The invitee.
timestamp	Date	Event fire time.

conference:invitation-sent

Conference invitation-sent fires when an invitation has been successfully sent by the host

The user has to be logged in order to be able to receive this event.
There should be an established conference in order to be able to receive this event.
This event is fired host-side in response to a successful call to addParticipant(s) method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:joining

Conference joining fires immediately after a participant joins a conference

The user has to be logged in order to be able to receive this event.
There should be an incoming conference invitation in order to be able to receive this event.
This event is fired participant-side in response to a successful call to joinConference method.
This event is followed by Phone#conference:connecting.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the conference in the list of existing conferences.
from	Object	The conference initiator
mediaType	String	The media type of the conference (audio/video).
codec	Array	The CODECs associated with the conference.
timestamp	Date	Event fire time.

conference:participant-removed

Conference participant-removed fires when a host successfully removes a participant

The user has to be logged in order to be able to receive this event.
There should be an established conference in order to be able to receive this event.
This event is fired host-side in response to a successful call to removeParticipant method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

conference:resumed

Conference resumed fires when a conference has been resumed

The user has to be logged in order to be able to receive this event.
There should be an established conference which was previously put on hold by the user in order to be able to receive this event.
This event is fired in response to a successful call to resume method.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the conference in the list of existing conferences.
invitations	Object	<optional>	The invitations list.
participants	Object	<optional>	The current participants list.
mediaType	String		The media type of the conference (audio/video).
codec	Array		The CODECs associated with the conference.
timestamp	Date		Event fire time.

connectivity:off

connectivity:on event gets fired when the network goes from online to offline

The User have to register this event before login.

connectivity:on

connectivity:on event gets fired when the network goes from offline to online

The User have to register this event before login.

dtmf:tone-sending

Tone sending event gets fired when DTMF tone request was successful.

The event is fired if the tone is inserted into the audio stream.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the call in the list of existing calls.
to	String	The phone number/id of the called party.
from	String	The phone number/id of the calling party.
mediaType	String	The media type of the call (audio/video).
codec	Array	The CODECs associated with the call.
timestamp	Date	Event fire time.

dtmf:tone-sent

Tone sent event gets fired when the tone is sent successfully.

The event is fired when the tone is passed into the audio stream successfully.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
tone	String	The tone which was inserted successfully.
index	Number	The ordinal numbering of the call in the list of existing calls.
to	String	The phone number/id of the called party.
from	String	The phone number/id of the calling party.
mediaType	String	The media type of the call (audio/video).
codec	Array	The CODECs associated with the call.
timestamp	Date	Timestamp when the tone was inserted into stream.

address-updated

Address updated event fires after successfully updating the e911 linked address id

The user has to be logged in order to be able to receive this event.

answering

Answering event fires immediately after `answer` for an incoming call.

The user has to be logged in order to be able to receive this event.
There should be an unestablished incoming call in order to be able to receive this event.
This event is followed by Phone#call:connecting event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the call in the list of existing calls.
from	String	The phone number/id of the calling party.
mediaType	String	The media type of the call (audio/video).
codec	Array	The CODECs associated with the call.
timestamp	Date	Event fire time.

dialing

Dialing event fires immediately after `dial` for an outgoing call.

The user has to be logged in order to be able to receive this event.
There should be an unestablished outgoing call in order to be able to receive this event.
This event is followed by Phone#call:connecting event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
index	Number	The ordinal numbering of the call in the list of existing calls.
to	String	The phone number/id of the called party.
mediaType	String	The media type of the call (audio/video).
timestamp	Date	Event fire time.

error

Error event fires if there is an invalid behavior reported by the `Phone` object

The error event can be fired by the Phone for different reasons:

• API Error - is an error at the platform (RESTful API) level. This may be due to invalid parameters send in an HTTP request or a request being send while in an inconsistent state.

• SDK Error - is an error most likely due to an inconsistent state in the client JavaScript library at the browser level.

Sometimes different errors can be caused by the same underlying problem in which case a common error code is used.

A list of API error codes is here ATT.private.errorStore.APIErrors

The user has to be logged in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
JSObject	String		JavaScript object associated with the error
JSMethod	String		JavaScript method associated with the error
ErrorCode	String		Error code associated with the error
ErrorMessage	String		Message associated with the error
Cause	String		Possible causes
Resolution	String		Possible resolution
APIError	String	<optional>	API error associated with the error
ResourceMethod	String	<optional>	Resource method associated with the error
HttpStatusCode	String	<optional>	HTTP status code associated with the error
MessageId	String	<optional>	API message id associated with the error
AdditionalInformation	String	<optional>	Additional information associated with the error
timestamp	Date		Event fire time.

notification

Notification event fires when the SDK is unable to support a behavior that is not an error

The user has to be logged in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
message	String		A message for the notification.
from	String	<optional>	The phone number/id of the calling party.
to	String	<optional>	The phone number/id of the called party.
mediaType	String	<optional>	The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

warning

Warning event fires during certain scenarios, such as muting a call that's already muted.

The user has to be logged in order to be able to receive this event.
There should be an established call or conference in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
message	String		A message for the warning.
from	String	<optional>	The phone number/id of the calling party.
to	String	<optional>	The phone number/id of the called party.
mediaType	String	<optional>	The media type of the call (audio/video).
codec	Array	<optional>	The CODECs associated with the call.
timestamp	Date		Event fire time.

gateway:unreachable

Gateway Unreachable event fires when the client cannot connect to gateway.

The user has to be logged in order to be able to receive this event.
This event is fired when we get '502' or 503 with 'Cannot reach the Gateway'.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
sessionId	String	<optional>	The session ID associated.
timestamp	Date		Event fire time.

media:established

Media established event fires when audio/video media has started for a call.

The user has to be logged in order to be able to receive this event.
There should be an connected incoming or outgoing call in order to be able to receive this event.
This event is fired after Phone#call:connected has been fired.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
index	Number		The ordinal numbering of the call in the list of existing calls.
to	String	<optional>	The phone number/id of the called party.
from	String	<optional>	The phone number/id of the calling party.
mediaType	String		The media type of the call (audio/video).
codec	Array		The CODECs associated with the call.
timestamp	Date		Event fire time.

session:call-switched

Call switched event fires when the calls are switched

The user has to be logged in order to be able to receive this event.
There needs to be two calls in context in order to be able to receive this event.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
from	String	The phone number/id of the peer of the call switched from.
to	String	The phone number/id of the peer of the call switched to.
timestamp	Date	Event fire time.

session:disconnected

Session disconnected event fires when the session was successfully disconnected.

The event is fired if the user logs out successfully and the enhanced webrtc session is deleted successfully. User can no longer make or receive calls.

session:expired

Session Expired event fires when session expires in the backend.

The user has to be logged in order to be able to receive this event.
This event is fired when we get '404' with 'Session id not found' or 'The requested session resource was not found'.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Argument	Description
sessionId	String	<optional>	The session ID which got expired.
timestamp	Date		Event fire time.

session:ready

Session ready event fires when the user is successfully logged in and the SDK is initialized and ready to make, receive calls

The event is fired if the user logs in successfully and an enhanced webrtc session is created successfully.

The event is fired with an attached event data of the following format:

Type:

• Object

Properties:

Name	Type	Description
sessionId	String	The id associated with the enhanced webrtc session.