Get In Touch
CD TECH Innovations Pvt Ltd
#95, Pantheon Road, Egmore, Chennai, TN
INDIA 600008
Inquiries
- enquiry@cdtech.in
- Ph +91 80690 78888
CD TECH Innovations Pvt Ltd
#95, Pantheon Road, Egmore, Chennai, TN
INDIA 600008
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.
Make sure that API access is enabled within Livebox
More info
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:
{
"action" : "Add",
"username" : "apiuser",
"key" : "################",
"name" : "Conference-1",
"selectPreset" : "Preset-1",
"Authentication" : "false"
} For authenticated users, Here’s an example of our 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 :
{
"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",
} | 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 |
{
"name" : "Conference-1",
"status" : "Added",
"hashKey" : "################"
} | 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 |
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/videoConfSettingsvar 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 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”
{
"name" : "Conference-1",
"action" : "changeConferenceMode",
"conferenceMode" : "on",
"username" : "apiuser",
"key" : "################"
} | 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. |
{
"name" : "Conference-1",
"status" : "Enabled",
"conferencelink" : "https://server_url//lbmeeting/?key=################"
} | 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
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 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
{
"name" : "Conference-1",
"username" : "apiuser",
"key" : "################",
"height" : "400px",
"width" : "400px"
} | 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 |
<iframe scrolling src=" https://server_url/apps/apiservice/api/getEmbedCodeofConference" width="400px" height="400px" allowfullscreen webkitallowfullscreen mozallowfullscreen oallowfullscreen msallowfullscreen ></iframe>
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/getEmbedCodeofConferencevar 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 , 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:
{
"action" : "changeConferenceSettings",
"username" : "apiuser",
"key" : "################",
"name" : "Conference-1",
"selectPreset" : "Preset-1",
"Authentication" : "false"
} For authenticated users, Here’s an example of our 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 :
{
"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",
} | 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
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/videoConfSettingsvar 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 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”
{
"name" : "Conference-1",
"action" : "changeConferenceMode",
"conferenceMode" : "off",
"username" : "apiuser",
"key" : "################"
} | 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. |
{
"name" : "Conference-1",
"status" : "Disabled",
"conferencelink" : "https://server_url/lbmeeting/?key=################"
} | Parameters | Type | Description |
|---|---|---|
| name | string | The name of the conferences |
| status | string | The status of the action |
| conferencelink | string | The link to the conference |
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/videoConfSettingsvar 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 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”
{
"action" : "Remove",
"username" : "apiuser",
"key" : "################",
"name" : "Conference-1"
} | 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. |
{
"name" : "Conference-1",
"status" : "Removed",
"hashKey" : "################"
} | 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
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/videoConfSettingsvar 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 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”
{
"action" : "get",
"username" : "apiuser",
"key" : "################"
} | 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. |
{
"ConferenceName" : "Conference-1",
"CreatedFrom" : "192.168.255.255",
"CreatedDate" : "dd-mm-yyyy hr:min:sec",
"Hashkey" : "################",
"Mode" : "off"
} | 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 |
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/videoConfSettingsvar 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 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
{
"AuthenticationDetails" :
{
"username" : "apiuser",
"key" : "################"
},
"conferenceName" : "Conference-1",
"SchedulingMode" : "on",
"startdate" : "dd-mm-yyyy hr:min:sec",
"enddate" : "dd-mm-yyyy hr:min:sec"
} | 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
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/changeSchedulingModevar 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 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
{
"AuthenticationDetails" :
{
"username" : "apiuser",
"key" : "################"
},
"conferenceName" : "Conference-1",
"SchedulingMode" : "off"
} | 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
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/changeSchedulingModevar 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 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
{
"name" : "Conference-1",
"username" : "apiuser",
"key" : "################"
} | 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
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/resetAllConferencesvar 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 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”
{
"username" : "apiuser",
"key" : "################",
"action" : "start",
"appservice" : "VideoConferencingService"
} | 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
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/ControlInsideAppServicesvar 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 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”
{
"username" : "apiuser",
"key" : "################",
"action" : "stop",
"appservice" : "VideoConferencingService"
} | 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
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/ControlInsideAppServicesvar 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 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”
{
"username" : "apiuser",
"key" : "################",
"action" : "restart",
"appservice" : "VideoConferencingService"
} | 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
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/ControlInsideAppServicesvar 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 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
{
"username" : "apiuser",
"key" : "################",
} | 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
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/refreshIPConfigurationvar 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 get the preset list, we can send a request to the URL: /livebox/appsservice/api/presetNames, and please make sure to enter your request parameters without any spaces or any special characters.
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 :
{"Serverkey" : "################"} 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" : "################"} HTTP Request: POST
{
"username" : "apiuser",
"key" : "################"
} | 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 |
[ Preset-1, Preset-2, Preset-3 ]
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/presetNamesvar 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/presetNames')
xhr.send(params);
$.post("https://server_url/livebox/appsservice/api/presetNames",
{
"username" : "apiuser",
"key" : "################"
}
function(data ,status){});import requests
url = 'https://server_url/livebox/appsservice/api/presetNames'
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/presetNames", 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/presetNames";
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/presetNames")
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/presetNames", "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/presetNames';
$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 create a preset to the list, we can send a request to the URL: /livebox/appsservice/api/createPreset, 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
{
"username" : "apiuser",
"key" : "###############",
"PresetName": "Preset-1",
"Presetsettings": {
"Hide Video": "on",
"Mute Video": "on"
}
} | Parameters | Type | Description |
|---|---|---|
| username | string | The username for the conference |
| key | string | The password for the conference |
| PresetName | string | The name of the Preset |
| Presetsettings | string | The preset settings for the conference |
| Serverkey | string | The server secret key for the server |
| Nativeappkey | string | The native secret key for native apps |
Preset file created Successfully
Here’s an example of requests in various programming languages :
$ curl -d '{"username" : "apiuser", "key" : "################", "PresetName" : "Preset-1", "Presetsettings" : { "Hide Video" : "on", "Mute Video" : "on"}}' -H "Content-Type: application/json" -X https://server_url/livebox/appsservice/api/createPresetvar xhr = new XMLHttpRequest();
var params = JSON.stringify({"username" : "apiuser", "key" : "################", "PresetName" : "Preset-1", "Presetsettings" : { "Hide Video" : "on", "Mute Video" : "on"}});
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function() {};
xhr.open('POST','https://server_url/livebox/appsservice/api/createPreset')
xhr.send(params);
$.post("https://server_url/livebox/appsservice/api/createPreset",
{
"username" : "apiuser",
"key" : "################",
"PresetName" : "Preset-1",
"Presetsettings" :
{
"Hide Video" : "on",
"Mute Video" : "on"
}
}
function(data ,status){});import requests
url = 'https://server_url/livebox/appsservice/api/createPreset'
obj = {
"username" : "apiuser",
"key" : "################",
"PresetName" : "Preset-1",
"Presetsettings" :
{
"Hide Video" : "on",
"Mute Video" : "on"
}
}
x = requests.post(url, data = obj)
print(x.text)
var values = new Dictionary<string, string>
{
"username" : "apiuser",
"key" : "################",
"PresetName" : "Preset-1",
"Presetsettings" :
{
"Hide Video" : "on",
"Mute Video" : "on"
}
};
var content = new FormUrlEncodedContent(values);
var response = await client.PostAsync("https://server_url/livebox/appsservice/api/createPreset", 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/createPreset";
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" +
" \"PresetName\": \"Preset-1\",\n" +
" \"Presetsettings\": \"{\",\n" +
" \"Hide Video\": \"on\",\n" +
" \"Mute Video\": \"on\"\n" +
"},\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/createPreset")
header = {'Content-Type': 'text/json'}
user = {
"username" : "apiuser",
"key" : "################",
"PresetName" : "Preset-1",
"Presetsettings" :
{
"Hide Video" : "on",
"Mute Video" : "on"
}
}
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" : "################",
"PresetName" : "Preset-1",
"Presetsettings" :
{
"Hide Video" : "on",
"Mute Video" : "on"
}
}
bytesRepresentation, err := json.Marshal(message)
if err != nil {
log.Fatalln(err)
}
resp, err := http.Post("https://server_url/livebox/appsservice/api/createPreset", "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/createPreset";
$ch = curl_init($url);
$jsonData = array(
'username' => 'apiuser',
'key' => '################',
'PresetName' => 'Preset-1',
'Presetsettings' => array(
'Hide Video' => 'on',
'Mute Video' => 'on'
)
);
$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 the preset details, we can send a request to the URL: /livebox/appsservice/api/presetData, and please make sure to enter your request parameters without any spaces or any special characters.
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 :
{"Serverkey" : "################"} 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" : "################"} HTTP Request: POST
{
"username" : "apiuser",
"key" : "################",
"filename": "Preset-1"
} | Parameters | Type | Description |
|---|---|---|
| username | string | The username for the conference |
| key | string | The password for the conference |
| filename | string | The name of the Preset |
| Serverkey | string | The server secret key for the server |
| Nativeappkey | string | The native secret key for native apps |
{
"Hide Video": "on",
"Mute Video": "on"
} Response status: success
| Parameters | Type | Description |
|---|---|---|
| Hide Video | string | The preset settings to hide video |
| Mute Video | string | The preset settings to Mute video |
Here’s an example of requests in various programming languages :
$ curl -d '{"username": "apiuser", "key": "################", "filename": "Preset-1"}' -H "Content-Type: application/json" -X https://server_url/livebox/appsservice/api/presetDatavar xhr = new XMLHttpRequest();
var params = JSON.stringify({"username": "apiuser", "key": "################", "filename": "Preset-1"});
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function() {};
xhr.open('POST','https://server_url/livebox/appsservice/api/presetData')
xhr.send(params);
$.post("https://server_url/livebox/appsservice/api/presetData",
{
"username" : "apiuser",
"key" : "################",
"filename" : "Preset-1"
}
function(data ,status){});import requests
url = 'https://server_url/livebox/appsservice/api/presetData'
obj = {
"username" : "apiuser",
"key" : "################",
"filename" : "Preset-1"
}
x = requests.post(url, data = obj)
print(x.text)
var values = new Dictionary<string, string>
{
"username" : "apiuser",
"key" : "################",
"filename" : "Preset-1"
};
var content = new FormUrlEncodedContent(values);
var response = await client.PostAsync("https://server_url/livebox/appsservice/api/presetData", 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/presetData";
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" +
" \"filename\": \"Preset-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/presetData")
header = {'Content-Type': 'text/json'}
user = {
"username" : "apiuser",
"key" : "################",
"filename" : "Preset-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{}{
"username": "apiuser",
"key": "################",
"filename" : "Preset-1"
}
bytesRepresentation, err := json.Marshal(message)
if err != nil {
log.Fatalln(err)
}
resp, err := http.Post("https://server_url/livebox/appsservice/api/presetData", "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/presetData';
$ch = curl_init($url);
$jsonData = array(
'username' => 'apiuser',
'key' => '################',
'filename' : 'Preset-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);
About Livebox
Live streaming servers, Live Streaming Software, OTT Toolkit, Ad Monetization on Video Player, Video Conferencing, Whitelabelling options, API for developers, Internet Bonding Devices, Live Video Encoders and much more.
Solutions
Head Office
CD TECH Innovations Pvt Ltd
#95, Pantheon Road,
Egmore, Chennai, TN
INDIA 600008
STEP 1 :
Enable User
Step 1 explained
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.
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);
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
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.
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);
Welcome to
Livebox
Schedule a live demo with our live experts to see how Livebox™ can help you to do live streaming the expert way.
Live Streaming is here