Page tree
Skip to end of metadata
Go to start of metadata


Rest API Overview


A RESTful web API (also called a RESTful web service) is a web API implemented using HTTP and REST principles. It is a collection of resources, with four defined aspects:

  • The base URI for the web API, such as https://api.ezuce.com/api/

  • The Internet media type - but can be any other valid Internet media type provided that it is a valid hypertext standard.
  • The set of operations supported by the web API using HTTP methods (POST).
  • The API must be hypertext driven.

How to make a REST call

Make a REST Call function in PHP without using Curl:


function do_post_request($url, $data, $optional_headers = null) 
{
$params = array('http' => array( 'method' => 'POST', 'content' => $data))?
if ($optional_headers !== null) { $params['http']['header'] = $optional_headers?
}
$ctx = stream_context_create($params)? $fp = @fopen($url, 'rb', false, $ctx)?
if (!$fp) {
throw new Exception("Problem with $url, $php_errormsg")?
}
$response = @stream_get_contents($fp)? if ($response === false) {
throw new Exception("Problem reading data from $url, $php_errormsg")?
}
return $response?
}

$url = "https://api.ezuce.com/api/meeting/status"?
$data = "apiLogin=Your_API_Login&apiPassword=You_API_PWD&meetingId=6127664619&meetingPwd=test"? $return = do_post_request($url, $data,null)?


Status of a meeting ( Default returned object )


Address to call:

https://api.ezuce.com/api/meeting/status

Input:

apiLogin: "Your_API_Login" - (str) API login provided by ezuce
apiPassword: "Your_API_password" - (str) API password provided by ezuce
meetingId: "1599829252" - (str) 10 digit meeting number

 

Example : https://api.ezuce.com/api/meeting/status
apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingId=1599829252&meetingPwd=1234

Output:

{

status: "ok" - (str) Status of your REST request
meetingStatus: "running" - (str) ready, running, over
meetingName: "My first test42" - (str) Min 4 char string, name of the meeting
meetingId: "3286566518" - (int) Same 10 digit number
meetingCredits: "81" - (int) Credit value of this meeting
meetingPwd: "21362" - (str) Min 4 char string
meetingNbrParticipants: "5" - (int) Min = 2, Max = 50
meetingDescription: "" - (str) meeting description
meetingAccessCode: "12345" - (str) Min 4 char string
meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p
meetingDuration: "3" - (int) Lengh in hours
meetingType: "0" - (bool) 0 = disable, 2 plenary

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)
optionRecording: "1" - (bool) 0 = disable, 1 enabled
optionH323sip: "3" - (bool) 0 = disable, 3 enabled
optionVideoControl: "6" - (int) Refer to Syntax document
optionAudio: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionVideo: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionChat: "0" - (bool) 0 = enabled, 8 enabled
optionshareDesktop: "1" - (bool) 0 = disable, 1 enabled
optionAlias: "sdfg" - (str) Min 4 char string ( Cannot be used on 2 different meetings)
optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded. 

callInModeratorKey"2074" - (int) 4 digit 

callInAccessCode"1234" - (int) 4 digit

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}
 

For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.

Create a meeting

Address to call:

https://api.ezuce.com/api/meeting/create

Input:

apiLogin: "Your_API_Login"- (str) API login provided by ezuce

apiPassword: "Your_API_password"- (str) API password provided by ezuce

meetingName: "My first test"- (str) Min 4 char string, name of the meeting

meetingPwd: "21362"- (str) Min 4 char string

meetingDescription: ""- (str) meeting description

meetingAccessCode: "12345"- (str) Min 4 char string

meetingDuration: "3"- (int) Lengh in hours

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

meetingNbrParticipants: "5"- (int) Min = 2, Max = 50

meetingType: "0"- (bool) = disable(Default), 2 plenary

