SightCall Developer Center

Account Login Support
v. 7.2.20
Class: Rtcc

The API for the Rtcc service.

Rtcc
new Rtcc(appId, token, rtccUserType, options) → {Rtcc}
Parameters:
Name Type Argument Description
appId (string)

Value of the web application identifier

token (string)

Token value to authenticate the session on the Rtcc Cloud.
If rtccUserType = 'external'[1], enter the UID of the 'internal' user.
If rtccUserType = 'digit_external', this is the six digits code
[1]: The 'internal' user associated with the UID must be authenticated before connecting the external user.

rtccUserType (string)

This variable describes the type of user, it must be one of the following:

internal For authenticated users
external For user not authenticated in the web app
digit_external Six digits mode authentication

options (object) <optional>

Value of several options

Properties
Name Type Argument Description
debugLevel (string) <optional>
ValueDescription
0No debug messages
1First level of debug messages
2Recommended level of debug messages
3All debug messages
displayName (string) <optional>

Value of the display name. Must respect naming rules:

  • String – max 127 characters
  • Not Null
  • UTF-8 Characters except: ", ,' (single quote, double quote, space)
  • Case sensitive
mode_parameter (string) <optional>

Mode used by application. can be plugin_webrtc or webrtc_only or plugin_only

standAlone (bool) <optional>

If true, connect to rtcc cloud, but do not register to sip server - calls will not be possible. Allows to run on any websocket capable browser

pluginMode (string) <optional>

An element of Rtcc.pluginMode. Specify if video is embedded in the web page or not. Default is embedded mode.

sixDigitNoCall (bool) <optional>

If true, no automatic call will be triggered after connection in six digits mode.

externalSuffix (string) <optional>

external suffix override.

hap (string) <optional>

HAP path override. Internal use only.

container (string) <optional>

An HTML element id, in which the video box is integrated. If used, this feature automatically disables drag&drop for the video box.

sscontainer (string) <optional>

An HTML element id, in which the WebRTC screen sharing box is rendered. If used, this feature automatically disables drag&drop for the screen share box.

participantListPosition (string) <optional>

"left" (default) or "right". Selects location of participant list in conference with more than 2 participants. Embedded mode only.

Returns:
(Rtcc)

A Rtcc object

Members

<static, readonly> annotationMode :string

Modes you can set for annotations

Type:
  • (string)
Properties:
Name Type Default Description
POINTER (string) pointer

The mouse pointer will be displayed on the subject

DRAW (string) draw

A right button mouse hold will draw at the current mouse position

DROP (string) drop

A right click will draw a circle around the point selected

NONE (string) none

No action will take place

ENABLED (string) none

alias for none

DISABLED (string) disabled

No action will take place

<static, readonly> callType :string

Type:
  • (string)
Properties:
Name Type Default Description
ONE_TO_ONE (string) 1

for calls between two people

N_TO_N (string) n

for calls with N participants

<static, readonly> connectionModes :string

A list of connection modes

Type:
  • (string)
Properties:
Name Type Default Description
EXTENSION (string) extension
PLUGIN (string) plugin
WEBRTC (string) webrtc

<static, readonly> meetingPointMode :string

Type:
  • (string)
Properties:
Name Type Default Description
LOCKED (string) locked

No one can enter the conference anymore

AUTO_ACCEPT (string) auto-accept

The host does not have to accept new users

DEFAULT (string) default

The host needs to accept new users into the conference

<static, readonly> meetingPointType :string

Type of meeting point

Type:
  • (string)
Properties:
Name Type Default Description
PERMANENT (string) permanent

meeting point that is permanent

SCHEDULED (string) scheduled

meeting point that is scheduled

ADHOC (string) adhoc

meeting point that is adhoc

HOSTLESS (string) hostless

meeting point that is hostless

<static, readonly> mobileCamera :string

A list of camera location (valid for mobile only).

Type:
  • (string)
Properties:
Name Type Default Description
FRONT (string) user
REAR (string) environment

<static, readonly> overlay :string

Type:
  • (string)
Properties:
Name Type Default Description
ON (string) 1

default - all video overlay exist (buttons /title bar...)

OFF (string) 0

show only video with no buttons

See:

<static, readonly> pickupMode :string

Plugin only

Type:
  • (string)
Properties:
Name Type Default Description
VIDEO (string) video

When user clicks pickup button, call will be answered with video

NOVIDEO (string) novideo

When user clicks pickup button, call will be answered with no video

HIDDEN (string) hidden

No Incomming call popup

<static, readonly> pluginMode :string

modes the plugin can be in

Type:
  • (string)
Properties:
Name Type Default Description
EMBEDDED (string) embedded

default mode the plugin is embeded on the page

STANDALONE (string) standalone

the plugin instanciates its own seperate window

<static> toastType :string

