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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ZoomEventListenerOAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <ClientID>0</ClientID>
  <Event>String</Event>
  <Event_Ts>String</Event_Ts>
  <Payload>
    <Account_Id>String</Account_Id>
    <Object>
      <Duration>0</Duration>
      <Host_Id>String</Host_Id>
      <Id>0</Id>
      <Participant>
        <Email>String</Email>
        <Id>String</Id>
        <Join_Time>0001-01-01T00:00:00</Join_Time>
        <Leave_Time>0001-01-01T00:00:00</Leave_Time>
        <User_Id>String</User_Id>
        <User_Name>String</User_Name>
      </Participant>
      <Start_Time>0001-01-01T00:00:00</Start_Time>
      <Timezone>String</Timezone>
      <Topic>String</Topic>
      <Type>0</Type>
      <Uuid>String</Uuid>
    </Object>
    <PlainToken>String</PlainToken>
  </Payload>
</ZoomEventListenerOAuth>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ZoomEventListenerOAuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams" />