meetingQuality: "3"- (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p

optionRecording: "1"- (bool) 0= disable, 1 enabled

optionH323sip: "3"- (bool) 0= disable, 3 enabled

optionPhone: "1"- (bool) 0= disable, 1 enabled

optionBackground: "logo.png"- (int) name of file ( jpg or png ) previously uploaded.

optionAlias: "my_meeting"- (str) Min 4 char string ( Cannot be used on 2 dif meetings)

optionH323sip: "3"- (bool) 0= disable, 3 enabled

optionVideoControl: "6"- (int) Refer to Syntax document

optionAudio: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionVideo: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionChat: "0"- (bool) 0= enabled, 8 enabled

optionshareDesktop: "1"- (bool) 0= disable, 1 enabled

optionAlias: "sdfg"- (str) Min 4 char string ( Cannot be used on 2 different meetings)

optionBackground: "logo.png"- (int) name of file ( jpg or png ) previously uploaded.



Example:

https://api.ezuce.com/api/meeting/create

apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingPwd=21362&meetingName=My+first+tes t&meetingAccessCode=12345&meetingType=0&meetingDuration=3&meetingNbrParticipants=5&optionReco rding=1&optionH323sip=3&optionPhone=1&meetingQuality=3


Output:

{

status: "ok" - (str) Status of your REST request

meetingStatus: "ready" - (str) ready, running, over

meetingName: "My first test42" - (str) Min 4 char string, name of the meeting

meetingId: "3286566518" - (int) Same 10 digit number

meetingCredits: "81" - (int) Credit value of this meeting

meetingPwd: "21362" - (str) Min 4 char string

meetingNbrParticipants: "5" - (int) Min = 2, Max = 50

meetingDescription: "" - (str) meeting description

meetingAccessCode: "12345" - (str) Min 4 char string

meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p

meetingDuration: "3" - (int) Lengh in hours

meetingType: "0" - (bool) 0 = disable, 2 plenary

optionRecording: "1" - (bool) 0 = disable, 1 enabled

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 


}


For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.


Start a meeting

Address to call:

https://api.ezuce.com/api/meeting/start

Input:

apiLogin: "Your_API_Login" - (str) API login provided by ezuce
apiPassword: "Your_API_password" - (str) API password provided by ezuce
meetingId: "1599829252" - (str) 10 digit meeting number 

Example:

https://api.ezuce.com/api/meeting/start

apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingId=1599829252&meetingPwd=1234

Output:

{

status: "ok" - (str) Status of your REST request
meetingStatus: "running" - (str) ready, running, over
meetingName: "My first test42" - (str) Min 4 char string, name of the meeting
meetingId: "3286566518" - (int) Same 10 digit number
meetingCredits: "81" - (int) Credit value of this meeting
meetingPwd: "21362" - (str) Min 4 char string
meetingNbrParticipants: "5" - (int) Min = 2, Max = 50
meetingDescription: "" - (str) meeting description
meetingAccessCode: "12345" - (str) Min 4 char string
meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p
meetingDuration: "3" - (int) Lengh in hours
meetingType: "0" - (bool) 0 = disable, 2 plenary
optionRecording: "1" - (bool) 0 = disable, 1 enabled
optionH323sip: "3" - (bool) 0 = disable, 3 enabled
optionVideoControl: "6" - (int) Refer to Syntax document
optionAudio: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionVideo: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionChat: "0" - (bool) 0 = enabled, 8 enabled
optionshareDesktop: "1" - (bool) 0 = disable, 1 enabled
optionAlias: "sdfg" - (str) Min 4 char string ( Cannot be used on 2 different meetings)
optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded.

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit 

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}


For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.

 

Stop a meeting

Address to call:

https://api.ezuce/api/meeting/stop

Input:

apiLogin: "Your_API_Login" - (str) API login provided by ezuce
apiPassword: "Your_API_password" - (str) API password provided by ezuce
meetingId: "1599829252" - (str) 10 digit meeting number
meetingPwd: "1234" - (str) Min 4 char string - is the meetingPwd set at creation 

Example:

https://api.ezuce.com/api/meeting/stop

apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingId=1599829252&meetingPwd=1234

Output:

{

status: "ok" - (str) Status of your REST request
meetingStatus: "over" - (str) ready, running, over
meetingName: "My first test42" - (str) Min 4 char string, name of the meeting
meetingId: "3286566518" - (int) Same 10 digit number
meetingCredits: "81" - (int) Credit value of this meeting
meetingPwd: "21362" - (str) Min 4 char string
meetingNbrParticipants: "5" - (int) Min = 2, Max = 50
meetingDescription: "" - (str) meeting description
meetingAccessCode: "12345" - (str) Min 4 char string
meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p
meetingDuration: "3" - (int) Lengh in hours
meetingType: "0" - (bool) 0 = disable, 2 plenary

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

optionRecording: "1" - (bool) 0 = disable, 1 enabled
optionH323sip: "3" - (bool) 0 = disable, 3 enabled
optionVideoControl: "6" - (int) Refer to Syntax document
optionAudio: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionVideo: "4" - (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute
optionChat: "0" - (bool) 0 = enabled, 8 enabled
optionshareDesktop: "1" - (bool) 0 = disable, 1 enabled
optionAlias: "sdfg" - (str) Min 4 char string ( Cannot be used on 2 different meetings)
optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded.

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}


For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.


Cancel a meeting

Address to call:

https://api.ezuce.com/api/meeting/cancel

Input:

apiLogin: "Your_API_Login" - (str) API login provided by ezuce
apiPassword: "Your_API_password" - (str) API password provided by ezuce
meetingId: "1599829252" - (str) Min 4 char string - is the meetingPassword set at creation
meetingPwd: "1234" - (str) Min 4 char string - is the meetingPwd set at creation

Example:

https://api.ezuce.com/api/meeting/cancel

apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingId=1599829252&meetingPwd=1234 

Output: 

{

status: "ok" - (str) Status of your REST request
meetingStatus: "cancelled" - (str) ready, running, over
meetingId: "1599829252" - (int) Same 10 digit number


CreateNstart a meeting

Address to call:

https://api.ezuce.com/api/meeting/createNstart

Input:

apiLogin: "Your_API_Login"- (str) API login provided by ezuce

apiPassword: "Your_API_password"- (str) API password provided by ezuce

meetingName: "My first test"- (str) Min 4 char string, name of the meeting

meetingPwd: "21362"- (str) Min 4 char string

meetingDescription: ""- (str) meeting description

meetingAccessCode: "12345"- (str) Min 4 char string

meetingDuration: "3"- (int) Lengh in hours

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

meetingNbrParticipants: "5"- (int) Min = 2, Max = 50

meetingType: "0"- (bool) 0= disable(Default), 2 plenary

meetingQuality: "3"- (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p

optionRecording: "1"- (bool) 0= disable, 1 enabled

optionH323sip: "3"- (bool) 0= disable, 3 enabled

optionPhone: "1"- (bool) 0= disable, 1 enabled

optionBackground: "logo.png"- (int) name of file ( jpg or png ) previously uploaded.

optionAlias: "my_meeting"- (str) Min 4 char string

Example:

https://api.ezuce.com/api/meeting/createNstart

 apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingPwd=21362&meetingName=My+first+tes t&meetingAccessCode=12345&meetingType=0&meetingDuration=3&meetingNbrParticipants=5&optionReco rding=1&optionH323sip=3&optionPhone=1&meetingQuality=3

Output: 

{

status: "ok" - (str) Status of your REST request

meetingStatus: "running" - (str) ready, running, over

meetingName: "My first test42" - (str) Min 4 char string, name of the meeting

meetingId: "3286566518" - (int) Same 10 digit number

meetingCredits: "81" - (int) Credit value of this meeting

meetingPwd: "21362" - (str) Min 4 char string

meetingNbrParticipants: "5" - (int) Min = 2, Max = 50

meetingDescription: "" - (str) meeting description

meetingAccessCode: "12345" - (str) Min 4 char string

meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p

meetingDuration: "3"- (int) Lengh in hours

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

meetingType: "0"- (bool) 0 = disable, 2 plenary

optionRecording: "1"- (bool) 0= disable, 1 enabled

optionH323sip: "3"- (bool) 0= disable, 3 enabled

optionVideoControl: "6"- (int) Refer to Syntax document

optionAudio: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionVideo: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionChat: "0"- (bool) 0= enabled, 8 enabled

optionshareDesktop: "1"- (bool) 0= disable, 1 enabled

optionAlias: "sdfg"- (str) Min 4 char string ( Cannot be used on 2 different meetings)

optionBackground: "logo.png"- (int) name of file ( jpg or png ) previously uploaded.

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit

 

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}


getMeetingId of a meeting

The purpose of this command is to get the matching meetingId from its alias that you previously set at the create/edit/reuse procedure. 

Address to call:

https://api.ezuce.com/api/meeting/getMeetingId

Input:

apiLogin: "Your_API_Login" - (str) API login provided by ezuce
apiPassword: "Your_API_password" - (str) API password provided by ezuce
optionAlias: "my_meeting" - (str) Min 4 char string - is the alias you set at the creation 

Example:

https://api.ezuce.com/api/meeting/getMeetingId

 apiLogin=Your_API_Login&apiPassword=Your_API_password&optionAlias=my_meeting 

Output:

{

status: "ok" - (str) Status of your REST request
meetingId: "1599829252" - (str) Same 10 digit number
optionAlias: "my_meeting" - (int) Min 4 char string - is the alias you set at the creation


edit a meeting ­- change/add/delete meetings parameters

The edit function allows you to changes all the meeting parameters.

The minimum parameters to run this command are : apiLogin, apiPassword,$meetingId

You CAN specify only the options you want to change. All other parameters will remain the same

Some meeting parameters will take effect immediately. Others will require a user to exit the meeting and re-enter for the new parameters to take effect. Some parameters cannot be updated without issuing a new JNLP file. For more details see page 22.

Address to call:

https://api.ezuce.com/api/meeting/edit

Input:

apiLogin: "Your_API_Login" - (str) API login provided by eZuce
apiPassword: "Your_API_password" - (str) API password provided by eZuce
meetingName: "My first test" - (str) Min 4 char string, name of the meeting
meetingId: "1599829252" - (str) Min 4 char string - is the meetingId generated at the creation
meetingPwd: "qwerty" - (str) Min 4 char string
meetingDescription: "" - (str) meeting description
meetingAccessCode: "12345" - (str) Min 4 char string
meetingDuration: "3" - (int) Lengh in hours

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

meetingNbrParticipants: "23" - (int) Min = 2, Max = 50
meetingType: "0" - (bool) 0 = disable(Default), 2 plenary
meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p
optionRecording: "1" - (bool) 0 = disable, 1 enabled
optionH323sip: "3" - (bool) 0 = disable, 3 enabled
optionPhone: "1" - (bool) 0 = disable, 1 enabled
optionVideo: "1" - (bool) 0 = disable, 1 enabled
optionAudio: "1" - (bool) 0 = disable, 1 enabled
optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded.
optionAlias: "my_meeting" - (str) Min 4 char string (Cannot be used on 2 different meetings)


For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.

Note - The edit function can be used whether the meeting is ready or running


Example:

https://api.ezuce.com/api/meeting/edit
apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingNbrParticipants=23&meetingPwd=qwerty

Output:

{

status: "ok" - (str) Status of your REST request
meetingStatus: "running" - (str) ready, running, over
meetingName: "My first test" - (str) Min 4 char string, name of the meeting
meetingId: "1599829252" - (int) Same 10 digit number
meetingCredits: "96" - (int) Credit value of this meeting
meetingPwd: "qwerty" - (str) Min 4 char string
meetingDescription: "" - (str) meeting description
meetingAccessCode: "12345" - (str) Min 4 char string
meetingDuration: "3" - (int) Length in hours
meetingNbrParticipants: "23" - (int) Min = 2, Max = 50
meetingType: "0" - (bool) 0 = disable, 2 plenary
meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p
optionRecording: "1" - (bool) 0 = disable, 1 enabled
optionH323sip: "3" - (bool) 0 = disable, 3 enabled
optionPhone: "1" - (bool) 0 = disable, 1 enabled
optionVideo: "1" - (bool) 0 = disable, 1 enabled
optionAudio: "1" - (bool) 0 = disable, 1 enabled
optionChat: "1" - (bool) 0 = enabled, 8 enabled
optionVideoControl: "6" - (int) Refer to Syntax document
optionShareDesktop: "1" - (bool) 0 = disable, 1 enabled
optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded.
optionAlias: "my_meeting" - (str) Min 4 char string (Cannot be used on 2 different meetings)

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}


For this command the returned JSON message will ALWAYS contain all the meetings options/parameters.


reuse a meeting

The reuse function allows you to recycle a meeting, including its meetingId.

You are free to edit parameters similar to the way of the "edit" function.

Some meeting parameters will take effect immediately. Others will require a user to exit the meeting and re-enter for the new parameters to take effect. Some parameters cannot be updated without issuing a new JNLP file. For more details see page 20.

Address to call : [ *+https://api.ezuce.com/api/meeting/reuse


Input (minimum required):

apiLogin: "Your_API_Login"- (str) API login provided by ezuce

apiPassword: "Your_API_password"- (str) API password provided by eZuce

meetingId: "1599829252"- (str) Min 4 char string - is the meetingPassword set at creation

meetingPwd: "1234"- (str) Min 4 char string - is the meetingPwd set at creation


Example:

https://api.ezuce.com/api/meeting/reuse

apiLogin=Your_API_Login&apiPassword=Your_API_password&meetingId=1599829252&meetingPwd=1234

Output:

{

status: "ok" - (str) Status of your REST request

meetingStatus: "ready" - (str) ready, running, over

meetingName: "My first test42" - (str) Min 4 char string, name of the meeting

meetingId: "3286566518" - (int) Same 10 digit number

meetingCredits: "81" - (int) Credit value of this meeting

meetingPwd: "21362" - (str) Min 4 char string

meetingNbrParticipants: "5" - (int) Min = 2, Max = 50

meetingDescription: "" - (str) meeting description

meetingAccessCode: "12345" - (str) Min 4 char string

meetingQuality: "3" - (int) 1 = Low, 2 = Standard, 3 = High, 4 = 720p, 5 = 1080p

meetingDuration: "3" - (int) Lengh in hours

meetingStart:  "2020-02-05 15:30:00" - (dateTime)

meetingEnd: "2020-05-05 15:30:00" - (dateTime)

meetingType: "0" - (bool) 0 = disable, 2 plenary

optionRecording: "1" - (bool) 0 = disable, 1 enabled

optionH323sip: "3" - (bool) 0 = disable, 3 enabled

optionBackground: "logo.png" - (int) name of file ( jpg or png ) previously uploaded.

optionVideoControl: "6" - (int) 1=unlimited, 2=SingleCamera, 4=fullVideoSettingsGui. (add val)

optionAudio: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionVideo: "4"- (bool) 0=disable, 1=mute, 2=unmute, 3=force mute,4=force unmute

optionChat: "0"- (bool) 0= enabled, 8 enabled

optionshareDesktop: "1"- (bool) 0= disable, 1 enabled

optionAlias: "sdfg"- (str) Min 4 char string ( Cannot be used on 2 different meetings)

optionBackground: "sdfg"- (str) Min 4 char string

callInModeratorKey"2074" - (int) 4 digit

callInAccessCode"1234" - (int) 4 digit

meetingCallInH323"3286566518@gw.ezuce.com" - string 

meetingCallInSip"3286566518@gw.ezuce.com" - string 

meetingCvo"https://seevogh.com/meetings/3286566518/SeeVogh_3286566518.cvo" - string 

}


The returned JSON message will ALWAYS contain all the meetings options/parameters.

getSeatAllocationUSHI Get the status of you USHI seat allocation


Address to call:

https://api.ezuce.com/api/meeting/getSeatAllocationUSHI

Input:

apiLogin: "Your_API_Login" - (str) API login provided by eZuce
apiPassword: "Your_API_password" - (str) API password provided by eZuce

Example:

https://api.ezuce.com/api/meeting/getSeatAllocationUSHI

apiLogin=Your_API_Login&apiPassword=Your_API_password 

Output:

{

status: "ok" - (str) Status of your REST request
allocatedSeats: "32" - (int) Seats currently used
unallocatedSeats: "68" - (int) Seats currently available
totalUSHISeats: "100" - (int) USHI total seat capacity

}


uploadNewBackground Add background to your USHI background list


Address to call:

https://api.ezuce.com/api/meeting/uploadNewBackground

Input:

apiLogin: "Your_API_Login" - (str) API login provided by eZuce
apiPassword: "Your_API_password" - (str) API password provided by eZuce
fileUpload: "ezuce.jpg" - (str) File ( jpg or png ) you want to upload

Example:

https://api.ezuce.com/api/meeting/uploadNewBackground

apiLogin=Your_API_Login&apiPassword=Your_API_password

Output:

{

status: "ok" - (str) Status of your REST request
fileUpload: "ezuce.jpg" - (int) File ( jpg or png ) you successfully upload

}


listBackground get the list of all the available backgrounds


Address to call:

https://api.ezuce.com/api/meeting/listBackground

Input:

apiLogin: "Your_API_Login" - (str) API login provided by eZuce
apiPassword: "Your_API_password" - (str) API password provided by eZuce

Example:

https://api.ezuce.com/api/meeting/listBackground

apiLogin=Your_API_Login&apiPassword=Your_API_password 

Output:

{

status: "ok" - (str) Status of your REST request
background: - (int) File ( jpg or png ) you successfully upload
0: "clould.jpg" - (str) Available background
1: "moutains.jpg" - (str) Available background
2: "companylogo.png" - (str) Available background
3: "test.jpg" - (str) Available background

}



Effects of Parameters on an On-Going Meeting 


Some meeting parameters will take effect immediately. Others will require a user to exit the meeting and re-enter for the new parameters to take effect. Some parameters cannot be updated without issuing a new JNLP file.

The "edit" function allows you to edit "ready" AND "running" meetings.

Also "reuse" will give the opportunity to re-define those parameters when reusing a meeting.


There are 3 types of updates when editing a meeting:

  1. Live update : The new value will update on the client instantly
  2. User needs to re-join the meeting : the user won't see any update unless he quits the client and comes back
  3. User needs to re-join the meeting & Meeting room must be empty when updated : The meeting room needs to be empty to enable the update.


meetingName: "live update" meetingPwd: "live update" meetingNbrParticipants: "live update" meetingDescription: "live update" meetingAccessCode: "live update"

meetingQuality: "User needs to re-enter the meeting" meetingDuration: "live update"

meetingType: "User needs to re-join the meeting & Meeting room must be empty when updated" optionRecording: "User needs to re-enter the meeting"

optionH323sip: "User needs to re-enter the meeting" optionVideoControl: "User needs re-enter the meeting" optionAudio: "User needs to re-enter the meeting" optionBackground: "Cannot be updated on an ongoing meeting" optionVideo: "User needs to re-enter the meeting"

optionChat: "User needs to re-enter the meeting" optionshareDesktop: "User needs to re-enter the meeting" optionAlias: "live update"



  • No labels