A list of toastTypes

Type:
  • (string)
Properties:
Name Type Default Description
INFO (string) info
MESSAGE (string) message
WARNING (string) warning
See:

<static, readonly> videoboxSize :string

Sizes for the video box

Type:
  • (string)
Properties:
Name Type Default Description
THUMB (string) thumb

320*180

WIDE (string) wide

640*360

FULLSCREEN (string) fullscreen
See:

<static, readonly> videoProfile :string

A list of video definition profiles. All sizes are given in pixels.

Type:
  • (string)
Properties:
Name Type Default Description
THUMBNAIL (string) ld

160*90 not supported by rtccplugin

SMALL (string) sd

320*180

MEDIUM (string) md

640*360

MEDIUM_HIGH (string) mhd

854*480

HIGH (string) hd

1280*720

PORTRAIT_MEDIUM (string) pmd

360*640

Methods

acknowledgeMessage
acknowledgeMessage(32, uid, 8)

Acknowledge an out of band message

Parameters:
Name Type Description
32 (Integer)

bit identifier of the message, set by sender application

uid (String)

of ack recipient

8 (Integer)

bit application defined acknowledge level

cancelAgentRequest
cancelAgentRequest()

Cancel pending ACD request

clearAnnotation
clearAnnotation() → {boolean}

Clear pending annotations

Returns:
(boolean)

true if call successful

clearShareAnnotation
clearShareAnnotation() → {boolean}

Clear pending shareannotations

Returns:
(boolean)

true if call successful

clearToasts
clearToasts()

Plugin only

Clear notfifications created by Rtcc#toast

coredump
coredump()

Plugin only

Generates a Plugin stack dump for Rtcc Technical Support.

coredumpmedia
coredumpmedia()

Plugin only

Generates a Plugin Media data dump for Rtcc Technical Support

coredumpsend
coredumpsend()

Plugin only

Generates a Plugin stack dump for Rtcc Technical Support, and sends it directly to SightCall Cloud

coredumptext
coredumptext()

Plugin only

Generates a Plugin stack dump in a seperate window for Rtcc Technical Support

createCall
createCall(uidToCall, type, displaynameToCall, callsetup)

Creates and initiates video call.

Parameters:
Name Type Argument Description
uidToCall (string)

user to call (ignored in sixdigits mode)

type (string)

type of call: internal, external or sixdigits

displaynameToCall (string)

callee display name. Will be overridden by actual callee display name, when call is established

callsetup (Object) <optional>

If provided, specify if audio or video should start {audio:true, video:true}

createCallNoVideo
createCallNoVideo(uidToCall, type, displaynameToCall)

Creates a call thats starts in no video DEPRECATED - use createCall(uidToCall, type, displayNameToCall, {audio:true, video:false})

Parameters:
Name Type Description
uidToCall (string)

user to call (ignored in sixdigits mode)

type (string)

type of call: internal, external or sixdigits

displaynameToCall (string)

callee display name. Will be overridden by actual callee display name, when call is established

createFile
createFile(filename, content)

Plugin only

Creates a file in MyDocument directory with the specified name and content

Parameters:
Name Type Description
filename (string)

Created file Name. If files exists, it will be replaced.

content (string)

content of the file.

createMeetingPoint
createMeetingPoint(type, options) → {MeetingPointHost}

Creates a meeting point.

Parameters:
Name Type Description
type (String)

The type of conference you wish to create. element of Rtcc.meetingPointType

options (Object)
Properties
Name Type Argument Description
startDate (int) <optional>

Unix timestamp of begining of conference

stopDate (int) <optional>

Unix timestamp of end of conference

title (String) <optional>

Title of conference

location (String) <optional>

Where the conference will be held

Returns:
(MeetingPointHost)

status updates of the meeting point handeled via the onConfCallHandler callback

createSixDigits
createSixDigits(mode, displayname, meeting_point_id)

Create a six digit code

Parameters:
Name Type Description
mode (string)

An element of Rtcc.sixDigitsType (1:1 or multiparty)

displayname (string)

display name of the external associated with this code

meeting_point_id (string)

in mode N_TO_N, the id of a previously created meeting point.

deleteMeetingPoint
deleteMeetingPoint(the)

Deletes a meeting point

Parameters:
Name Type Description
the (Number)

id of the meeting point a host would like to delete.

deleteSixDigits
deleteSixDigits()

Delete current six digits code attached to the user

destroy
destroy() → {undefined}

Disconnects from the cloud and removes lingering timers inside the object. It is then possible to dereference the variable containing the Rtcc object without any side-effect.

Returns:
(undefined)

undefined

Example
//create a new Rtcc object
var a = new Rtcc(...);
//destroy the object and use the return value to set `a` to undefined.
a = a.destroy()
disableAutomaticProfileUpdate
disableAutomaticProfileUpdate()

