/callConfig ⇒

GET

This API is used to fetch the meeting configurations, such as audio calls, video calls, and live chat features for the call.

Your application server must provide a /callConfig endpoint to Android/Web/IOS clients to fetch the call configurations.

API signature in your application server.

* ENDPOINT :	'/callConfig'
* METHOD   :	GET
* HEADERS  :	Content-type: application/json
* RESPONSE :	{ "error": null, "data" : <Call configurations data> }

To implement the /callConfig API under your application server use the following details.

* ADMIN BACKEND BASE URL : https://admin.<example.com>/api
* METHOD                 : GET
* API ENDPOINT           : /configuration
* HEADERS                : Content-type: application/json

code snippet

Sample implementation of /callConfig API using nodejs technology.

const axios = require("axios");

const ADMIN_BACKEND_URL = "https://admin.<example.com>/api";
const endpoint = "/configuration";

const response = await axios.get(ADMIN_BACKEND_URL + endpoint, req, {
  headers: { "Content-type": "application/json" },
});

return { error: null, data: response };

Sample response from Admin Control.

{
	"error": null,
	"data": {
		"features": {
			"audio_call": true,
			"video_call": true,
			"live_chat": true,
			"waiting_room": true,
			"screen_sharing": true,
			"desktop_streaming": true,
			"moderator_control": true,
			"transcript": true,
			"auto_centering": true,
			"client_side_recording": true,
			"server_side_recording": true
		}
	}
}

Response expected by Android/Web/IOS clients from Your Application Server.

{
	"error": null,
	"data": {
		"features": {
			"audio_call": true,
			"video_call": true,
			"live_chat": true,
			"waiting_room": true,
			"screen_sharing": true,
			"desktop_streaming": true,
			"moderator_control": true,
			"transcript": true,
			"auto_centering": true,
			"client_side_recording": true,
			"server_side_recording": true
		}
	}
}

Error Codes:

401 : Unauthorized (If authentication token is invalid or expired)

{
	"data": null,
	"error": {
        	"code": 401,
        	"message": "Unauthorized"
    		 }
}

404 : Not Found (If invalid url or wrong http method is used)

{
	"error": {
    		"code": 404,
        	 "message": "Not found"
    		 },
	"data": null
}

500 : Internal Server Error (If there is any exception on server side)

{
	"error": {
    		"code": 500,
        	 "message": "Internal server error"
    		 },
	"data": null
}

If your application server is built on Node.js technology, the ProCONF server SDK's getCallConfig() method can be used. To integrate proconf-server-sdk please click here.

Call the getCallConfig() server SDK method into your application server,

const callConfig = await serverSDK.getCallConfig();