«trueconf:» Protocol Designed to Interact with TrueConf Client Applications

Konstantin Olmezov
August 20, 2018
Konstantin Olmezov
Categories: Knowledge Base

TrueConf client applications support special trueconf: protocol that operates at the system level and allows you to manage calls and other functions using short commands that can be placed in a browser link or button, run in a console, or inserted into a script.

trueconf: protocol is supported in v. 7+ client applications, but for TrueConf Client 6.x.x, it provides only the most basic functions.

The previous protocol name — visicall: — is currently obsolete; new applications may not support this version, and we do not recommend using it.

This article describes the main protocol features and showcase its uses. For clarity, we’ve only shown how to use it as a link in a browser.

Format of Access to Trueconf: Protocol

All possible trueconf: protocol calls can be described as follows:

trueconf:[target]@[server]&[param_1]=[value_1]&[…]&[param_n]=[value_n]

Where:

  • [target] is a user login, conference id, RTSP link for connection, etc. We’ll further call this parameter an addressee;
  • [TrueConfServer] is an IP address or FQDN to which a call should be made. We’ll further call this parameter a server;
  • [param_n] is a name of an additional parameter;
  • [value_n] is a value of an additional parameter.

Protocol Actions

Function Call Format and Examples Version 6.X Version 7.X
Launch and Authorization
Application launch trueconf:
Authorization  trueconf:login=[login]&password=[password]&encrypt=1

trueconf:login=user&password=pswd&encrypt=1

Authorization on another server  trueconf:h=[TrueConfServer]&login=[login]&password=[password]&encrypt=1

trueconf:h=192.168.12.123&login=user&password=pswd&encrypt=1

Calling User
Call within a server trueconf:[user]

trueconf:ivan

Call to another server trueconf:[user]@[TrueConfServer]

trueconf:ivan@192.168.12.123 

Joining Conference
Joining a conference \c\CID  trueconf:\c\[CID]

trueconf:\c\4154248070

trueconf:4154248070&conftype=multi

Call to a conference where [user] is a host  trueconf:[user]&conftype=hotquery

trueconf:ivan&conftype=hotquery

Connecting to Streaming
Join an RTSP broadcast trueconf:[#rstp]

trueconf:#rtsp://domainn.company.com:554

Other Functions
Close an application after end of call/conference Add &autoclose=1 to the end of any command

trueconf:ivan&autoclose=1

User authorization and call to a conference or another user can be combined in one command:

trueconf:\c\4154248070&login=user&password=pswd&encrypt=1

How to Change Default Application

At times, two TrueConf client applications are installed on the user’s computer at the same time: classic (TrueConf Client) and new (TrueConf for Windows), but commands controlled by trueconf: protocol are still forwarded to an obsolete version of an application.

This means that TrueConf Client was installed later than TrueConf for Windows, as trueconf: protocol commands are forwarded to the latest installed (or updated) version of an application.

As already mentioned above, trueconf: protocol is intended for use in TrueConf for Windows, and it is desirable that commands are forwarded to this client application. To do this, download and install it again (it is not necessary to delete it before this.)