disables the automatic profile update when switching to larger screen or fullscreen in the UI. automatic profile update is enabled by default.

enableAutomaticProfileUpdate
enableAutomaticProfileUpdate()

enables the automatic profile update when switching to larger screen or fullscreen in the UI. automatic profile update is enabled by default.

enableSoundFx
enableSoundFx(1)

Plugin Only

Enable/disable sound effects played by the plugin in standalone mode. Default is enabled.

Parameters:
Name Type Description
1 (integer)

to enabled sounds, 0 to disable them

forceAuthenticate
forceAuthenticate()

Restarts the authentication process, in case of error in the previous attempt, or if new credentials are needed.

getAnnotationMode
getAnnotationMode() → {object}

Retrieve the current annotation mode

Returns:
(object)

An element of Rtcc.annotationMode representing the type of annotation used.

getCallWindowDefaultPosition
getCallWindowDefaultPosition()

Plugin Standalone only

Retrieves the x,y pixel position of the UI

getConnectionMode
getConnectionMode() → {string}
Returns:
(string)

An element of Rtcc.connectionModes representing the type of cloud connection used.

getDisplayName
getDisplayName() → {String}

Get the current user's display name.

Returns:
(String)

Value of the current user's display name.

getDownloadUrl
getDownloadUrl() → {string}

Plugin only

Returns the Plugin download URL.

Returns:
(string)

URL to download the RTCCplugin.

getMeetingPoint
getMeetingPoint(meetingPointId)

Fetches a meeting point. The meeting point is passed as the second argument to the onConfCallHandler callback.

Parameters:
Name Type Description
meetingPointId (int)

The Id of the meeting point

getPeripherals
getPeripherals()

Gets the current peripherals

getPermanentMeetingPointByUid
getPermanentMeetingPointByUid(uid)

Get the attendeeUrl of a uids permanent conference.

Parameters:
Name Type Description
uid (String)

to retrieve the attendee url from.

getPluginMode
getPluginMode() → {String}

Plugin Only

get curent mode of plugin

Returns:
(String)

An element of Rtcc.pluginMode

getPluginVersion
getPluginVersion() → {string}

Plugin only

Returns the version of the RTCCplugin. You can use the event get.version to catch the version

Returns:
(string)

The RTCCplugin version is sent as the first parameter of of the event get.version

getPresence
getPresence(array)

Get the presence of any specified users.

Parameters:
Name Type Description
array (Array)

of uids to retrieve the presence of.

getRoster
getRoster()

Gets the status of the whole roster registered via Rtcc#rosterAdd

getRtccUserType
getRtccUserType() → {string}

Returns the current user type (internal or external)

Returns:
(string)

The RtccUserType given as a parameter of the Rtcc object

getShareAnnotationMode
getShareAnnotationMode() → {object}

Retrieve the current share annotation mode

Returns:
(object)

An element of Rtcc.annotationMode representing the type of annotation used.

getSID
getSID()

Retrieves the internal Session ID

getStats
getStats()

get current call statistics

getSuffix
getSuffix() → {String}

Returns when logged in external mode, return the suffix of the current user

Returns:
(String)

suffix associated with the current external user

getVersion
getVersion() → {string}

Returns the value of the current Rtcc API version.

Returns:
(string)

Rtcc.js version.

getWaitList
getWaitList()

Gets the ACD waiting list for the current provider.

initialize
initialize()

Starts the connection process

isShareExtensionLoaded
isShareExtensionLoaded() → {Boolean}

WebRTC only

Returns:
(Boolean)

returns true if the chrome extension necesary for webrtc screen share is loaded

joinConfCall
joinConfCall(the, callsetup) → {MeetingPointAttendee}

Joins a video meeting with attendee role.

Parameters:
Name Type Argument Description
the (String)

id of the meeting point the attendee wishes to join

callsetup (Object) <optional>

If provided, specify if audio or video should start {audio:true, video:true}

Returns:
joinConfCallNoVideo
joinConfCallNoVideo(the) → {MeetingPointAttendee}

Joins a video meeting with attendee role, without outgoing video DEPRECATED - use joinConfCall(meetingPointId, {audio:true, video:false})

Parameters:
Name Type Description
the (String)

id of the meeting point the attendee wishes to join

Returns:
lockCallWindow
lockCallWindow()

Plugin only

Enable / Disable drag and drop of standalone call window

off
off(event, callback, context)

Removes callbacks previously bound with Rtcc#on, filtered by event name, function and context. A callback will be removed only if all arguments provided match how it was bound.

Parameters:
Name Type Argument Description
event (String) | (Array)

The name of the event, or an array of event names

callback (function) <optional>

If provided, only callbacks matching the function will be removed.

context (Object) <optional>

