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.

Get started

Generate embed code

Add the embed code into any web page

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 Add a Conference

To add 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 :

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

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”

Sample Request

{

“action” : “Add”,

“username” : “apiuser”,

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

“name” : “Conference-1”,

“audio” : “on”,

“video” : “off”,

“chat” : “off”

}

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
audio string The audio settings of the conference
video string The video settings of the conference
chat string The chat settings 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” : “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”,“audio” : “on”, “video” : “off”, “chat” : “off”}’ -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”,“audio” : “on”, “video” : “off”, “chat” : “off”});

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”,

 audio : “on”,

 video : “off”,

 chat : “off”

}

function(data ,status){});

import requests

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

obj = {

 action : “Add”,

 username : “apiuser”,

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

 name : “Conference-1”

 audio : “on”,

 video : “off”,

 chat : “off”

}

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

print(x.text)

var values = new Dictionary<string, string>

{

 action : “Add”,

 username : “apiuser”,

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

 name : “Conference-1”

 audio : “on”,

 video : “off”,

 chat : “off”

};

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” +

 ”  \”audio\”: \”on\”,\n” +

 ”  \”video\”: \”off\”,\n” +

 ”  \”chat\”: \”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/videoConfSettings“)

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

user = {

         action : “Add”,

         username : “apiuser”,

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

         name : “Conference-1”

         audio : “on”,

         video : “off”,

         chat : “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{}{

               “action”: “Add”,

               “username”:  “apiuser”,

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

               “name”: “Conference-1”

               “audio” : “on”,

               “video” : “off”,

               “chat” : “off”

        }

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’

    ‘audio’ => ‘on’

    ‘video’ => ‘off’

    ‘chat’ => ‘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 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 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);

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 = ‘https://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 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/conference/################”

}

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 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/conference/################”

}

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);