Due to the COVID-19 restrictions, our support executives are operating from 6 AM to 11:59 PM IST.

LiveboxTM

Video Conferencing API

Integrate video conferencing into any Website or Application quickly and easily using the in-built APIs and SDKs available within Livebox. Mobile SDK available on request.

Step 1 : Enable User

Make sure that the API permission has been enabled by your livebox admin.

Step 2 : Create Conference

Now, create a conference using the API URL: /livebox/appsservice/api
/videoConfSettings with a new conference name

Step 3 : Enable Conference

Once the conference is created Then, we need to enable the conference using the API URL: /livebox/appsservice/api /videoConfSettings

Step 4 : Get Embed Code

Finally, to get the embed code send a request to the API URL: /livebox/appsservice/api /getEmbedCodeofConference for the created conference

Enable User

Create Conference

Enable Conference

Get Embed Code

To Create a Conference

To create a video conference to the list, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “Add”

The request object can be sent in three ways, according to the user specification, and here is an example of our request, when the user does not need any authentication: 

Sample Request

{

“action” : “Add”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “false”

}

For authenticated users, Here’s an example of our sample request :

Sample Request

{

“action” : “Add”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “true”,

“AllowSignup” : “false”,

“UnAuthenticatedUser” : “false”,

“username_password” : “true”,

“pinnumber” : “false”,

}

If the user needs to allow either allow sign up option or the unauthenticated user option, Here’s an example of our sample request :

Sample Request

{

“action” : “Add”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “true”,

“AllowSignup” : {Preset: “Preset-1”},

“UnAuthenticatedUser” : {Preset: “Preset-1”},

“username_password” : “true”,

“pinnumber” : “false”,

}

Request Parameters

Parameters Type Description
action string The type of action by the user
username string The username for the conference
key string The password for the conference
name string The name of the conference
selectPreset string The preset settings for the conference
Authentication string The authentication settings for the conference
AllowSignup string The setting to allow signup option in the conference
UnAuthenticatedUser string The setting to allow Guest user option in the conference
username_password string The setting to allow username and password option in the conference
pinnumber string The setting to allow pin number option in the conference
Preset string The preset settings for the signup user or the guest user
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps

Sample Response

{

“name” : “Conference-1”,

“status” : “Added”,

“hashKey” : “################”

}

Response Parameters

Parameters Type Description
name string The name of the conferences
status string The status of the action
hashKey string The unique reference key for the action
Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“action” : “Add”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“action” : “Add”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”,

 selectPreset : “Preset-1”,

 Authentication : “false”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”action\”: \”Add\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”selectPreset\”: \”Preset-1\”,\n” +

 ”  \”Authentication\”: \”false\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

         action : “Add”,

         username : “apiuser”,

         key : “################”,

         name : “Conference-1”,

         selectPreset : “Preset-1”,

         Authentication : “false”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “action”: “Add”,

               “username”:  “apiuser”,

               “key”: “################”,

               “name”: “Conference-1”,

               “selectPreset” : “Preset-1”,

               “Authentication” : “false”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/videoConfSettings”; 

$ch = curl_init($url);