If provided, only callbacks with a matching context will be removed.

Example
var rtccObject = new Rtcc(...);
function sipOk(){
  alert('Ready!');
}
//bind a callback twice
rtccObject.on('cloud.sip.ok', sipOk);
rtccObject.on('cloud.sip.ok', sipOk);
//unbind all callbacks on the event
rtccIbject.off('cloud.sip.ok')
rtcc.initialize();
offAll
offAll(callback, context)

Removes callbacks previously bound with Rtcc#onAll, filtered by function and context. A callback will be removed only if all arguments provided match how it was bound.

Parameters:
Name Type Argument Description
callback (function) <optional>

If provided, only callbacks matching the function will be removed.

context (Object) <optional>

If provided, only callbacks with a matching context will be removed.

Example
var rtccObject = new Rtcc(...);
function tracer(){
  console.log(this.eventName)
}
//this will log all events during the connection
rtccObject.onAll(tracer);
rtcc.initialize();
//removes the tracer callback
rtcc.offAll(tracer)
on
on(event, callback, context)

Binds a callback to an event triggered by the API.

Parameters:
Name Type Argument Description
event (String) | (Array)

The name of the event, or an array of event names

callback (function)

The callback that will be invoked when the event triggers.

context (Object) <optional>

Context that will be passed to the callback, as the this keyword.

Example
var rtccObject = new Rtcc(...);
//a function that will be used as a callback
function sipOk(){
  alert('Ready!');
}
//binds sipOk to then event 'cloud.sip.ok'
rtccObject.on('cloud.sip.ok', sipOk);
rtcc.initialize(); //will trigger the event and invoke the sipOk callback
onAll
onAll(callback, context)

Binds a callback to all events triggered by the API.

Parameters:
Name Type Argument Description
callback (function)

The callback that will be invoked every time an event triggers.

context (Object) <optional>

Context that will be passed to the callback, as the this keyword. * A property eventName will be added to the context, containing the name of the event triggered, as a string.

Example
var rtccObject = new Rtcc(...);
function tracer(){
  console.log(this.eventName)
}
rtccObject.onAll(tracer);
rtcc.initialize();
registerSip
registerSip()

WebRTC Standalone mode only

if webrtc compatible, registerSip will register to sip server.
Once sip.ok event is received, Rtcc#createCall will become available.

requestAgent
requestAgent(ACD)

Perform an ACD request.

Parameters:
Name Type Description
ACD (AgentRequestEntity)

status criteria

requestAgentList
requestAgentList(ACD)

request a list of users matching a given ACD status criteria.

Parameters:
Name Type Description
ACD (AgentRequestEntity)

status criteria.

rosterAdd
rosterAdd(Array)

Add uids to the user presence roster.
Once all the users are added to the presence roster, use Rtcc#getRoster to initialize their presence.

Parameters:
Name Type Description
Array (Array)

of uids to register on your roster

rosterClear
rosterClear()

Reset the roster.

rosterRemove
rosterRemove(array)

Remove uids from user presence roster.

Parameters:
Name Type Description
array (Array)

of uids to remove from user roster

sendMessage
sendMessage(32, uid, message)

Sends a message to an user (out of band)

Parameters:
Name Type Description
32 (Integer)

bit identifier of the message, set by sender application

uid (String)

of recipient user.

message (String)

to send

setAnnotationMode
setAnnotationMode(mode) → {boolean}

Select the annotation mode.
if a call is pending, annotationmode must have been enabled before. otherwise, enable/disable annotations. annotation mode can be changed after inband.message.ready event has been received.

Parameters:
Name Type Description
mode (Rtcc.annotationMode)

Change the annotation mode.

Returns:
(boolean)

true if call successful

setAppId
setAppId(ApplicationIdentifier)

Sets the Application Identifier used for authentication

Parameters:
Name Type Description
ApplicationIdentifier (string)

The Application Id to use.

setAutoEraseThreshold
setAutoEraseThreshold(Integer)

Plugin only

Sets the threshold of autoerase feature in share mode. autoerase is disabled by default.

Parameters:
Name Type Description
Integer (Integer)

between 0 and 1000. 0 disables the feature. 1 is the most sesnsitive, 1000 is the least sensitive

setCallWindowDefaultPosition
setCallWindowDefaultPosition(The)

Plugin Standalone only

Set the x,y pixel position of the top-left corner of the Plugin UI.
This function should be called when you receive a "sipOk" message in the onConnectionHandler()

Parameters:
Name Type Description
The (string)

argument is a string with the "x,y" coordinate value.

Example
rtcc.setCallWindowDefaultPosition("100,100")
setDeadParty
setDeadParty(number)

Plugin Only

Set the number of seconds a plugin should not be receiving packets from an active call before assuming a network error and terminating said call

