YM REST Services

<back to all web services

EventVirtualMeetings

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
PUT/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/Update a given event's VirtualMeeting.
POST/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/Create a new event VirtualMeeting.
GET/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/{MeetingId}Return the details for a VirtualMeeting linked to an event.
DELETE/Ams/{ClientID}/Event/{EventId}/VirtualMeetings/{MeetingId}Delete a given event VirtualMeeting.
EventVirtualMeetings Parameters:
NameParameterData TypeRequiredDescription
MeetingIdpathlongNo
ZoomUserIdbodystringNo
EventIdpathintNo
Meetings Parameters:
NameParameterData TypeRequiredDescription
MeetingformMeetingNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
Meeting Parameters:
NameParameterData TypeRequiredDescription
UuidformstringNo
IdformlongNo
HostIdformstringNo
TopicformstringNo
TypeformMeetingTypeNo
StatusformMeetingStatusNo
AgendaformstringNo
CreatedOnformDateTimeNo
StartTimeformstringNo
TimeZoneformstringNo
StartUrlformstringNo
JoinUrlformstringNo
PasswordformstringNo
H323PasswordformstringNo
PstnPasswordformstringNo
PMIformlongNo
SettingsformMeetingSettingsNo
DurationformintNo
MeetingSettings Parameters:
NameParameterData TypeRequiredDescription
StartVideoWhenHostJoinsformbool?No
StartVideoWhenParticipantsJoinformbool?No
HostInChinaformbool?No
HostInIndiaformbool?No
JoinBeforeHostformbool?No
MuteUponEntryformbool?No
Watermarkformbool?No
UsePmiformbool?No
ApprovalTypeformMeetingApprovalType?No
RegistrationTypeformMeetingRegistrationType?No
AudioformAudioType?No
AutoRecordingformRecordingType?No
EnforceLoginformbool?No
EnforceLoginDomainsformstringNo
AlternativeHostsformstringNo
CloseRegistrationformbool?No
SendRegistrationConfirmationEmailformbool?No
EnableMeetingAuthenticationformbool?No
WaitingRoomformbool?No
GlobalDialInCountriesformstring[]No
ContactNameformstringNo
ContactEmailformstringNo
EventVirtualMeetingsResponse Parameters:
NameParameterData TypeRequiredDescription
HostIDLabelformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Event/{EventId}/VirtualMeetings/ HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"MeetingId":0,"ZoomUserId":"String","EventId":0,"Meeting":{"Uuid":"String","Id":0,"HostId":"String","Topic":"String","Type":"Instant","Status":"Waiting","Agenda":"String","CreatedOn":"0001-01-01T00:00:00.0000000","StartTime":"String","TimeZone":"String","StartUrl":"String","JoinUrl":"String","Password":"String","H323Password":"String","PstnPassword":"String","PMI":0,"Settings":{"StartVideoWhenHostJoins":false,"StartVideoWhenParticipantsJoin":false,"HostInChina":false,"HostInIndia":false,"JoinBeforeHost":false,"MuteUponEntry":false,"Watermark":false,"UsePmi":false,"ApprovalType":"Automatic","RegistrationType":"0","Audio":"Voip","AutoRecording":"OnLocal","EnforceLogin":false,"EnforceLoginDomains":"String","AlternativeHosts":"String","CloseRegistration":false,"SendRegistrationConfirmationEmail":false,"EnableMeetingAuthentication":false,"WaitingRoom":false,"GlobalDialInCountries":["String"],"ContactName":"String","ContactEmail":"String"},"Duration":0},"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T01:11:10.0522305-04:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HostIDLabel":"String","MeetingId":0,"ZoomUserId":"String","EventId":0,"Meeting":{"Uuid":"String","Id":0,"HostId":"String","Topic":"String","Type":"Instant","Status":"Waiting","Agenda":"String","CreatedOn":"0001-01-01T00:00:00.0000000","StartTime":"String","TimeZone":"String","StartUrl":"String","JoinUrl":"String","Password":"String","H323Password":"String","PstnPassword":"String","PMI":0,"Settings":{"StartVideoWhenHostJoins":false,"StartVideoWhenParticipantsJoin":false,"HostInChina":false,"HostInIndia":false,"JoinBeforeHost":false,"MuteUponEntry":false,"Watermark":false,"UsePmi":false,"ApprovalType":"Automatic","RegistrationType":"0","Audio":"Voip","AutoRecording":"OnLocal","EnforceLogin":false,"EnforceLoginDomains":"String","AlternativeHosts":"String","CloseRegistration":false,"SendRegistrationConfirmationEmail":false,"EnableMeetingAuthentication":false,"WaitingRoom":false,"GlobalDialInCountries":["String"],"ContactName":"String","ContactEmail":"String"},"Duration":0},"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T01:11:10.0575549-04:00","Device":"Desktop"}