$jsonData = array(

    ‘action’ => ‘Add’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘name’ => ‘Conference-1’,

    ‘selectPreset’ => ‘Preset-1’,

    ‘Authentication’ => ‘false’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Enable the Conference

To enable the video conference, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings ,  and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “changeConferenceMode”

Sample Request

{

“name” : “Conference-1”,

“action” : “changeConferenceMode”,

“conferenceMode” : “on”,

“username” : “apiuser”,

“key” : “################”

}

Request Parameters

Parameters Type Description
name string The name of the conference
action string The type of action by the user
conferenceMode string The on/off status of the conference
username string The username for the conference
key string The password for the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Sample Response

{

“name” : “Conference-1”,

“status” : “Enabled”,

“conferencelink” : “https://server_url//lbmeeting/?key=################

}

Response Parameters

Parameters Type Description
name string The name of the conferences
status string The status of the action
conferencelink string The link to the conference

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“name” : “Conference-1”, “action” : “changeConferenceMode”, “conferenceMode” : “on”, “username” : “apiuser”, “key” : “################”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings  

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“name” : “Conference-1”, “action” : “changeConferenceMode”, “conferenceMode” : “on”, “username” : “apiuser”, “key” : “################”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

“name” : “Conference-1”,

“action” : “changeConferenceMode”,

“conferenceMode” : “on”,

“username” : “apiuser”,

“key” : “################”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 name : “Conference-1”,

 action : “changeConferenceMode”,

 conferenceMode : “on”,

 username : “apiuser”,

 key : “################”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 name : “Conference-1”,

 action : “changeConferenceMode”,

 conferenceMode : “on”,

 username : “apiuser”,

 key : “################”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”action\”: \”changeConferenceMode\”,\n” +

 ”  \”conferenceMode\”: \”on\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

        name : “Conference-1”,

        action : “changeConferenceMode”,

        conferenceMode : “on”,

        username : “apiuser”,

        key : “################”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

        “name” : “Conference-1”,

        “action” : “changeConferenceMode”,

        “conferenceMode” : “on”,

        “username” : “apiuser”,

        “key” : “################”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/videoConfSettings“; 

$ch = curl_init($url);

$jsonData = array(

    ‘name’ => ‘Conference-1’,

    ‘action’ => ‘changeConferenceMode’,

    ‘conferenceMode’ => ‘on’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Get Embed Code for the Conference

To get the embed code for the video conference, we can send a request to the URL: /livebox/appsservice/api/getEmbedCodeofConference, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST

Sample Request

{

“name” : “Conference-1”,

“username” : “apiuser”,

“key” : “################”,

“height” : “400px”,

“width” : “400px”

}

Request Parameters

Parameters Type Description
name string The name of the conference
height string The height of the frame
width string The width of the frame
username string The username for the conference
key string The password for the conference

Sample Response

<iframe scrolling src=” https://server_url/apps/apiservice/api/getEmbedCodeofConference” width=”400px” height=”400px” allowfullscreen webkitallowfullscreen mozallowfullscreen oallowfullscreen msallowfullscreen ></iframe>

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“name” : “Conference-1”, “username” : “apiuser”, “key” : “################” “height” : “400px”, “width” : “400px”,}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/getEmbedCodeofConference

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“name” : “Conference-1”, “username” : “apiuser”, “key” : “################” “height” : “400px”, “width” : “400px”,});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/getEmbedCodeofConference‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“,

{

“name” : “Conference-1”,

“username” : “apiuser”,

“key” : “################”

“height” : “400px”,

“width” : “400px”,

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/getEmbedCodeofConference

obj = {

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/getEmbedCodeofConference“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 ”  \”height\”: \”400px\”,\n” +

 ”  \”width\”: \”400px\”,\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“)

header = {‘Content-Type’: ‘text/json’}

user = {

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/getEmbedCodeofConference“; 

$ch = curl_init($url);

$jsonData = array(

    ‘name’ => ‘Conference-1’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘height’ => ‘400px’,

    ‘width’ => ‘400px’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Change the Conference Settings

To change the conference settings , we can send a request to the URL: /livebox/appsservice/api/videoConfSettings, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST

Request action : “changeConferenceSettings”

The request object can be sent in three ways, according to the user specification, and here is an example of our request, when the user does not need any authentication:  

Sample Request

{

“action” : “changeConferenceSettings”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “false”

}

For authenticated users, Here’s an example of our sample request :

Sample Request

{

“action” : “changeConferenceSettings”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “true”,

“AllowSignup” : “false”,

“UnAuthenticatedUser” : “false”,

“username_password” : “true”,

“pinnumber” : “false”,

}

If the user needs to allow either allow sign up option or the unauthenticated user option, Here’s an example of our sample request :

Sample Request

{

“action” : “changeConferenceSettings”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”,

“selectPreset” : “Preset-1”,

“Authentication” : “true”,

“AllowSignup” : {Preset: “Preset-1”},

“UnAuthenticatedUser” : {Preset: “Preset-1”},

“username_password” : “true”,

“pinnumber” : “false”,

}

Request Parameters

Parameters Type Description
action string The type of action by the user
username string The username for the conference
key string The password for the conference
name string The name of the conference
selectPreset string The preset settings for the conference
Authentication string The authentication settings for the conference
AllowSignup string The setting to allow signup option in the conference
UnAuthenticatedUser string The setting to allow Guest user option in the conference
username_password string The setting to allow username and password option in the conference
pinnumber string The setting to allow pin number option in the conference
Preset string The preset settings for the signup user or the guest user
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps

Response status: success

Response data: Changed

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“action” : “changeConferenceSettings”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“action” : “changeConferenceSettings”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

 action : “changeConferenceSettings”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”,

 selectPreset : “Preset-1”,

 Authentication : “false”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 action : “changeConferenceSettings”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 action : “changeConferenceSettings”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”action\”: \”changeConferenceSettings\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”selectPreset\”: \”Preset-1\”,\n” +

 ”  \”Authentication\”: \”false\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

         action : “changeConferenceSettings”,

         username : “apiuser”,

         key : “################”,

         name : “Conference-1”,

         selectPreset : “Preset-1”,

         Authentication : “false”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “action”: “changeConferenceSettings”,

               “username”:  “apiuser”,

               “key”: “################”,

               “name”: “Conference-1”,

               “selectPreset” : “Preset-1”,

               “Authentication” : “false”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/videoConfSettings”; 

$ch = curl_init($url);

$jsonData = array(

    ‘action’ => ‘changeConferenceSettings’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘name’ => ‘Conference-1’,

    ‘selectPreset’ => ‘Preset-1’,

    ‘Authentication’ => ‘false’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Disable the Conference

To disable the video conference, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “changeConferenceMode”

Sample Request

{

“name” : “Conference-1”,

“action” : “changeConferenceMode”,

“conferenceMode” : “off”,

“username” : “apiuser”,

“key” : “################”

}

Request Parameters

Parameters Type Description
name string The name of the conference
action string The type of action by the user
conferenceMode string The on/off status of the conference
username string The username for the conference
key string The password for the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Sample Response

{

“name” : “Conference-1”,

“status” : “Disabled”,

“conferencelink” : “https://server_url/lbmeeting/?key=################”

}

Response Parameters

Parameters Type Description
name string The name of the conferences
status string The status of the action
conferencelink string The link to the conference
Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“name” : “Conference-1”, “action” : “changeConferenceMode”, “conferenceMode” : “off”, “username” : “apiuser”, “key” : “################”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“name” : “Conference-1”, “action” : “changeConferenceMode”, “conferenceMode” : “off”, “username” : “apiuser”, “key” : “################”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

“name” : “Conference-1”,

“action” : “changeConferenceMode”,

“conferenceMode” : “off”,

“username” : “apiuser”,

“key” : “################”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 name : “Conference-1”,

 action : “changeConferenceMode”,

 conferenceMode : “off”,

 username : “apiuser”,

 key : “################”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 name : “Conference-1”,

 action : “changeConferenceMode”,

 conferenceMode : “off”,

 username : “apiuser”,

 key : “################”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”action\”: \”changeConferenceMode\”,\n” +

 ”  \”conferenceMode\”: \”off\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

        name : “Conference-1”,

        action : “changeConferenceMode”,

        conferenceMode : “off”,

        username : “apiuser”,

        key : “################”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

        “name” : “Conference-1”,

        “action” : “changeConferenceMode”,

        “conferenceMode” : “off”,

        “username” : “apiuser”,

        “key” : “################”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/videoConfSettings“; 

$ch = curl_init($url);

$jsonData = array(

    ‘name’ => ‘Conference-1’,

    ‘action’ => ‘changeConferenceMode’,

    ‘conferenceMode’ => ‘off’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Remove a Conference

To remove a video conference from the list, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “Remove”

Sample Request

{

“action” : “Remove”,

“username” : “apiuser”,

“key” : “################”,

“name” : “Conference-1”

}

Request Parameters

Parameters Type Description
action string The type of action by the user
username string The username for the conference
key string The password for the conference
name string The name of the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Sample Response

{

“name” : “Conference-1”,

“status” : “Removed”,

“hashKey” : “################”

}

Response Parameters

Parameters Type Description
name string The name of the conferences
status string The status of the action
hashKey string The unique reference key for the action

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“action” : “Remove”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“action” : “Remove”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”}};

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

 action : “Remove”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 action : “Remove”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 action : “Remove”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”action\”: \”Remove\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”name\”: \”Conference-1\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

         action : “Remove”,

         username : “apiuser”,

         key : “################”,

         name : “Conference-1”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “action”: “Remove”,

               “username”:  “apiuser”,

               “key”: “################”,

               “name”: “Conference-1”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = ‘https://server_url/livebox/appsservice/api/videoConfSettings’; 

$ch = curl_init($url);

$jsonData = array(

    ‘action’ => ‘Remove’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

    ‘name’ => ‘Conference-1’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Get List of Conferences

To get the video conferences list, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings , and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request Action: “get”

Sample Request

{

“action” : “get”,

“username” : “apiuser”,

“key” : “################”

}

Request Parameters

Parameters Type Description
action string The type of action by the user
username string The username for the conference
key string The password for the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Sample Response

{

“ConferenceName” : “Conference-1”,

“CreatedFrom” : “192.168.255.255”,

“CreatedDate” : “dd-mm-yyyy hr:min:sec”,

“Hashkey” : “################”,

“Mode” : “off”

}

Response Parameters

Parameters Type Description
ConferenceName string The name of the conferences
CreatedFrom string The IP from which the conference is created
CreatedDate string The date when the conference was created
Hashkey string The unique reference key for the action
Mode string The mode of the conference
Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“action”: ”get”, “username”: ”apiuser”, “key”:”################”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“action”: ”get”, “username”: ”apiuser”, “key”:”################”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

 action : “get”,

 username : “apiuser”,

 key : “################”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 action : “get”,

 username : “apiuser”,

 key : “################”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 action : “get”,

 username : “apiuser”,

 key : “################”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”action\”: \”get\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

         action : “get”,

         username : “apiuser”,

         key : “################”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “action”: “get”,

               “username”:  “apiuser”,

               “key”: “################”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = ‘https://server_url/livebox/appsservice/api/videoConfSettings’; 

$ch = curl_init($url);

$jsonData = array(

    ‘action’ => ‘get’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Set Scheduling for the Conference

To set the scheduling for the video conference, we can send a request to the URL: /livebox/appsservice/api/changeSchedulingMode, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST

Sample Request

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

}

Request Parameters

Parameters Type Description
AuthenticationDetails string The authentication details of the user
conferenceName string The name of the conference
SchedulingMode string The status of the scheduling
username string The username for the conference
key string The password for the conference
startdate string The start date of scheduling
enddate string The end date of scheduling

Response data :  Scheduled

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“AuthenticationDetails” : { “username” : “apiuser”, “key” : “################”}, “conferenceName” : “Conference-1”, “SchedulingMode” : “on”,“startdate” : “dd-mm-yyyy hr:min:sec”, “enddate” : “dd-mm-yyyy hr:min:sec”}’-H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/changeSchedulingMode

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“AuthenticationDetails” : { “username” : “apiuser”, “key” : “################”}, “conferenceName” : “Conference-1”, “SchedulingMode” : “on”,“startdate” : “dd-mm-yyyy hr:min:sec”, “enddate” : “dd-mm-yyyy hr:min:sec”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/changeSchedulingMode‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/changeSchedulingMode“,

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/changeSchedulingMode

obj = {

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/changeSchedulingMode“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/changeSchedulingMode“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”AuthenticationDetails\”: \”{\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “},\n” +

 ”  \”conferenceName\”: \”Conference-1\”,\n” +

 ”  \”SchedulingMode\”: \”on\”,\n” +

 ”  \”startdate\”: \”dd-mm-yyyy hr:min:sec\”,\n” +

 ”  \”enddate\”: \”dd-mm-yyyy hr:min:sec\”\n” +

“}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/changeSchedulingMode“)

header = {‘Content-Type’: ‘text/json’}

user = {

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

}

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “on”,

“startdate” : “dd-mm-yyyy hr:min:sec”,

“enddate” : “dd-mm-yyyy hr:min:sec”

}

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/changeSchedulingMode“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/changeSchedulingMode“; 

$ch = curl_init($url);

$jsonData = array(

    ‘AuthenticationDetails’ => array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

    ),

    ‘conferenceName’ => ‘Conference-1’,

    ‘SchedulingMode’ => ‘on’,

    ‘startdate’ => ‘dd-mm-yyyy hr:min:sec’,

    ‘enddate’ => ‘dd-mm-yyyy hr:min:sec’  

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Unset Scheduling for the Conference

To unset the scheduling for the video conference, we can send a request to the URL: /livebox/appsservice/api/changeSchedulingMode, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request : POST

Sample Request

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

}

Request Parameters

Parameters Type Description
AuthenticationDetails string The authentication details of the user
conferenceName string The name of the conference
SchedulingMode string The status of the scheduling
username string The username for the conference
key string The password for the conference

Response data :  Cancelled

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“AuthenticationDetails” : { “username” : “apiuser”, “key” : “################”}, “conferenceName” : “Conference-1”, “SchedulingMode” : “off”}’-H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/changeSchedulingMode

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“AuthenticationDetails” : { “username” : “apiuser”, “key” : “################”}, “conferenceName” : “Conference-1”, “SchedulingMode” : “off”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/changeSchedulingMode‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/changeSchedulingMode“,

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/changeSchedulingMode

obj = {

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/changeSchedulingMode“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/changeSchedulingMode“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”AuthenticationDetails\”: \”{\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “},\n” +

 ”  \”conferenceName\”: \”Conference-1\”,\n” +

 ”  \”SchedulingMode\”: \”off\”\n” +

“}”;  

StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/changeSchedulingMode“)

header = {‘Content-Type’: ‘text/json’}

user = {

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

}

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

“AuthenticationDetails” :

{

        “username” : “apiuser”,

        “key” : “################”

},

“conferenceName” : “Conference-1”,

“SchedulingMode” : “off”

}

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/changeSchedulingMode“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/changeSchedulingMode“; 

$ch = curl_init($url);

$jsonData = array(

    ‘AuthenticationDetails’ => array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

    ),

    ‘conferenceName’ => ‘Conference-1’,

    ‘SchedulingMode’ => ‘off’

    ); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Reset All Conference

To reset all conferences, we can send a request to the URL: /livebox/appsservice/api/resetAllConferences and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST

Sample Request

{

“name” : “Conference-1”,

“username” : “apiuser”,

“key” : “################”

}

Request Parameters

Parameters Type Description
name string The name of the conference
username string The username for the conference
key string The password for the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Response status: success

Response data: Reset

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“name” : “Conference-1, “username” : “apiuser”, “key” : “################”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/resetAllConferences

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“name” : “Conference-1”, “username” : “apiuser”, “key” : “################”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/resetAllConferences‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/resetAllConferences“,

{

“name” : “Conference-1”,

“username” : “apiuser”,

“key” : “################”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/resetAllConferences

obj = {

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/resetAllConferences“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/resetAllConferences“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/resetAllConferences“)

header = {‘Content-Type’: ‘text/json’}

user = {

        name : “Conference-1”,

        username : “apiuser”,

        key : “################”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

        “name” : “Conference-1”,

        “username” : “apiuser”,

        “key” : “################”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/resetAllConferences“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/resetAllConferences”

$ch = curl_init($url);

$jsonData = array(

    ‘name’ => ‘Conference-1’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Start Service Actions

To start the service action, we can send a request to the URL: /livebox/appsservice/api/ControlInsideAppServices, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “start”

Sample Request

{

“username” : “apiuser”,

“key” : “################”,

“action” : “start”,

“appservice” : “VideoConferencingService”

}

Request Parameters

Parameters Type Description
username string The username for the conference
key string The password for the conference
action string The type of action by the user
appservice string The name of the service
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Response Data: Started  

Response Status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“username” : “apiuser”, “key” : “################”, “action” : “start”, “appservice” : “VideoConferencingService”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/ControlInsideAppServices

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“username” : “apiuser”, “key” : “################”, “action” : “start”, “appservice” : “VideoConferencingService”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/ControlInsideAppServices‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“,

{

 username : “apiuser”,

 key : “################”,

 action : “start”,

 appservice : “VideoConferencingService”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/ControlInsideAppServices

obj = {

 username : “apiuser”,

 key : “################”,

 action : “start”,

 appservice : “VideoConferencingService”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 username : “apiuser”,

 key : “################”,

 action : “start”,

 appservice : “VideoConferencingService”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/ControlInsideAppServices“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”action\”: \”start\”,\n” +

 ”  \”appservice\”: \”VideoConferencingService\”\n” +

“}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“)

header = {‘Content-Type’: ‘text/json’}

user = {

        username : “apiuser”,

        key : “################”,

        action : “start”,

        appservice : “VideoConferencingService”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{

               “username” : “apiuser”,

               “key” : “################”,

               “action” : “start”,

               “appservice” : “VideoConferencingService”

               }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “ttps://server_url/livebox/appsservice/api/ControlInsideAppServices“; 

$ch = curl_init($url);

$jsonData = array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘action’ => ‘start’,

    ‘appservice’ => ‘VideoConferencingService’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Stop Service Actions

To stop the service action, we can send a request to the URL: /livebox/appsservice/api/ControlInsideAppServices, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “stop”

Sample Request

{

“username” : “apiuser”,

“key” : “################”,

“action” : “stop”,

“appservice” : “VideoConferencingService”

}

Request Parameters

Parameters Type Description
username string The username for the conference
key string The password for the conference
action string The type of action by the user
appservice string The name of the service
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Response Data: Stopped

Response Status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“username” : “apiuser”, “key” : “################”, “action” : “stop”, “appservice” : “VideoConferencingService”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/ControlInsideAppServices

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“username” : “apiuser”, “key” : “################”, “action” : “stop”, “appservice” : “VideoConferencingService”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/ControlInsideAppServices‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“,

{

 username : “apiuser”,

 key : “################”,

 action : “stop”,

 appservice : “VideoConferencingService”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/ControlInsideAppServices

obj = {

 username : “apiuser”,

 key : “################”,

 action : “stop”,

 appservice : “VideoConferencingService”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 username : “apiuser”,

 key : “################”,

 action : “stop”,

 appservice : “VideoConferencingService”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/ControlInsideAppServices“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”action\”: \”stop\”,\n” +

 ”  \”appservice\”: \”VideoConferencingService\”\n” +

“}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“)

header = {‘Content-Type’: ‘text/json’}

user = {

        username : “apiuser”,

        key : “################”,

        action : “stop”,

        appservice : “VideoConferencingService”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{

               “username” : “apiuser”,

               “key” : “################”,

               “action” : “stop”,

               “appservice” : “VideoConferencingService”

               }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/ControlInsideAppServices“; 

$ch = curl_init($url);

$jsonData = array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘action’ => ‘stop’,

    ‘appservice’ => ‘VideoConferencingService’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Restart Service Actions

To stop the service action, we can send a request to the URL: /livebox/appsservice/api/ControlInsideAppServices, and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST
Request action: “restart”

Sample Request

{

“username” : “apiuser”,

“key” : “################”,

“action” : “restart”,

“appservice” : “VideoConferencingService”

}

Request Parameters

Parameters Type Description
username string The username for the conference
key string The password for the conference
action string The type of action by the user
appservice string The name of the service
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Response Data: Restarted

Response Status: success

Requests

Here’s an example of  requests in various programming languages :

$ curl -d ‘{“username” : “apiuser”, “key” : “################”, “action” : “restart”, “appservice” : “VideoConferencingService”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/ControlInsideAppServices

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“username” : “apiuser”, “key” : “################”, “action” : “restart”, “appservice” : “VideoConferencingService”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/ControlInsideAppServices‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“,

{

 username : “apiuser”,

 key : “################”,

 action : “restart”,

 appservice : “VideoConferencingService”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/ControlInsideAppServices

obj = {

 username : “apiuser”,

 key : “################”,

 action : “restart”,

 appservice : “VideoConferencingService”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 username : “apiuser”,

 key : “################”,

 action : “restart”,

 appservice : “VideoConferencingService”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/ControlInsideAppServices“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”action\”: \”restart\”,\n” +

 ”  \”appservice\”: \”VideoConferencingService\”\n” +

“}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“)

header = {‘Content-Type’: ‘text/json’}

user = {

        username : “apiuser”,

        key : “################”,

        action : “restart”,

        appservice : “VideoConferencingService”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{

               “username” : “apiuser”,

               “key” : “################”,

               “action” : “restart”,

               “appservice” : “VideoConferencingService”

               }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/ControlInsideAppServices“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/ControlInsideAppServices“; 

$ch = curl_init($url);

$jsonData = array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘action’ => ‘restart’,

    ‘appservice’ => ‘VideoConferencingService’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

To Refresh IP Configuration

To refresh the IP configuration, we can send a request to the URL: /livebox/appsservice/api/refreshIPConfiguration,  and please make sure to enter your request parameters without any spaces or any special characters.

If the API is used in the server side, a server secret key must be passed in the request, along with the other requests :

{“Serverkey” : “################”}

If the API is used in the native apps, a native app secret key must be passed in the request, along with the other requests :

{“Nativeappkey” : “################”}

HTTP Request: POST

Sample Request

{

“username” : “apiuser”,

“key” : “################”,

}

Request Parameters

Parameters Type Description
username string The username for the conference
key string The password for the conference
Serverkey string The server secret key for the server
Nativeappkey string The native secret key for native apps.

Response Data :  Refreshed

Response status: success

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“username”: ”apiuser”, “key”:”################”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/refreshIPConfiguration

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“username”: ”apiuser”, “key”:”################”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’, ‘https://server_url/livebox/appsservice/api/refreshIPConfiguration‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/refreshIPConfiguration“,

{

 username : “apiuser”,

 key : “################”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/refreshIPConfiguration

obj = {

 username : “apiuser”,

 key : “################”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 username : “apiuser”,

 key : “################”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/refreshIPConfiguration“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/refreshIPConfiguration“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/refreshIPConfiguration“)

header = {‘Content-Type’: ‘text/json’}

user = {

         username : “apiuser”,

         key : “################”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “username”:  “apiuser”,

               “key”: “################”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/refreshIPConfiguration“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/refreshIPConfiguration“; 

$ch = curl_init($url);

$jsonData = array(

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

Step 2 : Create a Conference

To create a video conference to the list, we can send a request to the URL: /livebox/appsservice/api/videoConfSettings, and please make sure to enter your request parameters without any spaces or any special characters.

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“action” : “Add”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/videoConfSettings

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“action” : “Add”, “username” : “apiuser”, “key” : “################”,“name” : “Conference-1”, “selectPreset” : “Preset-1”, “Authentication” : “false”});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/videoConfSettings‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/videoConfSettings“,

{

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”,

 selectPreset : “Preset-1”,

 Authentication : “false”

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/videoConfSettings

obj = {

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 action : “Add”,

 username : “apiuser”,

 key : “################”,

 name : “Conference-1”

 selectPreset : “Preset-1”,

 Authentication : “false”

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/videoConfSettings“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/videoConfSettings“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

 

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

 

String inputJson = “{\n” +

 ”  \”action\”: \”Add\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”,\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”selectPreset\”: \”Preset-1\”,\n” +

 ”  \”Authentication\”: \”false\”\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/videoConfSettings“)

header = {‘Content-Type’: ‘text/json’}

user = {

         action : “Add”,

         username : “apiuser”,

         key : “################”,

         name : “Conference-1”,

         selectPreset : “Preset-1”,

         Authentication : “false”

        }

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

               “action”: “Add”,

               “username”:  “apiuser”,

               “key”: “################”,

               “name”: “Conference-1”,

               “selectPreset” : “Preset-1”,

               “Authentication” : “false”

        }

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/videoConfSettings“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/videoConfSettings”; 

$ch = curl_init($url);

$jsonData = array(

    ‘action’ => ‘Add’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘name’ => ‘Conference-1’,

    ‘selectPreset’ => ‘Preset-1’,

    ‘Authentication’ => ‘false’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);

Enable Conference

Make sure that the API permission has been enabled by your livebox admin. Here is the link to enable the API permission.
https://knowledgebase.livebox.co.in/how-to-enable-api-permission-for-the-video-conferencing-app

Step 4 : Get Embed Code for the Conference

To get the embed code for the video conference, we can send a request to the URL: /livebox/appsservice/api/getEmbedCodeofConference, and please make sure to enter your request parameters without any spaces or any special characters.

Requests

Here’s an example of requests in various programming languages :

$ curl -d ‘{“name” : “Conference-1”, “username” : “apiuser”, “key” : “################” “height” : “400px”, “width” : “400px”,}’ -H “Content-Type: application/json” -X https://server_url/livebox/appsservice/api/getEmbedCodeofConference

var xhr = new XMLHttpRequest();

var params = JSON.stringify({“name” : “Conference-1”, “username” : “apiuser”, “key” : “################” “height” : “400px”, “width” : “400px”,});

xhr.setRequestHeader(“Content-Type”, “application/json”);

xhr.onreadystatechange = function() {};

xhr.open(‘POST’,’https://server_url/livebox/appsservice/api/getEmbedCodeofConference‘)

xhr.send(params);

$.post(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“,

{

“name” : “Conference-1”,

“username” : “apiuser”,

“key” : “################”

“height” : “400px”,

“width” : “400px”,

}

function(data ,status){});

import requests

url = ‘https://server_url/livebox/appsservice/api/getEmbedCodeofConference

obj = {

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

x = requests.post(url, data = obj)

print(x.text)

var values = new Dictionary<string, string>

{

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

};

var content = new FormUrlEncodedContent(values);

var response = await client.PostAsync(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“, content);

var responseString = await response.Content.ReadAsStringAsync();

public class Post_Request_Apache_HttpClient { 

public void createEmployee() throws ClientProtocolException, IOException {

String postEndpoint = “https://server_url/livebox/appsservice/api/getEmbedCodeofConference“;

CloseableHttpClient httpclient = HttpClients.createDefault();

HttpPost httpPost = new HttpPost(postEndpoint);

httpPost.setHeader(“Accept”, “application/json”);

httpPost.setHeader(“Content-type”, “application/json”);

String inputJson = “{\n” +

 ”  \”name\”: \”Conference-1\”,\n” +

 ”  \”username\”: \”apiuser\”,\n” +

 ”  \”key\”: \”################\”\n” +

 ”  \”height\”: \”400px\”,\n” +

 ”  \”width\”: \”400px\”,\n” +

 “}”; 

 StringEntity stringEntity = new StringEntity(inputJson);

 httpPost.setEntity(stringEntity); 

 HttpResponse response = httpclient.execute(httpPost);

require ‘net/http’

require ‘uri’

require ‘json’

uri = URI.parse(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“)

header = {‘Content-Type’: ‘text/json’}

user = {

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, header)

request.body = user.to_json

response = http.request(request)

func MakeRequest() {

message := map[string]interface{}{

 name : “Conference-1”,

 username : “apiuser”,

 key : “################”

 height : “400px”,

 width : “400px”,

}

bytesRepresentation, err := json.Marshal(message)

if err != nil {

        log.Fatalln(err)

}

resp, err := http.Post(“https://server_url/livebox/appsservice/api/getEmbedCodeofConference“, “application/json”, bytes.NewBuffer(bytesRepresentation))

if err != nil {

        log.Fatalln(err)

}

var result map[string]interface{}

json.NewDecoder(resp.Body).Decode(&result)

}

<?php

$url = “https://server_url/livebox/appsservice/api/getEmbedCodeofConference“; 

$ch = curl_init($url);

$jsonData = array(

    ‘name’ => ‘Conference-1’,

    ‘username’ => ‘apiuser’,

    ‘key’ => ‘################’,

    ‘height’ => ‘400px’,

    ‘width’ => ‘400px’

); 

$jsonDataEncoded = json_encode($jsonData);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’));

$result = curl_exec($ch);