Parameters:
Name Type Description
number (int)

of seconds defaults to 20 seconds

setDebugLevel
setDebugLevel(debugLevel)

Activates the console logs.

Parameters:
Name Type Description
debugLevel (string)
ValueDescription
0No debug messages
1First level of debug messages
2Recommended level of debug messages
3All debug messages
setDisabledButtons
setDisabledButtons(options)

enable/disable selected buttons when in call.

Parameters:
Name Type Description
options (Object)
Properties
Name Type Description
mute (Boolean)

true if mute button should be disabled

video (Boolean)

true if video button should be disabled

share (Boolean)

true if share button should be disabled

setDisplayName
setDisplayName(displayName)

Sets the name of the user displayed in UI.

Parameters:
Name Type Description
displayName (string)

Value of the display name. Must respect naming rules:

  • String – max 127 characters
  • Not Null
  • UTF-8 Characters except: ", ,' (single quote, double quote, space)
  • Case sensitive
setMyAcdPriority
setMyAcdPriority(current)

Sets the ACD priority of the user

Parameters:
Name Type Description
current (Integer)

acd priorty 32 bit integer.

setMyAcdStatus
setMyAcdStatus(64)

Sets the ACD status of the user

Parameters:
Name Type Description
64 (String)

bit hex value in string format.

setMyPresence
setMyPresence(Integer)

Sets the presence level of the user

Parameters:
Name Type Description
Integer (Integer)

between 0 and 255. 0 Means offline. The application determines the meaning for any other value.

setOverlay
setOverlay(and)

Enable / disable video overlays (buttons, top banner)

Parameters:
Name Type Description
and (Sring)

element of Rtcc.overlay

setPeripherals
setPeripherals(peripheralConfig)

Sets the peripherals to be used for video, audio capture and audio playback
The result of the request is passed to the media.devices event.
in WebRTC, changes are taken into account at the next call, and audio_playback is ignored

Parameters:
Name Type Argument Description
peripheralConfig (object) <optional>
Properties
Name Type Description
video_capture (Integer)
audio_capture (Integer)
audio_playback (Integer)
setPickupMode
setPickupMode(An)

Allows to configure the pickup display or action for incoming calls.

Parameters:
Name Type Description
An (String)

element of Rtcc.pickupMode.

Example
rtcc.setPickupMode(Rtcc.pickupMode.NOVIDEO);
setPluginMode
setPluginMode(An)

Plugin Only

Set plugin to be embeded in the page, or to have its own seperate window.

Parameters:
Name Type Description
An (String)

element of Rtcc.pluginMode

setRtccUserType
setRtccUserType(rtccUserType)

Configures user type, 'internal' or 'external'.

Parameters:
Name Type Description
rtccUserType (string)
ValueDescription
internal For authenticated users
external For non-authenticated users
setSendToTopInterval
setSendToTopInterval(interval)

Plugin Only

Allows to send periodically the standalone call window to the top position

Parameters:
Name Type Description
interval (integer)

in ms

setShareAnnotationMode
setShareAnnotationMode(mode) → {boolean}

Select the share annotation mode.
Call must be pending, and global annotationmode must have been enabled before (using setAnnotationMode)

Parameters:
Name Type Description
mode (Rtcc.annotationMode)

Change the annotation mode.

Returns:
(boolean)

true if call successful

setStartupProfile
setStartupProfile(An)

Plugin only

Defines the starting video profile (quality) of the ougoing video.

Parameters:
Name Type Description
An (String)

element of Rtcc.videoProfile

Example
rtcc.setStartupProfile(Rtcc.videoProfile.SMALL)
setStartupSize
setStartupSize(An)

Plugin standalone only

Defines the size of the external video box at the start of a call.

Parameters:
Name Type Description
An (String)

element of Rtcc.videoboxSize (only Rtcc.videoboxSize.WIDE and Rtcc.videoboxSize.THUMB are supported)

Example
rtcc.setStartupSize(Rtcc.videoboxSize.WIDE)
setToken
setToken(Value)

Sets the unique Token value to be used for authentication. Can be used to refresh the token, in case of authentication failure.

Parameters:
Name Type Description
Value (string)

of the token to set.

setWideHeight
setWideHeight(height)

Plugin Standalone only set height of the call window when set in wide mode.

Parameters:
Name Type Description
height (String)

in pixels default and minimum value is 360

showCallEstablishment
showCallEstablishment(The)

Configures if the call establishment window must be displayed or not.

Parameters:
Name Type Description
The (integer)

argument is an integer 1 to show the call establishment, 0 to hide it

Example
rtcc.showCallEstablishment(0)
showCallWindow
showCallWindow(The)

Plugin Standalone only

Configures if the callwindow must be displayed or not.
If a call is active, show or hide the call window.

Parameters:
Name Type Description
The (integer)

