ApiRTC

This documentation describes ApiRTC version 3.18

ApiRTC is our real time Web communication library. It will enable you to easily add communication (chat, audio, video, fie transfer, drawings) into your application

ApiRTC Library

ApiRTC Architecture

To help you in the developpement of your application, ApiRTC is composed of several modules :

Modules description

ApiRTC : Global ApiRTC module
ApiRTCSession : Session module - server connection (Presence)
ApiRTCWebRTCClient : WebRTC module - calls establishment management (audio, video, datachannel)
ApiRTCIMClient : Instant messaging module
ApiRTCDataClient : Data module - data exchange through ApiRTC server
ApiRTCWhiteBoardClient : Whiteboard module

All methods and events modules are described on our API Reference

Quickstart : Start using ApiRTC

Create your account to get your apiKey

Apikey is used to authentify your account

Create your account using following link : GET A KEY

How to load apiRTC

  • apiRTC-latest

We advice you to use following links to be sure to have an updated version of apiRTC :

<script src="https://cloud.apizee.com/apiRTC/apiRTC-latest.min.js"></script>
  • load a specific version

In the case, you prefer to control the version :

<script src="https://cloud.apizee.com/apiRTC/v3.4/apiRTC-3.4.min.js"></script>
  • load a version with debuging infos in console :

simply add "debug" extension on the link :

<script src="https://cloud.apizee.com/apiRTC/apiRTC-latest.min.debug.js""></script>

apiRTC initialization

  • Start the connection :

This establish a connection with our communications servers :

//apiRTC initialization
apiRTC.init({
    apiKey : "your-ApiKey",
    //apiCCId : "1",
    onReady : sessionReadyHandler
});
  • apiCCId : Customize your userId

Using apiCCId, enables you to set the userId to identify the user. This is done, for instance if you already have
a user database in your Web Site or intranet.

You only have to add the parameter "apiCCId" in the apirtc.init() function in set it with your userId.
For example, to set a userId to "1" :

apiRTC.init({
    apiKey : "myDemoApiKey",
    apiCCId : "1",
    onReady : sessionReadyHandler
});

Using events

Here is an example of using the "incomingCall" event:

function incomingCallHandler(event) {
    if(event.detail.autoAnswerActivated === false) { 
        playRingTone();
    }
}

apiRTC.addEventListener("incomingCall", incomingCallHandler);

The handler “incomingCallHandler()” is called when an event “incomingCall” is fired, you can then access detail of the event using “event.detail."
Ex : event.detail.autoAnswerActivated for an incomingCall event.

Check description of the events in the API documentation to learn about the available parameters on the different events.

API Reference

Check our API Reference to have a complete description of available methods and events.

Tutorials

Several tutorials are available on our Tutorials page.

Authentication

A third party server authentication can be used in order to secure your users connections, check the description : Authentication

Compatibility

ApiRTC keeps evolving to follow WebRTC Standard and Browser support evolutions.
Browsers and OS compatibility is described on our page : Compatibity

Change Log

Check our Change Log page