To start an implementation based on the Rtcc SDKs and on the SightCall's platform, you will find all that you need on the portal: account.sightcall.com.
The account.sightcall.com website contains a summary of all the mandatory values that are required to connect to the cloud and initialize the clients SDKs.
The AppId uniquely identifies your account. It is also known as your provider identifier. This key is not meant to be secret and is used by SDK to identify your account to the Cloud. The App Id can be found in the credential tab of account.
Inside this same page, you can find two fields:
- Authentication API Client Identifier
- Authentication API Client Secret
The concatenation of those two fields gives you your API Key. This key is mandatory to access the Rtcc REST API. In particular, you need to access this API to obtain the tokens SDKs need to connect to the cloud. More generaly, this API Key authenticates your backend for any provider operation on the REST API.
Quotas & Profiles
On the account.sightcall.com website, you can also find the quotas that you have bought. This gives you the maximum number of different users that can connect to the cloud. Users may be from several kinds and quotas are defined per kind of users (see above for profiles definitions)
Kinds of users
There are several kinds of users that can connect to the cloud. Above all, users belong to one of these two categories:
- internal users
- external users
Internal users are authenticated users.
Once the front end application authenticated on its backend (not linked with Rtcc), the back end requires a token to the sightcall cloud. The request for a token is secured with the API Key of the provider. The request specifies the uid of the user and its profile. The back end sends it to the front end that gives it to the Rtcc SDK (web or mobile). With that token, the SDK authenticates to the SightCall's platform.
That mecanism allows the application to manage identifiers and credentials of all users internally. The SightCall's platform does not have access to it but only to the time limited token that is dedicated to Rtcc only.
The SightCall's platform allows you to manage several kinds of users that have access to different feature of the platform.
There are currently 5 different profiles for authenticated users in the cloud.
The complete definitions of profiles are described here.
|Standard User||Enables unlimited SightCall one-to-one Real Time sessions to any other Standard or Premium User|
|Premium User||has all the feature of Standard User and adds the ability to host group video conferences with Standard and Premium Users|
|Premium User with Recording||A premium user with the capability to record his calls and conferences, unlimitedly|
|Premium Plus User||has all the features of Premium User and adds the ability to be called by external users or invite them into a conference which includes audio, video and screen sharing|
|Premium Plus User with Recording||A premium plus user with the capability to record his calls and conferences, unlimitedly|
Profiles are ordered from the one that has the less rights to the one that can access all the services of the platform.
External users are not token authenticated users.
They do connect using the uid of an authenticated user and are "affiliated" to him. External user can only call their "referent" user or join a multiparty this "referent" user has created.
External users are designed for user that connects one time like users of a support service or of an hotline (to talk to an agent that is an authenticatd user). "Referent" users of externals are at least Premium Plus users.
Choosing the right types of users
One-to-one calling with authenticated users: If your application requires all users to sign into your platform, and all you need is one-to-one calling, then the best types of users are Standard Users. Both users at the end of each call need to be associated with a standard type of user.
E.g. with our sample PHP Authentication client (https://github.com/sightcall/Authentication-Client/blob/master/PHP/gettoken.php)
// Set the client and profile identifiers as appropriate for your RTCC installation $identifier_client = "yourdomain.com"; $id_profile = "standard";
*recording option NOT available
Multiparty calling with authenticated users: If your application requires all users to sign in to your platform, and all you need is multiparty calling, then the best types of users are Standard Users and Premium Users. Those hosting the multiparty calls would be your Premium Users, and everyone else would be Standard Users. Instead of a default value for id_profile, your authentication client should be modify to accept an input parameter
e.g in PHP below
$id_profile = $_GET[“profile”] $uid = $_GET[“uid”]
The caller page will call the following url:
- for the host: http://localhost:3000/gettoken.php?uid=user1&profile=premium
- for the other users: http://localhost:3000/gettoken.php?uid=user2&profile=standard
One-to-one calling with authenticated and unauthenticated users: If you need a call center type solution where many unauthenticated users are calling into speak to an authenticated user, then the best types of users are Plus Users. Those calling would be the many unauthenticated users, and the authenticated user receiving all those calls would be the Plus User, which can host all those unauthenticated users.
// Set the client and profile identifiers as appropriate for your RTCC installation $identifier_client = "yourdomain.com"; $id_profile = "premium_plus";
*recording option available