argument is an integer 1 to show the window, 0 to hide the window

Example
rtcc.showCallWindow(0)
showShareIndicator
showShareIndicator(The)

Plugin only

Configures if the sharing indicator must be displayed or not.
If a share sessions is active, show or hide the sharing indicator.

Parameters:
Name Type Description
The (integer)

argument is an integer 1 to show the indicator, 0 to hide the indicator

Example
rtcc.showShareIndicator(0)
toast
toast(options)

Plugin only

Show a notification bottom right of the screen

Parameters:
Name Type Description
options (Object)
Properties
Name Type Description
type (String)

an element of Rtcc.toastType

message (String)

message to display

from (String)

from (required for Rtcc.toastType.MESSAGE)

timeout (Integer)

Number of seconds until timeout, 0 means will stay until Rtcc#clearToasts is called

Events

audio.ko
audio.ko

Triggered audio is not available.

audio.ok
audio.ok

Triggered audio is available.

browser.error
browser.error

Triggered when the chosen connection mode is not compatible with the current browser (e.g. webrtc_only with internet explorer)

call.create
call.create

Triggered when a call is created.
Callback is called with the parameter: (RtccCall) call

call.stats
call.stats

Asynchronous answer to function Rtcc#getStats
Callback is called with the parameter: CallStats

calldistributor.agent.available
calldistributor.agent.available

Triggered when agents are available in ACD use case. see for instance
Callback is called with the parameter: (Array of UidPresence) agentArray.

calldistributor.request
calldistributor.request

Triggered when an ACD request is received
Callback is called with the parameter: (ClientCallRequest) request

calldistributor.queue.update
calldistributor.queue.update

Triggered when the waiting queue is updated in ACD use case
Callback is called with the parameter: (CallDistributorQueue) queue

calldistributor.waitlist.retrieve
calldistributor.waitlist.retrieve

Triggered when the ACD wait list has been retrieved (see getWaitList)
Callback is called with the parameter: (Array of WaitListEntity) waitListArray

chrome.extension.missing
chrome.extension.missing

Triggered if the chrome RTCC Plugin extension is missing
Callback is called with parameter: Url - the url of the extension download page of the extension

chrome.screenshare.loaded
chrome.screenshare.loaded

Triggered if the chrome screenshare extension necesary for webrtc screenshare is available

chrome.screenshare.missing
chrome.screenshare.missing

Triggered if the chrome screenshare extension necesary for webrtc screenshare is missing
Callback is called with parameter: screenshareUrl - the url of the extension download page of the extension

client.connect
client.connect

Triggered when the API connects with the client (webRTC/plugin).
The first parameter is an element of Rtcc.connectionModes

client.disconnect
client.disconnect

Triggered the API loses the connection with the client (webRTC/plugin).

cloud.authenticate.error
cloud.authenticate.error

Triggered when the authentication to the SightCall cloud fails.
Callback is called with optional parameters: (Integer) error_code, (String) error

cloud.authenticate.success
cloud.authenticate.success

Triggered when the authentication to the SightCall cloud succeeds.

cloud.connect
cloud.connect

Triggered when the SightCall cloud has been reached. The authentication process starts immediatly.

cloud.disconnect
cloud.disconnect

Triggered when the connection with the SightCall cloud is lost.

cloud.drop
cloud.drop

Plugin Only
Triggered when the user has been disconnected by another tab forcing connection (e.g. force credentials change)

cloud.loggedasotheruser
cloud.loggedasotheruser

Triggered when the plugin is already connected with another user on another tab or browser.

cloud.haproxy.error
cloud.haproxy.error

WebRTC Only
Triggered if not able to retrieve HAProxy configuration
Callback is called with the parameter: (String) error

cloud.haproxy.ok
cloud.haproxy.ok

WebRTC Only
Triggered when HAProxy configuration has been retrieved

cloud.nosip.connect
cloud.nosip.connect

Triggered when the SightCall cloud has been reached in no-sip mode. The authentication process starts immediatly.

cloud.realtimeplatform.error
cloud.realtimeplatform.error

WebRTC Only
Triggered when the connection with the selected Real-Time Platform failed.
Callback is called with the parameter: (String) error

cloud.realtimeplatform.ok
cloud.realtimeplatform.ok

Triggered when the connection with the selected Real-Time Platform is ready. Callback is called with the parameter: (String) selected Real-Time Platform name

cloud.sip.ko
cloud.sip.ko

Triggered when the SIP communication is down. The Rtcc object is not able to place calls.

cloud.sip.ok
cloud.sip.ok

Triggered when the SIP communication has been establisehd. The Rtcc object is then ready to place calls.

cloud.turn.error
cloud.turn.error

WebRTC Only
Triggered when the TURN server is unreachable.
Callback is called with the parameter: (String) error

