YM REST Services

<back to all web services

ZoomEventListenerOAuth

The following routes are available for this service:
POST/Ams/ZoomEventListenerOAuth/{ClientID}Receives and records a Zoom Event Subscription payload.
ZoomEventListenerOAuth Parameters:
NameParameterData TypeRequiredDescription
ClientIDpathintNo
EventbodystringNo
Event_TsbodystringNo
PayloadbodyZoomEventPayloadOAuthNo
ZoomEventPayloadOAuth Parameters:
NameParameterData TypeRequiredDescription
Account_IdformstringNo
PlainTokenformstringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /Ams/ZoomEventListenerOAuth/{ClientID} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientID: 0,
	Event: String,
	Event_Ts: String,
	Payload: 
	{
		Account_Id: String,
		PlainToken: String,
		Object: 
		{
			Id: 0,
			Uuid: String,
			Host_Id: String,
			Topic: String,
			Type: 0,
			Start_Time: 0001-01-01,
			Timezone: String,
			Duration: 0,
			Participant: 
			{
				User_Id: String,
				User_Name: String,
				Email: String,
				Id: String,
				Join_Time: 0001-01-01,
				Leave_Time: 0001-01-01
			}
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}