{"openapi":"3.0.0","info":{"title":"Real-Time Media Streams (RTMS) Webhooks","description":"Realtime Media Streams (RTMS) is a data pipeline that gives your app access to live audio, video, and transcript data from Zoom Contact Center engagements, Zoom meetings and webinars, and Zoom Video SDK sessions.","version":"1.0.0"},"paths":{"contact_center.voice_rtms_interrupted":{"post":{"tags":["Notifications"],"summary":"contact_center.voice_rtms_interrupted","description":"The **RTMS interrupted in ZCC Voice** event is triggered when an ongoing voice stream gets disrupted due to a broken signaling socket connection.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS interrupted in ZCC Voice** subscription enabled under the **RTMS** event.","operationId":"Contact_center.voice_rtms_interruptedWebhook","requestBody":{"description":"Webhook payload for the `contact_center.voice_rtms_interrupted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact_center.voice_rtms_interruptedEvent"},"examples":{"default":{"summary":"Example contact_center.voice_rtms_interrupted event","value":{"event":"contact_center.voice_rtms_interrupted","event_ts":1626230691572,"payload":{"engagement_id":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.rtms_interrupted":{"post":{"tags":["Notifications"],"summary":"meeting.rtms_interrupted","description":"The **RTMS interrupted in Meeting** event is triggered when an ongoing meeting stream gets disrupted due to a broken signaling socket connection.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS interrupted in Meeting** subscription enabled under the **RTMS** event.","operationId":"Meeting.rtms_interruptedWebhook","requestBody":{"description":"Webhook payload for the `meeting.rtms_interrupted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.rtms_interruptedEvent"},"examples":{"default":{"summary":"Example meeting.rtms_interrupted event","value":{"event":"meeting.rtms_interrupted","event_ts":1626230691572,"payload":{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.rtms_stopped":{"post":{"tags":["Notifications"],"summary":"meeting.rtms_stopped","description":"The **RTMS stopped in Meeting** event is triggered when the meeting host or the initiator stops a real-time stream.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS stopped in Meeting** subscription enabled under the **RTMS** event.","operationId":"Meeting.rtms_stoppedWebhook","requestBody":{"description":"Webhook payload for the `meeting.rtms_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.rtms_stoppedEvent"},"examples":{"default":{"summary":"Example meeting.rtms_stopped event","value":{"event":"meeting.rtms_stopped","event_ts":1626230691572,"payload":{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","stop_reason":1}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"contact_center.voice_rtms_stopped":{"post":{"tags":["Notifications"],"summary":"contact_center.voice_rtms_stopped","description":"The **RTMS Stopped in ZCC Voice** event is triggered when a voice call is disconnected between Agent and Consumer.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Stopped in ZCC Voice** subscription enabled under the **RTMS** event.","operationId":"Contact_center.voice_rtms_stoppedWebhook","requestBody":{"description":"Webhook payload for the `contact_center.voice_rtms_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact_center.voice_rtms_stoppedEvent"},"examples":{"default":{"summary":"Example contact_center.voice_rtms_stopped event","value":{"event":"contact_center.voice_rtms_stopped","event_ts":1626230691572,"payload":{"engagement_id":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","stop_reason":1}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.rtms_stopped":{"post":{"tags":["Notifications"],"summary":"webinar.rtms_stopped","description":"The **RTMS stopped in Webinar** event is triggered when the webinar host or the initiator stops a real-time stream.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS stopped in Webinar** subscription enabled under the **RTMS** event.","operationId":"Webinar.rtms_stoppedWebhook","requestBody":{"description":"Webhook payload for the `webinar.rtms_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.rtms_stoppedEvent"},"examples":{"default":{"summary":"Example webinar.rtms_stopped event","value":{"event":"webinar.rtms_stopped","event_ts":1626230691572,"payload":{"webinar_uuid":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","stop_reason":1}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.rtms_started":{"post":{"tags":["Notifications"],"summary":"webinar.rtms_started","description":"Zoom triggers the **RTMS started in Webinar** event when a webinar host or a webinar panelist starts a real-time stream action. \n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS started in Webinar** subscription enabled under the **RTMS** event.  \n  * The initiator must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.","operationId":"Webinar.rtms_startedWebhook","requestBody":{"description":"Webhook payload for the `webinar.rtms_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.rtms_startedEvent"},"examples":{"default":{"summary":"Example webinar.rtms_started event","value":{"event":"webinar.rtms_started","event_ts":1626230691572,"payload":{"webinar_uuid":"4444AAAiAAAAAiAiAiiAii==","operator_id":"30R7kT7bTIKSNUFEuH_Qlg","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","webinar_id":85746065123,"account_id":"abcdefg123xyz","is_original_host":true,"server_urls":"wss://127.0.0.1:443"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.rtms_interrupted":{"post":{"tags":["Notifications"],"summary":"webinar.rtms_interrupted","description":"The **RTMS interrupted in Webinar** event is triggered when an ongoing webinar stream gets disrupted due to a broken signaling socket connection.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS interrupted in Webinar** subscription enabled under the **RTMS** event.","operationId":"Webinar.rtms_interruptedWebhook","requestBody":{"description":"Webhook payload for the `webinar.rtms_interrupted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.rtms_interruptedEvent"},"examples":{"default":{"summary":"Example webinar.rtms_interrupted event","value":{"event":"webinar.rtms_interrupted","event_ts":1626230691572,"payload":{"webinar_uuid":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.rtms_started":{"post":{"tags":["Notifications"],"summary":"session.rtms_started","description":"Zoom triggers the **RTMS Started** event when a session host starts a real-time stream. \n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Started** subscription enabled under the **RTMS** event.  \n  * The initiator must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.","operationId":"Session.rtms_startedWebhook","requestBody":{"description":"Webhook payload for the `session.rtms_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.rtms_startedEvent"},"examples":{"default":{"summary":"Example session.rtms_started event","value":{"event":"session.rtms_started","event_ts":1626230691572,"payload":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_key":"ABC36jaBI145","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","account_id":"abcdefg123xyz","server_urls":"wss://127.0.0.1:443"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"rtms.concurrency_limited":{"post":{"tags":["Notifications"],"summary":"rtms.concurrency_limited","description":"The **RTMS Concurrency Limited** event is triggered when an app reaches the predetermined limit of concurrent streams for the app owner's account. The default is 2000 concurrent streams.\n\n\nThis event notifies the app owner if their usage exceeds the number of available concurrent streams.\n\n\n\nWhen the concurrency limit is reached, no new streams can be initiated. \n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Concurrency Limited** subscription enabled under the **RTMS** event.","operationId":"Rtms.concurrency_limitedWebhook","requestBody":{"description":"Webhook payload for the `rtms.concurrency_limited` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rtms.concurrency_limitedEvent"},"examples":{"default":{"summary":"Example rtms.concurrency_limited event","value":{"event":"rtms.concurrency_limited","event_ts":1626230691572,"payload":{"operator_id":"30R7kT7bTIKSNUFEuH_Qlg","concurrency_number":2001,"id_field":{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii=="}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"contact_center.voice_rtms_started":{"post":{"tags":["Notifications"],"summary":"contact_center.voice_rtms_started","description":"The **RTMS Started in ZCC Voice** event is triggered when a voice call is connected between Agent and Consumer.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Started in ZCC Voice** subscription enabled under the **RTMS** event.  \n  * The initiator must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.","operationId":"Contact_center.voice_rtms_startedWebhook","requestBody":{"description":"Webhook payload for the `contact_center.voice_rtms_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact_center.voice_rtms_startedEvent"},"examples":{"default":{"summary":"Example contact_center.voice_rtms_started event","value":{"event":"contact_center.voice_rtms_started","event_ts":1626230691572,"payload":{"engagement_id":"4444AAAiAAAAAiAiAiiAii==","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","server_urls":"wss://127.0.0.1:443"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.rtms_interrupted":{"post":{"tags":["Notifications"],"summary":"session.rtms_interrupted","description":"The **RTMS Interrupted** event is triggered when an ongoing session stream gets disrupted due to a broken signaling socket connection.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Interrupted** subscription enabled under the **RTMS** event.","operationId":"Session.rtms_interruptedWebhook","requestBody":{"description":"Webhook payload for the `session.rtms_interrupted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.rtms_interruptedEvent"},"examples":{"default":{"summary":"Example session.rtms_interrupted event","value":{"event":"session.rtms_interrupted","event_ts":1626230691572,"payload":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_key":"ABC36jaBI145","rtms_stream_id":"609340fb2a7946909659956c8aa9250c"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"rtms.concurrency_near_limit":{"post":{"tags":["Notifications"],"summary":"rtms.concurrency_near_limit","description":"The **RTMS Concurrency Near Limit** event is triggered when the app is nearing the predetermined number of concurrent streams. The default limit is 2000 concurrent streams.\n\nThis event periodically notifies the app owner when the number of concurrent streams exceeds 80% of the available concurrent streams.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**\n\t* The **RTMS Concurrency Near Limit** subscription enabled under the **RTMS** event.","operationId":"Rtms.concurrency_near_limitWebhook","requestBody":{"description":"Webhook payload for the `rtms.concurrency_near_limit` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rtms.concurrency_near_limitEvent"},"examples":{"default":{"summary":"Example rtms.concurrency_near_limit event","value":{"event":"rtms.concurrency_near_limit","event_ts":1626230691572,"payload":{"concurrency_limit":2000,"concurrency_number":1601,"percentage":80}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.rtms_started":{"post":{"tags":["Notifications"],"summary":"meeting.rtms_started","description":"Zoom triggers the **RTMS started in Meeting** event  when a meeting host or a meeting participant starts a real-time stream action. \n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS started in Meeting** subscription enabled under the **RTMS** event.  \n  * The initiator must be a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.","operationId":"Meeting.rtms_startedWebhook","requestBody":{"description":"Webhook payload for the `meeting.rtms_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.rtms_startedEvent"},"examples":{"default":{"summary":"Example meeting.rtms_started event","value":{"event":"meeting.rtms_started","event_ts":1626230691572,"payload":{"meeting_uuid":"4444AAAiAAAAAiAiAiiAii==","operator_id":"30R7kT7bTIKSNUFEuH_Qlg","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","meeting_id":85746065123,"account_id":"abcdefg123xyz","is_original_host":true,"server_urls":"wss://127.0.0.1:443"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.rtms_stopped":{"post":{"tags":["Notifications"],"summary":"session.rtms_stopped","description":"The **RTMS Stopped** event is triggered when the session host stops a realtime media stream.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\t* A valid **Event Notification Endpoint URL**.\n\t* The **RTMS Stopped** subscription enabled under the **RTMS** event.","operationId":"Session.rtms_stoppedWebhook","requestBody":{"description":"Webhook payload for the `session.rtms_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.rtms_stoppedEvent"},"examples":{"default":{"summary":"Example session.rtms_stopped event","value":{"event":"session.rtms_stopped","event_ts":1626230691572,"payload":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_key":"ABC36jaBI145","rtms_stream_id":"609340fb2a7946909659956c8aa9250c","stop_reason":1}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Contact_center.voice_rtms_interruptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["engagement_id","rtms_stream_id"],"type":"object","properties":{"engagement_id":{"type":"string","description":"The unique ID of the Contact Center voice call."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the Contact Center voice call. Each voice call can have multiple streams."}},"description":"Information about the Contact Center voice call RTMS event."}}},"Meeting.rtms_interruptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["meeting_uuid","rtms_stream_id"],"type":"object","properties":{"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the meeting. Each meeting can has multiple streams."}},"description":"Information about the meeting rtms event."}}},"Meeting.rtms_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["meeting_uuid","rtms_stream_id","stop_reason"],"type":"object","properties":{"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the meeting. Each meeting can has multiple streams."},"stop_reason":{"type":"integer","description":"The reason code of the stream stopped.\n* `1` — Triggered by the meeting host. \n* `2` — Triggered by the app user. \n* `3` — App user left meeting. \n* `4` — App user ejected by the meeting host. \n* `5` — The app is disabled by the meeting host. \n* `6` — The meeting is ended. \n* `7` — The stream is canceled. \n* `8` — The stream revoked. \n* `9` — All apps are disabled. \n* `10` — Server internal exception. \n* `11` — The connection timed out.","format":"int","enum":[1,2,3,4,7,8,9,10,11]}},"description":"Information about the meeting rtms event."}}},"Contact_center.voice_rtms_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["engagement_id","rtms_stream_id","stop_reason"],"type":"object","properties":{"engagement_id":{"type":"string","description":"The unique ID of the Contact Center voice call."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the Contact Center voice call. Each voice call can have multiple streams."},"stop_reason":{"type":"integer","description":"The reason code of the stream stopped.\n* `1` — Customer disconnected. \n* `2` — Agent disconnected. \n* `3` — Stream revoked. \n* `4` — Stream is canceled. \n* `5` — RTMS disabled by admin. \n* `6` — Internal platform error. \n* `7` — Connection timeout.","format":"int","enum":[1,2,3,4,5,6,7]}},"description":"Information about the Contact Center voice call RTMS event."}}},"Webinar.rtms_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["rtms_stream_id","stop_reason","webinar_uuid"],"type":"object","properties":{"webinar_uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the webinar. Each webinar can has multiple streams."},"stop_reason":{"type":"integer","description":"The reason code of why the stream stopped.\n* `1` = Triggered by the webinar host. \n* `2` = Triggered by the app user. \n* `3` = App user left webinar. \n* `4` = App user ejected by the webinar host. \n* `5` = The app is disabled by the webinar host. \n* `6` = The webinar is ended. \n* `7` = The stream is canceled. \n* `8` = The stream revoked. \n* `9` = All apps are disabled. \n* `10` = Server internal exception. \n* `11` = The connection timed out.","format":"int","enum":[1,2,3,4,7,8,9,10,11]}},"description":"Information about the webinar RTMS event."}}},"Webinar.rtms_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","is_original_host","operator_id","rtms_stream_id","server_urls","webinar_id","webinar_uuid"],"type":"object","properties":{"webinar_uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"operator_id":{"type":"string","description":"The ID of the user who is triggered this rtms event.","example":"30R7kT7bTIKSNUFEuH_Qlg"},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the webinar. Each webinar can has multiple streams."},"webinar_id":{"type":"integer","description":"The webinar ID.","format":"int64"},"account_id":{"type":"string","description":"The Zoom account ID of the app user's account."},"is_original_host":{"type":"boolean","description":"Whether the operator is the original webinar host."},"server_urls":{"type":"string","description":"The RTMS server urls for the app to connect with. Multiple URLs for different media protocols will be separated by commas."}},"description":"Information about the webinar RTMS event."}}},"Webinar.rtms_interruptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["rtms_stream_id","webinar_uuid"],"type":"object","properties":{"webinar_uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID). Each webinar instance generates a webinar UUID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the webinar. Each webinar can has multiple streams."}},"description":"Information about the webinar RTMS event."}}},"Session.rtms_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of when the event occurred.","format":"int64"},"payload":{"required":["account_id","rtms_stream_id","server_urls","session_id","session_key"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own `session_id`."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the session. \n **Note**: A session can have multiple streams."},"account_id":{"type":"string","description":"The Zoom account ID of the Video SDK app."},"server_urls":{"type":"string","description":"The RTMS server urls for an app to connect with. Multiple URLs for different protocols will be separated by commas."}},"description":"Information about the session rtms event."}}},"Rtms.concurrency_limitedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of when the event occurred.","format":"int64"},"payload":{"required":["concurrency_number","id_field","operator_id"],"type":"object","properties":{"operator_id":{"type":"string","description":"The ID of the user who triggered this RTMS event."},"concurrency_number":{"type":"integer","description":"The number of concurrent streams."},"id_field":{"oneOf":[{"required":["meeting_uuid"],"properties":{"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."}}},{"required":["webinar_uuid"],"properties":{"webinar_uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID)."}}},{"required":["session_id"],"properties":{"session_id":{"type":"string","description":"The session's universally unique identifier (UUID)."}}}]}},"description":"Information about the meeting rtms event."}}},"Contact_center.voice_rtms_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["engagement_id","rtms_stream_id","server_urls"],"type":"object","properties":{"engagement_id":{"type":"string","description":"The unique ID of the Contact Center voice call."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the Contact Center voice call. Each voice call can have multiple streams."},"server_urls":{"type":"string","description":"The RTMS server urls for the app to connect with. Multiple URLs for different media protocols will be separated by commas."}},"description":"Information about the Contact Center voice call RTMS event."}}},"Session.rtms_interruptedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of when the event occurred.","format":"int64"},"payload":{"required":["rtms_stream_id","session_id","session_key"],"type":"object","properties":{"session_id":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a meeting UUID."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the session.\n **Note**: A session can have multiple streams."}},"description":"Information about the session rtms event."}}},"Rtms.concurrency_near_limitEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of when the event occurred.","format":"int64"},"payload":{"required":["concurrency_limit","concurrency_number","percentage"],"type":"object","properties":{"concurrency_limit":{"type":"integer","description":"The number of the predetermined available concurrent streams."},"concurrency_number":{"type":"integer","description":"The number of concurrent streams."},"percentage":{"type":"integer","description":"The number of concurrent streams as a percentage of the available concurrent streams."}},"description":"Information about the meeting RTMS event."}}},"Meeting.rtms_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","is_original_host","meeting_id","meeting_uuid","operator_id","rtms_stream_id","server_urls"],"type":"object","properties":{"meeting_uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"operator_id":{"type":"string","description":"The ID of the user who is triggered this rtms event.","example":"30R7kT7bTIKSNUFEuH_Qlg"},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the meeting. Each meeting can has multiple streams."},"meeting_id":{"type":"integer","description":"The meeting ID.","format":"int64"},"account_id":{"type":"string","description":"The Zoom account ID of the app user's account."},"is_original_host":{"type":"boolean","description":"Whether the operator is the original meeting host."},"server_urls":{"type":"string","description":"The RTMS server urls for app to connect with. Multiple URLs for different protocols will be separated by commas."}},"description":"Information about the meeting rtms event."}}},"Session.rtms_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp of when the event occurred.","format":"int64"},"payload":{"required":["rtms_stream_id","session_id","session_key","stop_reason"],"type":"object","properties":{"session_id":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"rtms_stream_id":{"type":"string","description":"The unique ID of one of streams of the session. \n **Note**: A session can have multiple streams."},"stop_reason":{"type":"integer","description":"The reason code of the stream stopped.\n* `1` = Triggered by the session host. \n* `2` = Triggered by the app user. \n* `3` = App user left session. \n* `4` = App user ejected by the session host. \n* `5` = The app is disabled by the session host. \n* `6` = The session is ended. \n* `7` = The stream is canceled. \n* `8` = The stream was revoked. \n* `9` = All apps are disabled. \n* `10` = Server internal exception. \n* `11` = The connection timed out.","format":"int","enum":[1,2,3,4,7,8,9,10,11]}},"description":"Information about the session rtms event."}}}}},"tags":[{"name":"Notifications"}],"servers":[{"url":"https://{your-endpoint-url}"}]}