cloud.turn.ok
cloud.turn.ok

WebRTC Only
Triggered when the TURN server is reached.

error.createcall
error.createcall

Triggered if an outgoing call can't be created
Callback is called with the parameter: (String) error

error.plugin
error.plugin

Plugin only
Triggered by the plugin in case of plugin specific error
Callback is called with the parameter: (String) error

error.unavailable
error.unavailable

Triggered if the function is not implemented in the current mode
Callback is called with the parameter: (String) missing function

firefox.extension.missing
firefox.extension.missing

Triggered if the firefox RTCC Plugin extension is missing
Callback is called with parameter: Url - the url of the extension download page of the extension

get.displayname
get.displayname

Triggered when the answer to a getDisplayName request is received
Callback is called with the parameter: (string) value

get.getcallwindowdefaultposition
get.getcallwindowdefaultposition

Triggered when the answer to a getCallWindowDefaultPosition request is received
Callback is called with the parameter: (string) windowDefaultPosition

get.sid
get.sid

Triggered when the answer to a getSID request is received
Callback is called with the parameter: (string) sid

get.version
get.version

Triggered when the answer to a getRtccPluginVersion request is received
Callback is called with the parameter: (string) rtccPluginVersion

image.save.share
image.save.share

Triggered when the answer to shareSaveJs is received
Callback is called with the parameter: (String) blob string base64 encoded.

image.save.video
image.save.video

Triggered when the answer to videoSaveJs is received
Callback is called with the parameter: (String) blob string base64 encoded.

media.devices
media.devices

Triggered when Rtcc#getPeripherals and when a device a new peripheral is plugged in
Callback is called with the parameter: MediaDeviceList

meetingpoint.attendee.accept
meetingpoint.attendee.accept

Triggered when the user's request to join the conference has been accepted.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.attendee.deny
meetingpoint.attendee.deny

Triggered when the attendees's request to join the conference has been denied.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.attendee.error
meetingpoint.attendee.error

Triggered when an error happened on an attendee.
Callback is called with the parameters: (String) meetingPointId, (String) [optional] errorMessage.

meetingpoint.attendee.invite
meetingpoint.attendee.invite

Triggered when the user is invited by the host to a conference.
Callback is called with the parameter: (MeetingPointAttendee) attendee

meetingpoint.attendee.pending
meetingpoint.attendee.pending

Triggered when the user is waiting for the host to accept him/her in the conference.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.create.error
meetingpoint.create.error

Triggered when a meeting point could not be created.
Callback is called with the parameters: errorObject.

meetingpoint.create.success
meetingpoint.create.success

Triggered when a meeting point is created with success.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject

meetingpoint.delete.error
meetingpoint.delete.error

Triggered when a meeting point could not be deleted.
Callback is called with the parameters: (String) meetingPointId, (String) errorMessage.

meetingpoint.delete.success
meetingpoint.delete.success

Triggered when a meeting point is deleted successfully.
Callback is called with the parameter: (String) meetingPointId.

meetingpoint.cancel
meetingpoint.cancel

Triggered when the host cancelled the meeting point.

meetingpoint.notification
meetingpoint.notification

Triggered on host side when the host is not in the conference and receives a join request.
Callback is called with the parameter: (Object) joinRequestNotification.

meetingpoint.get.error
meetingpoint.get.error

Triggered when a meeting point is not retreived successfully

meetingpoint.get.success
meetingpoint.get.success

Triggered when a meeting point is retreived successfully.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject

meetingpoint.host.error
meetingpoint.host.error

Triggered when a meeting point could not be hosted.
Callback is called with the parameters: meetingPointId, errorMessage.

meetingpoint.host.success
meetingpoint.host.success

Triggered when a meeting point is hosted with success.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject.

meetingpoint.joinmode.update.error
meetingpoint.joinmode.update.error

Triggered on host side when an error occurs when trying to change the join mode
see MeetingPointHost#lock_mode, MeetingPointHost#default_mode, MeetingPointHost#autoaccept_mode
Callback is called with the parameters: String mode ('default', 'auto-accept', 'locked'}), MeetingPointHost meetingPoint

meetingpoint.joinmode.update.success
meetingpoint.joinmode.update.success

Triggered on host side when the host successfully changes the join mode
see MeetingPointHost#lock_mode, MeetingPointHost#default_mode, MeetingPointHost#autoaccept_mode
Callback is called with the parameters: String mode ('default', 'auto-accept', 'locked'}), MeetingPointHost meetingPoint

meetingpoint.joinrequest.accept
meetingpoint.joinrequest.accept

Triggered on host side when a join conference request has been accepted.
Callback is called with the parameter: (Attendee) attendee

meetingpoint.joinrequest.cancel
meetingpoint.joinrequest.cancel

