ITrueConfCallXEvents Interface Reference

Address book update notification

Parameters

eventDetails

– event details in JSON format

Applicaton update available notification

Microphone test volume level notification

Parameters

lvl	– volume level

Notification about video replacing picture send status change

Parameters

picture

filename wihtout path, empty when not sending

Call history change notification

Parameters

jsonCallHistory

– string with call history in JSON format. Contains only calls later that in lastView parameter

Video matrix change notification

Message sent to user notification

Parameters

peerId	– user’s TrueConf ID
message	– message text

Notification about outgoing add to address book command

Parameters

peerId	– user’s TrueConf ID
peerDn	– user’s display name

Notification about outgoing add to address book’s group command

Parameters

groupId	– group ID
peerId	– user’s TrueConf ID

Notification about outgoing ban command

Parameters

peerId

– user’s TrueConf ID

Chat history clear notification

Parameters

chatId

– chat ID

Create address book group outgoing notfication

Parameters

groupName

– group name

Notification about outgoing remove from address book command

Parameters

peerId

– user’s TrueConf ID

Notification about outgoing remove from address book’s group command

Parameters

peerId	– user’s TrueConf ID
groupId	– group ID

Notification about outgoing remove address book’s group command

Parameters

groupId

– group ID

Notification about outgoing address book’s group rename command

Parameters

groupId	– group ID
groupName	– new group name

Notification about outgoing user rename in address book command

Parameters

peerId	– user’s TrueConf ID
peerDn	– new user’s display name

Notification about outgoing unban command

Parameters

peerId

– user’s TrueConf ID

On remote command receiving

Parameters

peerId	– sender TrueConf ID
command	– commang string

Outgoing notification about sucessful command sending

Parameters

peerId	– user’s TrueConf ID
command	– command string

Call start notification

Call end notification

Ban notification

Delete from address book notification

Unban notification

User detailed info arrival notification

Video pin and mode infrmaton arrival notfication

File accepted nofitication

Parameters

fileId

– file ID

File sent to current conference nofitication

Parameters

fileId	– file ID
fileName	– file Name

File rejected nofitication

Parameters

fileId

– file ID

File sent to user nofitication

Parameters

fileId	– file ID
fileName	– file Name
peerId	– user’s TrueConf ID

File transfer availability notificaton

Parameters

available

– true if file transfer is available, false otherwise

Message sent to group chat notification

Parameters

message

– message text

User group change notification

Parameters

jsonGroupList

– string with detailed group infornation,including members, in JSON format

Hang up button pressed notification

Hardware change notification

Incoming chat notificaton

Parameters

peerId	– sender’s TrueConf ID
peerDn	– sender’s display name
message	– message
time	– вmessage time in unix-time format

Incoming group chat notificaton

Parameters

peerId	– sender’s TrueConf ID
peerDn	– sender’s display name
message	– message text
time	– вmessage time in unix-time format

Podium request reply notification

Invite notifiction

Invite request sent notification

Invite sent notificaton

Hang up on external hardware device

Off hookon external hardware device

Login notification

Logout notification

Call button pressed notification

Receiver information update notification

Record request notificaton

Record request reply notificaton

Reject notification

Reject sent notificaton

Remark countdown notification

Request to join to your group conference notification

Restrictions update notification

Role change in conference user list notification

Slideshow information update notificaton

Connect to server notification

Disconnect from server notification

Settings change notificaton

Slidesho parameter change

Parameters

eventDetails

– full notificatoin test in JSON.

Slideshow start notification

Slideshow end notificaton

Initialization start notification

End of P2P call

Microphone test progress notification

Parameters

started

– true when test started, false when ended

In-call DTMF tone sent notificaion

Parameters

symbol

– sent DTMF tone

Avatar update notification

Camera format change notification

Conference participant list change notification

Video matrix change notificaton

Nonitifacton about full CallX initialization

State change notification

Parameters

prevState	– previous state
newState	– new state

prevState and newState could have the following values

• 0 none, no server connection and application does not try to connect to server
• 1 connect, application tries to connect to server
• 2 login, login required
• 3 normal, application connected and logged in
• 4 wait, incoming or outgoing call establishment in progress
• 5 conference, application is in call
• 6 close, call is terminating

Command execution reply

Parameters

cmdName	– command name
allData	– command reply in JSON format

Erro notification

Parameters

errorCode	– integer error code
errorMsg	– error text

File receiving complete notification

File receiving progress notificaition

On incoming file transfer requiest received

File sending complete notification

On file send error

On file status change whilte file transfer

Parameters

fileId	– unique file id
directionType	1 – Download 2 – Upload
fileStatus	1 – StartError 2 – Started 3 – Complete 4 – UndefinedError 5 – Pending

Login confirmation

Logon error notificaton

Parameters

errorCode

– error code 1 – answer on CheckUserLoginStatus_Method, if current CID is already authorized at TransportRouter 2 – answer on CheckUserLoginStatus_Method, if current CID is not authorized at TransportRouter – can try to login 3 – incorrect password or other problems with DB 4 – client shouldn’t show error to user (example: incorrect AutoLoginKey) 5 – license restriction of online users reached, server cannot login you 6 – user exist, but he is disabled to use this server 7 – client should retry login after timeout (value in container or default), due to server busy or other server problems 8 – user cannot login using this client app (should use other type of client app)

Component event handler

Parameters

data	– event data in JSON

Failed start notification

Possible reasons

• wrong CallXPath;
• application stopped functioning before full start (OnXAfterStart).

Termination notification in this state application could be restartes with XRestart or XRestartForce commands