YM REST Services

<back to all web services

ZoomEventListener

The following routes are available for this service:
POST/Ams/ZoomEventListenerReceives and records a Zoom Event Subscription payload.
ZoomEventListener Parameters:
NameParameterData TypeRequiredDescription
EventbodystringNo
Event_TsbodystringNo
PayloadbodyZoomEventPayloadNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ZoomEventPayload Parameters:
NameParameterData TypeRequiredDescription
Account_IdformstringNo
ObjectformPayloadObjectNo
PayloadObject Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UuidformstringNo
Host_IdformstringNo
TopicformstringNo
TypeformintNo
Start_TimeformDateTimeNo
TimezoneformstringNo
DurationformintNo
ParticipantformZoomParticipantNo
ZoomParticipant Parameters:
NameParameterData TypeRequiredDescription
User_IdformstringNo
User_NameformstringNo
EmailformstringNo
IdformstringNo
Join_TimeformDateTimeNo
Leave_TimeformDateTimeNo

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/ZoomEventListener HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Event":"String","Event_Ts":"String","Payload":{"Account_Id":"String","Object":{"Id":0,"Uuid":"String","Host_Id":"String","Topic":"String","Type":0,"Start_Time":"0001-01-01T00:00:00.0000000","Timezone":"String","Duration":0,"Participant":{"User_Id":"String","User_Name":"String","Email":"String","Id":"String","Join_Time":"0001-01-01T00:00:00.0000000","Leave_Time":"0001-01-01T00:00:00.0000000"}}},"UsingRedis":true,"AppInitTime":"2024-05-03T03:23:20.3974153-04:00","ServerID":"WS-6-134-823","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-03T03:32:37.4584629-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Event":"String","Event_Ts":"String","Payload":{"Account_Id":"String","Object":{"Id":0,"Uuid":"String","Host_Id":"String","Topic":"String","Type":0,"Start_Time":"0001-01-01T00:00:00.0000000","Timezone":"String","Duration":0,"Participant":{"User_Id":"String","User_Name":"String","Email":"String","Id":"String","Join_Time":"0001-01-01T00:00:00.0000000","Leave_Time":"0001-01-01T00:00:00.0000000"}}},"UsingRedis":true,"AppInitTime":"2024-05-03T03:23:20.3974153-04:00","ServerID":"WS-6-134-823","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-03T03:32:37.4584629-04:00","Device":"Desktop"}