Triggered on host side when a join conference request has been cancelled.
Callback is called with the parameter: joinRequest.

meetingpoint.joinrequest.deny
meetingpoint.joinrequest.deny

Triggered on host side when an attendee denies the host's invite.
Callback is called with the parameter: (Attendee) attendee.

meetingpoint.joinrequest.error
meetingpoint.joinrequest.error

Triggered on host side when a join conference request has been emitted but failed.
Callback is called with the parameter: (String) meetingPointId, (Attendee) attendee, errorMessage

meetingpoint.joinrequest.new
meetingpoint.joinrequest.new

Triggered on host side when a join conference request is received.
Callback is called with the parameters: (Attendee) attendee

meetingpoint.joinrequest.send
meetingpoint.joinrequest.send

Triggered on attendee side when a join conference request has been sent to the host.
Callback is called with the parameters: (String) meetingPointId, (Attendee) attendee

meetingpoint.modify.error
meetingpoint.modify.error

Triggered when a meeting point could not be modified.
Callback is called with the parameters: meetingPointId, errorMessage.

meetingpoint.modify.success
meetingpoint.modify.success

Triggered when a meeting point is modified with success.
Callback is called with the parameter: meetingPointObject.

meetingpoint.permanent.get.success
meetingpoint.permanent.get.success

Triggered as successful answer to getPermanentMeetingPointByUid
Callback is called with the parameter: (String) url.

message.acknowledge
message.acknowledge

Triggered when a message acknowledge has been received.
Callback is called with the parameters: (String) messageId, (String) emitterUid, (String) status.

message.receive
message.receive

Triggered when a message has been received.
Callback is called with the parameters: (String) messageId, (String) emitterUid, (Integer) message.

plugin.load
plugin.load

Triggered when the plugin is loaded.

plugin.missing
plugin.missing

Triggered when the plugin is not detected.
Callback is called with the parameter: (String) url - download url of plugin

plugin.requirepermission
plugin.requirepermission

Triggered when the plugin is installed but the user needs to allow it.

plugin.startupdate
plugin.startupdate

Triggered when the plugin update process starts

plugin.update
plugin.update

Triggered when the plugin has finished downloading the latest version

plugin.mode.embedded
plugin.mode.embedded

Triggered as answer to getPluginMode

plugin.mode.standalone
plugin.mode.standalone

Triggered as answer to getPluginMode

presence.alreadyregistered
presence.alreadyregistered

Triggered at the connection when this user was already connected.

presence.burstupdate
presence.burstupdate

Triggered when user presence status requested before have been received.
Callback is called with the parameter: (Array of UidPresence) userPresenceArray

presence.ko
presence.ko

Triggered when the connection to the SightCall presence server is lost.

presence.newuser
presence.newuser

Triggered at the connection when this user was not already connected.

presence.ok
presence.ok

Triggered when the connection to the SightCall presence server is ready. Callback is called with the parameter: rosterLength.

presence.update
presence.update

Triggered when the current user or a user from the roster changes his presence.
Callback is called with the parameter: (Array of UidPresence) userPresenceArray

presence.roster.retrieve
presence.roster.retrieve

Triggered when the roster content has been received.
Callback has the parameters (Array of UidPresence) currentRoster

presence.roster.update
presence.roster.update

Triggered when the roster has been updated.
Callback has the parameters: (String) numberUserAdded, (String) rosterLength.

sixdigits.create.error
sixdigits.create.error

Triggered when a six digits code failed to be created.
Callback has the parameter: (String) errorMessage

sixdigits.create.success
sixdigits.create.success

Triggered when a six digits code has been created.
Callback has the parameter: (String) sixdigits

sixdigits.delete.error
sixdigits.delete.error

Triggered when a six digits code failed to be deleted. Callback has the parameter: (String) errorMessage

sixdigits.delete.success
sixdigits.delete.success

Triggered when a six digits code has been deleted.

ui.ready
ui.ready

Triggered when the user interface library is loaded.

ui.vcam.notfound
ui.vcam.notfound

Triggered when the virtual camera driver is not found in webextension embedded mode
This can happen on mac after an update from 6.x series. The plugin must be reinstalled, using getDownloadUrl function.

webrtc.capability
webrtc.capability

Triggered when the API starts.
Callback is called with the parameter: (Boolean) isWebrtcCompliant - if true, the browser can handle webRTC.

webrtc.missing
webrtc.missing

Triggered when webRTC is not available on this network. This happens when the network does not allow to reach
the Real-Time Platform or the TURN server.

webrtc.mediarequest.error
webrtc.mediarequest.error

Triggered when unable to access the camera/micro. (WebRTC only) An error message is given as the first parameter of the callback.

websocket.error
websocket.error

Triggered when the RealTime Platform connection is lost in WebRTC mode