Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

 


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:

...

Status of a meeting ( Default returned object )

 


Address to call:

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

...

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. 

...

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

...

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 

...

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:

...

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

...

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.

...

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 optionRecording: "

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.

...


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

 


Cancel a meeting

Address to call:

...

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

...

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

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

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

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

...

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. 

...

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

...

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

...

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

...

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.

...

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

 


Input (minimum required):

...

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

...

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

...

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

...

  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"

...

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