{"openapi":"3.0.0","info":{"title":"Video SDK Webhooks","description":"**Subscribe to webhook events** \\n\\nOn your [Video SDK account page on the App Marketplace](/docs/video-sdk/developer-accounts/), under **Add feature**, toggle **Event Subscriptions** to subscribe to events [using webhooks](/docs/api/rest/webhook-reference/).\\n\\n Configure webhooks to send [Video SDK events](/docs/video-sdk/webhooks/) to your server as HTTP POST requests. This is useful for tracking events or building out business logic. For example, when you receive a Video SDK session ended webhook, you could kick off an email to thank the participants for joining. \\n\\nSee [Make API requests](/docs/video-sdk/api-request/) for details or our [webhook sample code (Node.js)](https://github.com/zoom/webhook-sample).","version":"1.0.0"},"paths":{"session.user_phone_callout_ringing":{"post":{"tags":["Sessions"],"summary":"session.user_phone_callout_ringing","description":"\nThe **Invited party's phone (call out) ringing** event is triggered every time a user's phone is ringing when they were invited to join a session through phone (call out). Video SDK call out operates in a similar manner as [Zoom meeting call out](https://support.zoom.com/hc/article?id=zm_kb&sysparm_article=KB0062038).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party's phone (call out) ringing** subscription enabled under the **Session** event.\n\n\n","operationId":"Session.user_phone_callout_ringingWebhook","requestBody":{"description":"Webhook payload for the `session.user_phone_callout_ringing` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_phone_callout_ringingEvent"},"examples":{"default":{"summary":"Example session.user_phone_callout_ringing event","value":{"event":"session.user_phone_callout_ringing","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","session_key":"ABC36jaBI145","user_key":"ASD74dfDI854","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":15555550100,"from_number":13167900000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_room_system_callout_ringing":{"post":{"tags":["Sessions"],"summary":"session.user_room_system_callout_ringing","description":"\nThe **Invited party's phone (call out) ringing in Zoom room** event is triggered every time a user's phone is ringing when they were invited to [join a session through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party's phone (call out) ringing in Zoom room** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_room_system_callout_ringingWebhook","requestBody":{"description":"Webhook payload for the `session.user_room_system_callout_ringing` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_room_system_callout_ringingEvent"},"examples":{"default":{"summary":"Example session.user_room_system_callout_ringing event","value":{"event":"session.user_room_system_callout_ringing","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_started":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_started","description":"---\n\nEvent: `session.recording_started`\n\n## Event description\n\nThe **Session recording started** event is triggered every time a recording is started by one of your app users or account users.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete **after** the host or co-host ends the session. See [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * **Session recording started** subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_started` event notification:\n\n","operationId":"Session.recording_startedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_startedEvent"},"examples":{"default":{"summary":"Example session.recording_started event","value":{"event":"session.recording_started","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_resumed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_resumed","description":"---\n\nEvent: `session.recording_resumed`\n\n## Event description\n\nThe **Session recording resumed** event is triggered every time a previously paused recording of a session is resumed.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete **after** the host or co-host ends the session. See [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * **Session recording resumed** subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_resumed` event notification:\n\n","operationId":"Session.recording_resumedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_resumed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_resumedEvent"},"examples":{"default":{"summary":"Example session.recording_resumed event","value":{"event":"session.recording_resumed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.live_streaming_stopped":{"post":{"tags":["Sessions"],"summary":"session.live_streaming_stopped","description":"---\n\n\nThe Session Live Streaming Stopped event is triggered every time a user stops a live stream.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your app with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Live Streaming Stopped** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.live_streaming_stopped` event notification: \n\n","operationId":"Session.live_streaming_stoppedWebhook","requestBody":{"description":"Webhook payload for the `session.live_streaming_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.live_streaming_stoppedEvent"},"examples":{"default":{"summary":"Example session.live_streaming_stopped event","value":{"event":"session.live_streaming_stopped","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"id":"BrgGrWeZSwaXkLBTpvmmvg==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","start_time":"2021-08-02T12:03:32Z","live_streaming":{"service":"Custom_Live_Streaming_Service","custom_live_streaming_settings":{"stream_url":"https://example.com/livestream","stream_key":"ABCDEFG12345HIJ6789","page_url":"https://example.com/livestream/123","resolution":"1080p"},"date_time":"2021-08-02T12:22:45Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.stream_ingestion_stopped":{"post":{"tags":["Sessions"],"summary":"session.stream_ingestion_stopped","description":"Zoom triggers the **Session stream ingestion stopped** event every time a user stops sending live incoming streams.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session stream ingestion stopped** subscription enabled under the **Video SDK** event.\n","operationId":"Session.stream_ingestion_stoppedWebhook","requestBody":{"description":"Webhook payload for the `session.stream_ingestion_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.stream_ingestion_stoppedEvent"},"examples":{"default":{"summary":"Example session.stream_ingestion_stopped event","value":{"event":"session.stream_ingestion_stopped","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","stream_ingestion":{"stream_id":"sfk/aOFJSJSYhGwk1hnxgw==","stream_name":"stream ingestion1","stream_description":"stream ingestion1","stream_key":"ABCDEFG12345HIJ6789","stream_url":"rtmp://a.rtmp.zoomevent.com/live1","backup_stream_url":"rtmp://a.rtmp.zoomevent.com/live1"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_room_system_callout_rejected":{"post":{"tags":["Sessions"],"summary":"session.user_room_system_callout_rejected","description":"\nThe **Invited party rejected a session invitation through phone (call out) via Zoom room** event is triggered every time a user rejects an invitation to [join a session through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party rejected a session invitation through phone (call out) via Zoom room** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_room_system_callout_rejectedWebhook","requestBody":{"description":"Webhook payload for the `session.user_room_system_callout_rejected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_room_system_callout_rejectedEvent"},"examples":{"default":{"summary":"Example session.user_room_system_callout_rejected event","value":{"event":"session.user_room_system_callout_rejected","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.alert":{"post":{"tags":["Sessions"],"summary":"session.alert","description":"---\n\n\nThe Session Alert event is triggered every time a service issue is encountered during a session in your account.\n\nThe following quality metrics can trigger an alert:\n\n* Unstable audio quality\n* Unstable video quality\n* Unstable screen share quality\n* High CPU occupation\n* Call Reconnection\n\n## Prerequisites\nEvent Subscriptions must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* Session Alert subscription enabled under the Video SDK event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.alert` event notification:\n","operationId":"Session.alertWebhook","requestBody":{"description":"Webhook payload for the `session.alert` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.alertEvent"},"examples":{"default":{"summary":"Example session.alert event","value":{"event":"session.alert","event_ts":1626473951859,"payload":{"account_id":"EFgHiJABC000DEfGHI","object":{"id":"4567UVWxYZABCdEfGhiJkl==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","issues":"Unstable audio quality"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_summary_completed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_summary_completed","description":"---\n\nEvent: `session.recording_summary_completed`\n\n## Event description\n\nThe **Session recording summary completed** event is triggered every time a session's recording summary becomes available to view or download.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete after the host or co-host ends the session. See [get transcript and summary](/docs/build/cloud-recording/#get-transcript-and-summary) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* The video session is started with the JWT setting to enable the cloud recording with transcript and summary option.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * **Session recording summary completed** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_summary_completed` event notification:","operationId":"Session.recording_summary_completedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_summary_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_summary_completedEvent"},"examples":{"default":{"summary":"Example session.recording_summary_completed event","value":{"event":"session.recording_summary_completed","event_ts":1626230691572,"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ","payload":{"account_id":"AAAAAABBBB","object":{"session_id":"1234567890","session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-03-23T21:44:51Z","timezone":"America/Los_Angeles","recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"SUMMARY","file_size":246560,"file_extension":"JSON","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed","recording_type":"summary"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.sharing_ended":{"post":{"tags":["Sessions"],"summary":"session.sharing_ended","description":"---\n\n\nThe Session Sharing Ended event is triggered every time a user stops sharing the screen during a session.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Sharing Ended** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.sharing_ended` event notification: \n\n","operationId":"Session.sharing_endedWebhook","requestBody":{"description":"Webhook payload for the `session.sharing_ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.sharing_endedEvent"},"examples":{"default":{"summary":"Example session.sharing_ended event","value":{"event":"session.sharing_ended","event_ts":1626473951859,"payload":{"object":{"id":"4567UVWxYZABCdEfGhiJkl==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"username","user_key":"ASD74dfDI854","sharing_details":{"content":"application","date_time":"2021-07-16T17:19:11Z"}}},"account_id":"EFgHiJABC000DEfGHI"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_paused":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_paused","description":"---\n\nEvent: `session.recording_paused`\n\n## Event description\n\nThe **Session recording paused** event is triggered every time a recording is paused by one of your app or account users.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete **after** the host or co-host ends the session. See [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * \"**Session recording paused**\" subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_paused` event notification:\n\n","operationId":"Session.recording_pausedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_paused` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_pausedEvent"},"examples":{"default":{"summary":"Example session.recording_paused event","value":{"event":"session.recording_paused","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.ended":{"post":{"tags":["Sessions"],"summary":"session.ended","description":"---\n\n\nThe Session Ended event is triggered when the host ends the session, or when all users have left the session.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your app with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Ended** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.ended` event notification: \n\n","operationId":"Session.endedWebhook","requestBody":{"description":"Webhook payload for the `session.ended` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.endedEvent"},"examples":{"default":{"summary":"Example session.ended event","value":{"event":"session.ended","event_ts":1627906944384,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"id":"BrgGrWeZSwaXkLBTpvmmvg==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","start_time":"2021-08-02T12:22:24Z","end_time":"2021-08-02T13:22:24Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.started":{"post":{"tags":["Sessions"],"summary":"session.started","description":"---\n\n\nThe Session Start event is triggered when the first user (including host and co-host) joins.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your app with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Started** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.started` event notification:\n\n","operationId":"Session.startedWebhook","requestBody":{"description":"Webhook payload for the `session.started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.startedEvent"},"examples":{"default":{"summary":"Example session.started event","value":{"event":"session.started","event_ts":1627906944384,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"id":"BrgGrWeZSwaXkLBTpvmmvg==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","start_time":"2021-08-02T12:22:24Z"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.stream_ingestion_unbind":{"post":{"tags":["Sessions"],"summary":"session.stream_ingestion_unbind","description":"Zoom triggers the **Session stream ingestion unbind** event every time a session unbinds a stream key.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session stream ingestion unbind** subscription enabled under the **Video SDK** event.\n","operationId":"Session.stream_ingestion_unbindWebhook","requestBody":{"description":"Webhook payload for the `session.stream_ingestion_unbind` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.stream_ingestion_unbindEvent"},"examples":{"default":{"summary":"Example session.stream_ingestion_unbind event","value":{"event":"session.stream_ingestion_unbind","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","stream_ingestion":{"stream_id":"sfk/aOFJSJSYhGwk1hnxgw==","stream_name":"stream ingestion1","stream_description":"stream ingestion1","stream_key":"ABCDEFG12345HIJ6789","stream_url":"rtmp://a.rtmp.zoomevent.com/live1","backup_stream_url":"rtmp://a.rtmp.zoomevent.com/live1"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.live_streaming_started":{"post":{"tags":["Sessions"],"summary":"session.live_streaming_started","description":"---\n\n\nThe Session Live Streaming Started event is triggered every time a user starts a live stream.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your app with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Live Streaming Started** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.live_streaming_started` event notification: \n\n","operationId":"Session.live_streaming_startedWebhook","requestBody":{"description":"Webhook payload for the `session.live_streaming_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.live_streaming_startedEvent"},"examples":{"default":{"summary":"Example session.live_streaming_started event","value":{"event":"session.live_streaming_started","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"id":"BrgGrWeZSwaXkLBTpvmmvg==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","start_time":"2021-08-02T12:03:32Z","live_streaming":{"service":"Custom_Live_Streaming_Service","custom_live_streaming_settings":{"stream_url":"https://example.com/livestream","stream_key":"ABCDEFG12345HIJ6789","page_url":"https://example.com/livestream/123","resolution":"1080p"},"date_time":"2021-08-02T12:22:45Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_room_system_callout_missed":{"post":{"tags":["Sessions"],"summary":"session.user_room_system_callout_missed","description":"\nThe **Invited party missed a session invitation through phone (call out) via Zoom room** event is triggered every time an invitation to [join a session through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035) times out.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party missed a session invitation through phone (call out) via Zoom room** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_room_system_callout_missedWebhook","requestBody":{"description":"Webhook payload for the `session.user_room_system_callout_missed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_room_system_callout_missedEvent"},"examples":{"default":{"summary":"Example session.user_room_system_callout_missed event","value":{"event":"session.user_room_system_callout_missed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_phone_callout_accepted":{"post":{"tags":["Sessions"],"summary":"session.user_phone_callout_accepted","description":"\nThe **Invited party answered a session invitation through phone (call out)** event is triggered every time a user accepts an invitation to join a session through phone (call out). Video SDK call out operates in a similar manner as [Zoom meeting call out](https://support.zoom.com/hc/article?id=zm_kb&sysparm_article=KB0062038).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party answered a session invitation through phone (call out)** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_phone_callout_acceptedWebhook","requestBody":{"description":"Webhook payload for the `session.user_phone_callout_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_phone_callout_acceptedEvent"},"examples":{"default":{"summary":"Example session.user_phone_callout_accepted event","value":{"event":"session.user_phone_callout_accepted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","session_key":"ABC36jaBI145","user_key":"ASD74dfDI854","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":15555550100,"from_number":13167900000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_left":{"post":{"tags":["Sessions"],"summary":"session.user_left","description":"\n\nThe Session User Left event is triggered every time a user (including host and co-host) leaves a session. \n\n## Prerequisites\nEvent Subscriptions must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* Session User Left subscription enabled under the Video SDK event.\n\n","operationId":"Session.user_leftWebhook","requestBody":{"description":"Webhook payload for the `session.user_left` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_leftEvent"},"examples":{"default":{"summary":"Example session.user_left event","value":{"event":"session.user_left","event_ts":1626473951859,"payload":{"account_id":"EFgHiJABC000DEfGHI","object":{"id":"4567UVWxYZABCdEfGhiJkl==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"example","leave_time":"2021-07-16T17:19:11Z","leave_reason":"Jill Chill left the session.<br>Reason: Host ended the session.","user_key":"ASD74dfDI854","phone_number":"8615250064084","participant_uuid":"55555AAAiAAAAAiAiAiiAii"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.sharing_started":{"post":{"tags":["Sessions"],"summary":"session.sharing_started","description":"\n\nThe Session Sharing Started event is triggered every time a user starts sharing the screen during a session.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* **Session Sharing Started** subscription enabled under the **Video SDK** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.sharing_started` event notification:\n\n","operationId":"Session.sharing_startedWebhook","requestBody":{"description":"Webhook payload for the `session.sharing_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.sharing_startedEvent"},"examples":{"default":{"summary":"Example session.sharing_started event","value":{"event":"session.sharing_started","event_ts":1626473951859,"payload":{"object":{"id":"4118UHIiRCAAAtBlDkcVyw==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"username","user_key":"ASD74dfDI854","sharing_details":{"date_time":"2019-07-16T17:19:11Z","content":"application"}}},"account_id":"EPeQtiABC000VYxHMA"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_phone_callout_canceled":{"post":{"tags":["Sessions"],"summary":"session.user_phone_callout_canceled","description":"The **Invited party's phone (call out) canceled** event is triggered every time the inviter cancels the call out when they were invited to join a session through phone (call out). Video SDK call out operates in a similar manner as [Zoom meeting call out](https://support.zoom.com/hc/article?id=zm_kb&sysparm_article=KB0062038).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party's phone (call out) canceled** subscription enabled under the **Session** event.\n","operationId":"Session.user_phone_callout_canceledWebhook","requestBody":{"description":"Webhook payload for the `session.user_phone_callout_canceled` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_phone_callout_canceledEvent"},"examples":{"default":{"summary":"Example session.user_phone_callout_canceled event","value":{"event":"session.user_phone_callout_canceled","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","session_key":"ABC36jaBI145","user_key":"ASD74dfDI854","participant":{"invitee_name":"Jill Chill","phone_number":15555550100,"from_number":13167900000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_transcript_completed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_transcript_completed","description":"---\n\nEvent: `session.recording_transcript_completed`\n\n## Event description\n\nThe **Session recording transcript completed** event is triggered every time the transcript of the recording of a session becomes available to view or download.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete after the host or co-host ends the session. See [get transcript and summary](/docs/build/cloud-recording/#get-transcript-and-summary) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * Session recording transcript completed subscription enabled under the Recording event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_transcript_completed` event notification:","operationId":"Session.recording_transcript_completedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_transcript_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_transcript_completedEvent"},"examples":{"default":{"summary":"Example session.recording_transcript_completed event","value":{"event":"session.recording_transcript_completed","event_ts":1626230691572,"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ","payload":{"account_id":"AAAAAABBBB","object":{"session_id":"1234567890","session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"audio_transcript","file_type":"TRANSCRIPT","file_size":246560,"file_extension":"M4A","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_deleted":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_deleted","description":"---\n\nEvent: `session.recording_deleted`\n\n## Event description\n\nThe **Session recording permanently deleted** event is triggered every time one of your app users or account users permanently deletes a cloud recording.\n\nWhen a user initially deletes a recording, it is sent to the trash. At this stage, the recording can still be recovered for up to 30 days after deletion. To permanently delete a recording, users must delete it from the trash. Users can permanently delete a recording using:\n\n* The [Delete session's recording API](https://developers.zoom.us/docs/api/rest/reference/video-sdk/methods/#operation/recordingDelete) **with the delete query parameter** or \n* The Zoom web portal. See [Video SDK account](https://developers.zoom.us/docs/video-sdk/account/) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n\t* A valid Event Notification Endpoint URL.\n\t* \"**Session recording permanently deleted**\" subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_deleted` event notification:\n\n","operationId":"Session.recording_deletedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_deleted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_deletedEvent"},"examples":{"default":{"summary":"Example session.recording_deleted event","value":{"event":"session.recording_deleted","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.ai_interpreter_usage_summary":{"post":{"tags":["AI Interpreter"],"summary":"session.ai_interpreter_usage_summary","description":"The **Session AI interpreter usage summary** event triggers when a user uses AI interpreter in the session. The collected AI interpreter usage summary metrics for that user are then sent via this event. **Note:** This is a private beta feature.\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 **Session AI interpreter usage summary** subscription enabled under the **Video SDK** event.","operationId":"Session.ai_interpreter_usage_summaryWebhook","requestBody":{"description":"Webhook payload for the `session.ai_interpreter_usage_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.ai_interpreter_usage_summaryEvent"},"examples":{"default":{"summary":"Example session.ai_interpreter_usage_summary event","value":{"event":"session.ai_interpreter_usage_summary","event_ts":1626473951859,"payload":{"account_id":"EFgHiJABC000DEfGHI","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"Customer Support Meeting","session_key":"custom_session_12345","participant_uuid":"f1a2b3c4-d5e6-7890-1234-56789abcdef0","is_host":true,"start_time":"2025-06-05 02:26:04","end_time":"2025-06-05 02:56:04","usage":"30000ms"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_room_system_callout_failed":{"post":{"tags":["Sessions"],"summary":"session.user_room_system_callout_failed","description":"\nThe **Session invitation through phone (call out) via Zoom room failed** event is triggered every time an invitation to [join a session through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035) fails.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Session invitation through phone (call out) via Zoom room failed** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_room_system_callout_failedWebhook","requestBody":{"description":"Webhook payload for the `session.user_room_system_callout_failed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_room_system_callout_failedEvent"},"examples":{"default":{"summary":"Example session.user_room_system_callout_failed event","value":{"event":"session.user_room_system_callout_failed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","reason_type":1,"participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_completed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_completed","description":"---\n\nEvent: `session.recording_completed`\n\n## Event description\n\nThe **Session recording completed** event is triggered every time a recording of a session becomes available to view and/or download.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete **after** the host or co-host ends the session. See [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * Session recording completed subscription enabled under the Recording event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_completed` event notification:","operationId":"Session.recording_completedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_completed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_completedEvent"},"examples":{"default":{"summary":"Example session.recording_completed event","value":{"event":"session.recording_completed","event_ts":1626230691572,"download_token":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ","payload":{"account_id":"AAAAAABBBB","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","recording_type":"audio_only","file_type":"M4A","file_size":246560,"file_extension":"M4A","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","status":"completed"}],"participant_audio_files":[{"id":"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8","recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z","file_type":"M4A","file_name":"MyRecording","file_size":246560,"file_extension":"MP4","download_url":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA","status":"completed","recording_type":"audio_only","user_id":"16778240","user_key":"key1"}],"participant_video_files":[{"id":"0a564312-edf7-495e-b916-6873a7b32c50","status":"completed","recording_start":"2022-12-06T01:01:30Z","recording_end":"2022-12-06T01:10:32Z","file_type":"MP4","file_size":1200500,"download_url":"https://example.com/rec/download/cWfE3Ye3UUFgTxbBcii5t","recording_type":"individual_shared_screen","file_name":"Separated Share Video - user@example.com","file_extension":"MP4","user_id":"16778240","user_key":"key1"}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_transcript_failed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_transcript_failed","description":"---\n\nEvent: `session.recording_transcript_failed`\n\n## Event description\n\nThe **Session recording transcript failed** event is triggered every time the transcript of the recording of a session generated failed.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete after the host or co-host ends the session. See [get transcript and summary](https://developers.zoom.us/docs/build/cloud-recording/#get-transcript-and-summary) for details.\n\n## Prerequisites\n\n* Enable Cloud Recording on the Video SDK account.\n* Enable Event Subscriptions for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * Enable session recording transcript completed subscription under the Recording event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_transcript_completed` event notification:","operationId":"Session.recording_transcript_failedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_transcript_failed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_transcript_failedEvent"},"examples":{"default":{"summary":"Example session.recording_transcript_failed event","value":{"event":"session.recording_transcript_failed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"1234567890","session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_trashed":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_trashed","description":"---\n\nEvent: `session.recording_trashed`\n\n## Event description\n\nThe **Session recording deleted to trash** event is triggered every time one of your app users or account users temporarily delete a cloud recording.\n\nWhen a user initially deletes a recording, it is deleted to the trash. Recordings deleted to the trash can be recovered up to 30 days after deletion. Users can move a recording to the trash using:\n\n* The [Delete session's recording](https://developers.zoom.us/docs/api/rest/reference/video-sdk/methods/#operation/recordingDelete) API **with the trash query parameter** or \n* The Zoom web portal. See [Video SDK account](https://developers.zoom.us/docs/video-sdk/account/) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n\t* A valid Event Notification Endpoint URL.\n\t* **Session recording deleted to trash** subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_trashed` event notification:\n\n","operationId":"Session.recording_trashedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_trashed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_trashedEvent"},"examples":{"default":{"summary":"Example session.recording_trashed event","value":{"event":"session.recording_trashed","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_joined":{"post":{"tags":["Sessions"],"summary":"session.user_joined","description":"---\n\n\nThe Session User Joined event is triggered every time a user (including host and co-host) joins a session.\n\n## Prerequisites\nEvent Subscriptions must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n\n* A valid Event Notification Endpoint URL.\n* Session User Joined subscription enabled under the Video SDK event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.user_joined` event notification: \n\n","operationId":"Session.user_joinedWebhook","requestBody":{"description":"Webhook payload for the `session.user_joined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_joinedEvent"},"examples":{"default":{"summary":"Example session.user_joined event","value":{"event":"session.user_joined","event_ts":1626473951859,"payload":{"account_id":"EFgHiJABC000DEfGHI","object":{"id":"4567UVWxYZABCdEfGhiJkl==","session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"example","join_time":"2021-07-16T17:19:11Z","user_key":"ASD74dfDI854","phone_number":"8615250064084","participant_uuid":"55555AAAiAAAAAiAiAiiAii"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.stream_ingestion_started":{"post":{"tags":["Sessions"],"summary":"session.stream_ingestion_started","description":"Zoom triggers the **Session stream ingestion started** event every time a host starts sending an incoming live stream to a session. The session user can subscribe to it to see what's being streamed live into this session.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session stream ingestion started** subscription enabled under the **Video SDK** event.\n","operationId":"Session.stream_ingestion_startedWebhook","requestBody":{"description":"Webhook payload for the `session.stream_ingestion_started` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.stream_ingestion_startedEvent"},"examples":{"default":{"summary":"Example session.stream_ingestion_started event","value":{"event":"session.stream_ingestion_started","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","stream_ingestion":{"stream_id":"sfk/aOFJSJSYhGwk1hnxgw==","stream_name":"stream ingestion1","stream_description":"stream ingestion1","stream_key":"ABCDEFG12345HIJ6789","stream_url":"rtmp://a.rtmp.zoomevent.com/live1","backup_stream_url":"rtmp://a.rtmp.zoomevent.com/live1"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.stream_ingestion_connected":{"post":{"tags":["Sessions"],"summary":"session.stream_ingestion_connected","description":"Zoom triggers the **Session stream ingestion connected** event every time live streaming software connects to the Zoom Video SDK session. This indicates that the Zoom streaming platform is receiving data from the streaming software, but the received Real-Time Messaging Protocol (RTMP) data is not sent to the session yet.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session stream ingestion connected** subscription enabled under the **Video SDK** event.\n","operationId":"Session.stream_ingestion_connectedWebhook","requestBody":{"description":"Webhook payload for the `session.stream_ingestion_connected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.stream_ingestion_connectedEvent"},"examples":{"default":{"summary":"Example session.stream_ingestion_connected event","value":{"event":"session.stream_ingestion_connected","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","stream_ingestion":{"stream_id":"sfk/aOFJSJSYhGwk1hnxgw==","stream_name":"stream ingestion1","stream_description":"stream ingestion1","stream_key":"ABCDEFG12345HIJ6789","stream_url":"rtmp://a.rtmp.zoomevent.com/live1","backup_stream_url":"rtmp://a.rtmp.zoomevent.com/live1"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.stream_ingestion_disconnected":{"post":{"tags":["Sessions"],"summary":"session.stream_ingestion_disconnected","description":"Zoom triggers the **Session stream ingestion disconnected** event every time a Real-Time Messaging Protocol (RTMP) software program disconnects.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session stream ingestion disconnected** subscription enabled under the **Video SDK** event.\n","operationId":"Session.stream_ingestion_disconnectedWebhook","requestBody":{"description":"Webhook payload for the `session.stream_ingestion_disconnected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.stream_ingestion_disconnectedEvent"},"examples":{"default":{"summary":"Example session.stream_ingestion_disconnected event","value":{"event":"session.stream_ingestion_disconnected","event_ts":1627906965803,"payload":{"account_id":"D8cJuqWVQ623CI4Q8yQK0Q","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","stream_ingestion":{"stream_id":"sfk/aOFJSJSYhGwk1hnxgw==","stream_name":"stream ingestion1","stream_description":"stream ingestion1","stream_key":"ABCDEFG12345HIJ6789","stream_url":"rtmp://a.rtmp.zoomevent.com/live1","backup_stream_url":"rtmp://a.rtmp.zoomevent.com/live1"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_recovered":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_recovered","description":"---\n\nEvent: `session.recording_recovered`\n\n## Event description\n\nThe **Session recording recovered** event is triggered every time one of your app users or account users recover a recording from the trash.\n\nZoom allows users to recover their cloud recordings from trash within 30 days of deletion. You can recover a deleted cloud recording with:\n\n* The tab in the Zoom web client. See [Video SDK recordings and reports](https://developers.zoom.us/docs/video-sdk/reports/) for details.\n* The [Recover a single recording](https://developers.zoom.us/docs/api/rest/reference/video-sdk/methods/#operation/recordingStatusUpdateOne) or [Recover session's recordings](https://developers.zoom.us/docs/api/rest/reference/video-sdk/methods/#operation/recordingStatusUpdate) API.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n\t* A valid Event Notification Endpoint URL.\n\t* \"**Session recording recovered**\" subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_recovered` event notification:\n\n","operationId":"Session.recording_recoveredWebhook","requestBody":{"description":"Webhook payload for the `session.recording_recovered` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_recoveredEvent"},"examples":{"default":{"summary":"Example session.recording_recovered event","value":{"event":"session.recording_recovered","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","operator":"user@example.com","operator_id":"I7zp-pYbTl22Z29H796Ixg","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_phone_callout_missed":{"post":{"tags":["Sessions"],"summary":"session.user_phone_callout_missed","description":"\nThe **Invited party missed a session invitation through phone (call out)** event is triggered every time an invitation to join a session through phone (call out) times out. Video SDK call out operates in a similar manner as [Zoom meeting call out](https://support.zoom.com/hc/article?id=zm_kb&sysparm_article=KB0062038).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party missed a session invitation through phone (call out)** subscription enabled under the **Session** event.\n\n\n","operationId":"Session.user_phone_callout_missedWebhook","requestBody":{"description":"Webhook payload for the `session.user_phone_callout_missed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_phone_callout_missedEvent"},"examples":{"default":{"summary":"Example session.user_phone_callout_missed event","value":{"event":"session.user_phone_callout_missed","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","session_key":"ABC36jaBI145","user_key":"ASD74dfDI854","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":15555550100,"from_number":13167900000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_phone_callout_rejected":{"post":{"tags":["Sessions"],"summary":"session.user_phone_callout_rejected","description":"\nThe **Invited party rejected a session invitation through phone (call out)** event is triggered every time a user rejects an invitation to join a session through phone (call out). Video SDK call out operates in a similar manner as [Zoom meeting call out](https://support.zoom.com/hc/article?id=zm_kb&sysparm_article=KB0062038).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Invited party rejected a session invitation through phone (call out)** subscription enabled under the **Session** event.\n\n\n","operationId":"Session.user_phone_callout_rejectedWebhook","requestBody":{"description":"Webhook payload for the `session.user_phone_callout_rejected` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_phone_callout_rejectedEvent"},"examples":{"default":{"summary":"Example session.user_phone_callout_rejected event","value":{"event":"session.user_phone_callout_rejected","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","session_key":"ABC36jaBI145","user_key":"ASD74dfDI854","host_id":"ICuPoX4ERtikRcKqkVxunQ","participant":{"invitee_name":"Jill Chill","phone_number":15555550100,"from_number":13167900000}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_room_system_callout_accepted":{"post":{"tags":["Sessions"],"summary":"session.user_room_system_callout_accepted","description":"\nThe **Invited party answered a session invitation through phone (call out) via Zoom room** event is triggered every time a user [joins a session through phone (call out) from a Zoom room](https://support.zoom.us/hc/en-us/articles/205369035).\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your app with the following configurations:\n* A valid **Event Notification Endpoint URL**.\n* The **Invited party answered a session invitation through phone (call out) via Zoom room** subscription enabled under the **Session** event.\n\n","operationId":"Session.user_room_system_callout_acceptedWebhook","requestBody":{"description":"Webhook payload for the `session.user_room_system_callout_accepted` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_room_system_callout_acceptedEvent"},"examples":{"default":{"summary":"Example session.user_room_system_callout_accepted event","value":{"event":"session.user_room_system_callout_accepted","event_ts":1626230691572,"payload":{"account_id":"dzVA4QmMQfyISoRcpFO8CA","object":{"id":713592696,"uuid":"4444AAAiAAAAAiAiAiiAii==","session_id":"4444AAAiAAAAAiAiAiiAii==","session_name":"My Session","host_id":"ICuPoX4ERtikRcKqkVxunQ","message_id":"atsXxhSEQWit9t+U02HXNQ==","inviter_name":"Jill Chill","participant":{"call_type":"h323","device_ip":"10.100.111.237"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.recording_stopped":{"post":{"tags":["Cloud Recording"],"summary":"session.recording_stopped","description":"---\n\nEvent: `session.recording_stopped`\n\n## Event description\n\nThe **Session recording stopped** event is triggered every time a previously paused recording of a session is resumed.\n\nOnly a session host or co-host can start, pause, resume, or stop a cloud recording. A recording is considered complete **after** the host or co-host ends the session. See [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) for details.\n\n## Prerequisites\n\n* Cloud Recording must be enabled on the Video SDK account.\n* Event Subscriptions must be enabled for your app with the following configurations:\n  * A valid Event Notification Endpoint URL.\n  * **Session recording stopped** subscription enabled under the **Recording** event.\n\nThe tabs below display the complete schema, payload with data types, and an example of the `session.recording_stopped` event notification:\n\n","operationId":"Session.recording_stoppedWebhook","requestBody":{"description":"Webhook payload for the `session.recording_stopped` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.recording_stoppedEvent"},"examples":{"default":{"summary":"Example session.recording_stopped event","value":{"event":"session.recording_stopped","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":1234567890,"session_name":"My Personal Recording","session_key":"ABC36jaBI145","start_time":"2021-07-13T21:44:51Z","timezone":"America/Los_Angeles","recording_file":{"recording_start":"2021-03-23T22:14:57Z","recording_end":"2021-03-23T23:15:41Z"}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Session.user_phone_callout_ringingEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","participant","session_id","session_key","session_name","user_key"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user_key":{"type":"string","description":"Another identifier for the inviter. Can be a number or characters."},"host_id":{"type":"string","description":"The user ID of the session host."},"participant":{"required":["from_number","invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the session."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"},"from_number":{"type":"integer","description":"The number used to call out to the invited user.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_room_system_callout_ringingEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","inviter_name","message_id","participant","session_id","session_name"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"host_id":{"type":"string","description":"The user ID of the session host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":true,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_started"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_file","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_file":{"type":"object","properties":{"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in general query."}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_resumedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_resumed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_file","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_file":{"type":"object","properties":{"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in general query."}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.live_streaming_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["session.live_streaming_stopped"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","live_streaming","session_id","session_name","start_time"],"type":"object","properties":{"id":{"type":"string","description":"The session ID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The session's start time.","format":"date-time"},"live_streaming":{"required":["custom_live_streaming_settings","date_time","service"],"type":"object","properties":{"service":{"type":"string","description":"The name of the Live Streaming service.","enum":["Facebook","Workplace_by_Facebook","YouTube","Custom_Live_Streaming_Service"]},"custom_live_streaming_settings":{"required":["page_url","stream_key","stream_url"],"type":"object","properties":{"stream_url":{"type":"string","description":"The stream's URL."},"stream_key":{"type":"string","description":"The stream's Key."},"page_url":{"type":"string","description":"The live stream's page URL."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."}},"description":"The live stream settings."},"date_time":{"type":"string","description":"The live stream's stop time.","format":"date-time"}},"description":"Information about the participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.stream_ingestion_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Event name.","enum":["session.stream_ingestion_stopped"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","stream_ingestion"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"stream_ingestion":{"required":["backup_stream_url","stream_id","stream_key","stream_name","stream_url"],"type":"object","properties":{"stream_id":{"type":"string","description":"The stream ingestion ID."},"stream_name":{"type":"string","description":"The stream ingestion name."},"stream_description":{"type":"string","description":"The stream ingestion description."},"stream_key":{"type":"string","description":"The stream ingestion key."},"stream_url":{"type":"string","description":"The stream URL."},"backup_stream_url":{"type":"string","description":"The backup stream URL."}},"description":"Information about the stream ingestion."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_room_system_callout_rejectedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","inviter_name","message_id","participant","session_id","session_name"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"host_id":{"type":"string","description":"The user ID of the session host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":true,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.alertEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.alert"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","issues","session_id","session_name"],"type":"object","properties":{"id":{"type":"string","description":"The session ID."},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"issues":{"type":"array","description":"Issues that occurred during the session.","items":{"type":"string","enum":["Unstable audio quality","Unstable video quality","Unstable screen share quality","High CPU occupation","Call Reconnection"]}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_summary_completedEvent":{"required":["download_token","event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_summary_completed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, when the event occurred.","format":"int64"},"download_token":{"type":"string","description":"The URL to download the recording. \n\nTo download, set your [Video SDK API JWT](https://developers.zoom.us/docs/video-sdk/api-request/) as a Bearer token in the Authorization header of your HTTP request. For example: \n\n `curl \"{download_url}\" --header \"authorization: Bearer {access token or JWT}\" --header \"content-type: application/json\"`.\n\nNote: The download_url may be a redirect. In that case, use `curl --location \"{download_url}\"` to follow redirects or use another tool, like Postman."},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_files","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The session start time.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_files":{"title":"Recording file List","type":"array","description":"List of recording files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The recording file ID. Included in the response of the general query."},"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in the general query."},"file_name":{"type":"string","description":"The file name."},"file_path":{"type":"string","description":"The file path to the on-premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"file_type":{"type":"string","description":"The recording file type. The value of this field is:<br> `SUMMARY`: Summary file of the recording in JSON format","enum":["SUMMARY"]},"file_size":{"type":"number","description":"The recording file size."},"file_extension":{"type":"string","description":"The archived file's file extension.","enum":["JSON"]},"download_url":{"type":"string","description":"The URL to download the recording. \n\nTo download, set your [Video SDK API JWT](https://developers.zoom.us/docs/video-sdk/api-request/) as a Bearer token in the Authorization header of your HTTP request. For example: \n\n `curl \"{download_url}\" --header \"authorization: Bearer {access token or JWT}\" --header \"content-type: application/json\"`.\n\nNote: The download_url may be a redirect. In that case, use `curl --location \"{download_url}\"` to follow redirects or use another tool, like Postman."},"status":{"type":"string","description":"The recording status.","enum":["completed"]},"recording_type":{"type":"string","description":"The recording type. The value of this field is:<br>`summary`","enum":["summary"]}}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.sharing_endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.sharing_ended"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","session_id","session_name","user"],"type":"object","properties":{"id":{"type":"string","description":"The session ID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["id","name","sharing_details"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"Another identifier for the user. Can be a number or characters."},"sharing_details":{"required":["content","date_time"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content:\n* `application` — An application. For example, a web browser.\n* `whiteboard` — The Zoom [whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard).\n* `desktop` — A user's desktop.\n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","unknown"]},"date_time":{"type":"string","description":"The session's screen sharing date and time.","format":"date-time"}},"additionalProperties":false,"description":"Information about the session's screen sharing."}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_pausedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_paused"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_file","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_file":{"type":"object","properties":{"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in general query."}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.endedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["session.ended"]},"event_ts":{"type":"integer","description":"Timestamp at which the event occurred, in milliseconds since epoch. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["end_time","id","session_id","session_name","start_time"],"type":"object","properties":{"id":{"type":"string","description":"The session ID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The session's start time.","format":"date-time"},"end_time":{"type":"string","description":"The session's end time.","format":"date-time"}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["session.started"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","session_id","session_name","start_time"],"type":"object","properties":{"id":{"type":"string","description":"The session's ID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The session's start time.","format":"date-time"}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.stream_ingestion_unbindEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Event name.","enum":["session.stream_ingestion_unbind"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","stream_ingestion"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"stream_ingestion":{"required":["backup_stream_url","stream_id","stream_key","stream_name","stream_url"],"type":"object","properties":{"stream_id":{"type":"string","description":"The stream ingestion ID."},"stream_name":{"type":"string","description":"The stream ingestion name."},"stream_description":{"type":"string","description":"The stream ingestion description."},"stream_key":{"type":"string","description":"The stream ingestion key."},"stream_url":{"type":"string","description":"The stream URL."},"backup_stream_url":{"type":"string","description":"The backup stream URL."}},"description":"Information about the stream ingestion."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.live_streaming_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["session.live_streaming_started"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","live_streaming","session_id","session_name","start_time"],"type":"object","properties":{"id":{"type":"string","description":"The session ID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The session's start time.","format":"date-time"},"live_streaming":{"required":["custom_live_streaming_settings","date_time","service"],"type":"object","properties":{"service":{"type":"string","description":"The name of the Live Streaming service.","enum":["Facebook","Workplace_by_Facebook","YouTube","Custom_Live_Streaming_Service"]},"custom_live_streaming_settings":{"required":["page_url","stream_key","stream_url"],"type":"object","properties":{"stream_url":{"type":"string","description":"The stream's URL."},"stream_key":{"type":"string","description":"The stream's key."},"page_url":{"type":"string","description":"The live stream's page URL."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."}},"description":"The live stream settings."},"date_time":{"type":"string","description":"The live stream's start time.","format":"date-time"}},"description":"Information about the participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_room_system_callout_missedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","inviter_name","message_id","participant","session_id","session_name"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"host_id":{"type":"string","description":"The user ID of the session host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":true,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_phone_callout_acceptedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","participant","session_id","session_key","session_name","user_key"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user_key":{"type":"string","description":"Another identifier for the inviter. Can be a number or characters."},"host_id":{"type":"string","description":"The user ID of the session host."},"participant":{"required":["from_number","invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the session."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"},"from_number":{"type":"integer","description":"The number used to call out to the invited user.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_leftEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.user_left"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","session_id","session_name","user"],"type":"object","properties":{"id":{"type":"string","description":"The session ID."},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["id","leave_time","name","participant_uuid"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"leave_time":{"type":"string","description":"The time at which the user left the session.","format":"date-time"},"leave_reason":{"type":"string","description":"The reason why the user left the session, where `$name` is the participant's username: \n* `$name left the session.` \n* `$name got disconnected from the session.` \n* `Host ended the session.` \n* `Host closed the session.` \n* `Host started a new session.` \n* `Network connection error.` \n* `Host did not join.` \n* `Exceeded free session minutes limit.` \n* `Removed by host.` \n* `Unknown reason.` \n* `Leave waiting room.` \n* `Removed by host from waiting room.`"},"user_key":{"type":"string","description":"Another identifier for the user. Can be a number or characters."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN."},"participant_uuid":{"type":"string","description":"The participant's UUID. This value is assigned to a participant upon joining a session and is only valid for the session's duration."}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.sharing_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.sharing_started"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","session_id","session_name","user"],"type":"object","properties":{"id":{"type":"string","description":"The session ID."},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["id","name","sharing_details"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"Another identifier for the user. Can be a number or characters."},"sharing_details":{"required":["content","date_time"],"type":"object","properties":{"content":{"type":"string","description":"The type of shared content:\n* `application` — An application. For example, a web browser.\n* `whiteboard` — The Zoom [whiteboard](https://support.zoom.us/hc/en-us/articles/205677665-Sharing-a-whiteboard).\n* `desktop` — A user's desktop.\n* `unknown` — An unrecognized application, such as a third party app.","enum":["application","whiteboard","desktop","unknown"]},"date_time":{"type":"string","description":"The session's screen sharing date and time.","format":"date-time"}},"additionalProperties":false,"description":"Information about the session's screen sharing."}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_phone_callout_canceledEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["participant","session_id","session_key","session_name","user_key"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user_key":{"type":"string","description":"Another identifier for the inviter. Can be a number or characters."},"participant":{"required":["from_number","invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the session."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"},"from_number":{"type":"integer","description":"The number used to call out to the invited user.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_transcript_completedEvent":{"required":["download_token","event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_transcript_completed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"download_token":{"type":"string","description":"A generated token used to download the recording. The download token only lasts for 24 hours after its creation and you can only download the file within 24 hours of receiving the event notification. You can either pass the `download_token` as a Bearer token in the Authorization header of your HTTP request (recommended) or include it as a query parameter. See the following for examples. \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://zoom.us/recording/download/123456?access_token=abcdefgh`"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_files","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_files":{"title":"Recording file List","type":"array","description":"List of recording file.","items":{"type":"object","properties":{"id":{"type":"string","description":"The recording file ID. Included in the response of general query."},"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in general query."},"file_name":{"type":"string","description":"Name of the file."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field."},"file_type":{"type":"string","description":"The recording file type. The value of this field could be one of the following:<br>\n`MP4`: Video file of the recording.<br>`M4A` Audio-only file of the recording.<br>`TIMELINE`: Timestamp file of the recording in JSON file format. To get a timeline file, the \"Add a timestamp to the recording\" setting must be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/360060316092). The time will display in the host's timezone, set on their Zoom profile.\n<br> `TRANSCRIPT`: Transcription file of the recording in VTT format.<br> `CHAT`: A TXT file containing in-session chat messages that were sent during the session.<br>`CC`: File containing closed captions of the recording in VTT file format.<br>`CSV`: File containing polling data in csv format.\n\n<br>\n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:<br>\n\t`id`, `status`, `file_size`, `recording_type`.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","CC","TB","CHAT_MESSAGE","TIMELINE"]},"file_size":{"type":"number","description":"The recording file size."},"file_extension":{"type":"string","description":"The archived file's file extension.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"download_url":{"type":"string","description":"The URL at which to download the the recording. \n\nTo access a private or password-protected cloud recording of a user in your account, use your [Video SDK API JWT](https://marketplace.zoom.us/docs/guides/build/video-sdk-app/#video-sdk-and-api-credentials). You can either pass the generated JWT as a Bearer token in the Authorization header of your HTTP request (recommended) or include it as a query parameter at the end of the URL. See the following for examples. \n\n **Using an Authorization header (Recommended)** \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {JWT} \\\n  --header 'content-type: application/json'\n``` \n\n**Using a query parameter** \n\n ```\n{download_url}/?access_token={download_token}\n``` \n\n For example: `https://{base-domain}/recording/download/{path-to-file-download}?access_token={JWT}`."},"status":{"type":"string","description":"The recording status.","enum":["completed"]},"recording_type":{"type":"string","description":"The recording type. The value of this field can be one of the following:<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","chat_message"]}}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_deletedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_deleted"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"operator":{"type":"string","description":"The email address of the user who deleted the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording."},"object":{"required":["session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.ai_interpreter_usage_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event.","enum":["session.ai_interpreter_usage_summary"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["end_time","is_host","participant_uuid","session_id","session_name","start_time","usage"],"type":"object","properties":{"session_id":{"type":"string","description":"The ID of the session. \n\nEach instance of the session will have its own `session_id`."},"session_name":{"type":"string","description":"The name of the session."},"session_key":{"type":"string","description":"The ID of the Video SDK custom session."},"participant_uuid":{"type":"string","description":"The participant's UUID. This value is assigned to a participant upon joining a session and is only valid for the session's duration."},"is_host":{"type":"boolean","description":"Whether the current user is the host of this session."},"start_time":{"type":"string","description":"The start time of AI interpreter usage."},"end_time":{"type":"string","description":"The end time of AI interpreter usage."},"usage":{"type":"string","description":"The duration of AI interpreter usage."}},"description":"Information about the session. This object only returns updated properties."}}}}},"Session.user_room_system_callout_failedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","inviter_name","message_id","participant","reason_type","session_id","session_name"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"host_id":{"type":"string","description":"The user ID of the session host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"reason_type":{"type":"integer","description":"reason type for failure: \n* `1` — Encryption_Fail. \n* `2` — Disconnected_By_Remote. \n* `3` — Retry. \n* `4` — Bad_Seq. \n* `5` — Call_Limit. \n* `6` — Not_Registered. \n* `7` — Timeout. \n* `8` — Bad_Addr. \n* `9` — Unreachable \n* `10` — Disconnect_By_Local \n* `11` — Server_Internal_Error \n* `12` — Exceed_Free_Port \n* `13` — Connect_Error \n* `14` — Proxy_Connect_Error \n* `0` — Other_Failed_Reason.","enum":[0,1,2,3,4,7,8,9,10,11,12,13,14]},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":true,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_completedEvent":{"required":["download_token","event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_completed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"download_token":{"type":"string","description":"A generated token used to download the recording. The download token only lasts for 24 hours after its creation, and you can only download the file within 24 hours of receiving the event notification. Pass the `download_token` as a Bearer token in the Authorization header of your HTTP request. For example: \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {download_token} \\\n  --header 'content-type: application/json'\n```"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_files","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_files":{"title":"Recording file List","type":"array","description":"List of recording files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The recording file ID. Included in the response of a general query."},"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Returned in a general query."},"file_name":{"type":"string","description":"The name of the file."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0058321). It does **not** return the `download_url` field."},"file_type":{"type":"string","description":"The recording file type. The value of this field could be one of the following:<br>\n`MP4` - Video file of the recording.<br>`M4A` - Audio-only file of the recording.<br>`TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, enable the \"Add a timestamp to the recording\" setting in the [recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676). The time displays the host's timezone, as set in their Zoom profile.\n<br> `TRANSCRIPT` - Transcription file of the recording in VTT format.<br> `CHAT` - A TXT file containing in-session chat messages that were sent during the session.<br>`CC` - File containing closed captions of the recording in VTT file format.<br>`CSV` - File containing polling data in CSV format.\n\n<br>\n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:<br>\n\t`id`, `status`, `file_size`, `recording_type`.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","CC","TB","CHAT_MESSAGE"]},"file_size":{"type":"number","description":"The recording file size."},"file_extension":{"type":"string","description":"The archived file's file extension.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"download_url":{"type":"string","description":"The URL at which to download the recording. \n\nTo access a private or password-protected cloud recording of a user in your account, generate a [Build account API JWT](https://developers.zoom.us/docs/build/api-request/). Pass the generated JWT as a Bearer token in the Authorization header of your HTTP request. For example: \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {JWT} \\\n  --header 'content-type: application/json'\n```"},"external_storage_url":{"type":"string","description":"The URL for the recording file when BYOS is enabled. In BYOS accounts, this field replaces `download_url`."},"status":{"type":"string","description":"The recording status.","enum":["completed"]},"recording_type":{"type":"string","description":"The recording type. The value of this field can be one of the following:<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","chat_message"]}}}},"participant_audio_files":{"title":"Recording file List","type":"array","description":"List of recording files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The recording file ID. Included in the response of a general query."},"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Returned in a general query."},"file_name":{"type":"string","description":"The name of the file."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0058321). It does **not** return the `download_url` field."},"file_type":{"type":"string","description":"The recording file type. The value of this field could be one of the following:<br>\n`MP4` - Video file of the recording.<br>`M4A` - Audio-only file of the recording.<br>`TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, enable the \"Add a timestamp to the recording\" setting in the [recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064676). The time displays in the host's timezone, as set in their Zoom profile.\n<br> `TRANSCRIPT` - Transcription file of the recording in VTT format.<br> `CHAT` - A TXT file containing in-session chat messages that were sent during the session.<br>`CC` - File containing closed captions of the recording in VTT file format.<br>`CSV` - File containing polling data in CSV format.\n\n<br>\n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:<br>\n\t`id`, `status`, `file_size`, `recording_type`.","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","CC","TB","CHAT_MESSAGE"]},"file_size":{"type":"number","description":"The recording file size."},"file_extension":{"type":"string","description":"The archived file's file extension.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"]},"download_url":{"type":"string","description":"The URL at which to download the recording. \n\nTo access a private or password-protected cloud recording of a user in your account, generate a [Build account API JWT](https://developers.zoom.us/docs/build/api-request/). Pass the generated JWT as a Bearer token in the Authorization header of your HTTP request. For example: \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {JWT} \\\n  --header 'content-type: application/json'\n```"},"status":{"type":"string","description":"The recording status.","enum":["completed"]},"recording_type":{"type":"string","description":"The recording type. The value of this field can be one of the following:<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","active_speaker","host_video","audio_only_each_participant","cc_transcript","closed_caption","poll","timeline","thumbnail","chat_message"]},"user_id":{"type":"string","description":"The participant's session user ID. This value is assigned to a participant upon joining a session and is only valid for the duration of the session."},"user_key":{"type":"string","description":"The participant's SDK identifier. Set with the `user_identity` key in the Video SDK JWT payload. This value can be alphanumeric, up to a maximum length of 35 characters."}}}},"participant_video_files":{"title":"Recording file List","type":"array","description":"List of recording files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The recording file ID. Included in the response of a general query."},"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Returned in a general query."},"file_name":{"type":"string","description":"The name of the file."},"file_path":{"type":"string","description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0058321). It does **not** return the `download_url` field."},"file_type":{"type":"string","description":"The recording file type. The value of this field could be one of the following:<br>\n`MP4`: Video file of the recording.","enum":["MP4"]},"file_size":{"type":"number","description":"The recording file size."},"file_extension":{"type":"string","description":"The archived file's file extension.","enum":["MP4"]},"download_url":{"type":"string","description":"The URL at which to download the recording. \n\nTo access a private or password-protected cloud recording of a user in your account, generate a [Build account API JWT](https://developers.zoom.us/docs/build/api-request/). Pass the generated JWT as a Bearer token in the Authorization header of your HTTP request. For example: \n\n ```\ncurl --request GET \\\n  --url {download_url} \\\n  --header 'authorization: Bearer {JWT} \\\n  --header 'content-type: application/json'\n```"},"status":{"type":"string","description":"The recording status.","enum":["completed"]},"recording_type":{"type":"string","description":"The recording type. The value of this field can be one of the following:<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`","enum":["individual_user","individual_shared_screen"]},"user_id":{"type":"string","description":"The participant's session user ID. This value is assigned to a participant upon joining a session and is only valid for the duration of the session."},"user_key":{"type":"string","description":"The participant's SDK identifier. Set with the `user_identity` key in the Video SDK JWT payload. This value can be alphanumeric, up to a maximum length of 35 characters."}}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_transcript_failedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_transcript_failed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time when the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_trashedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_trashed"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"operator":{"type":"string","description":"The email address of the user who deleted the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording."},"object":{"required":["session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_joinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.user_joined"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["id","session_id","session_name","user"],"type":"object","properties":{"id":{"type":"string","description":"The session ID."},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["id","join_time","name","participant_uuid"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"join_time":{"type":"string","description":"The time at which the user joined the session.","format":"date-time"},"user_key":{"type":"string","description":"Another identifier for the user. Can be a number or characters."},"phone_number":{"type":"string","description":"Phone number of participant joined via PSTN."},"participant_uuid":{"type":"string","description":"The participant's UUID. This value is assigned to a participant upon joining a session and is only valid for the session's duration."}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.stream_ingestion_startedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Event name.","enum":["session.stream_ingestion_started"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","stream_ingestion"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"stream_ingestion":{"required":["backup_stream_url","stream_id","stream_key","stream_name","stream_url"],"type":"object","properties":{"stream_id":{"type":"string","description":"The stream ingestion ID."},"stream_name":{"type":"string","description":"The stream ingestion name."},"stream_description":{"type":"string","description":"The stream ingestion description."},"stream_key":{"type":"string","description":"The stream ingestion key."},"stream_url":{"type":"string","description":"The stream URL."},"backup_stream_url":{"type":"string","description":"The backup stream URL."}},"description":"Information about the stream ingestion."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.stream_ingestion_connectedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["session.stream_ingestion_connected"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","stream_ingestion"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"stream_ingestion":{"required":["backup_stream_url","stream_id","stream_key","stream_name","stream_url"],"type":"object","properties":{"stream_id":{"type":"string","description":"The stream ingestion ID."},"stream_name":{"type":"string","description":"The stream ingestion name."},"stream_description":{"type":"string","description":"The stream ingestion description."},"stream_key":{"type":"string","description":"The stream ingestion key."},"stream_url":{"type":"string","description":"The stream URL."},"backup_stream_url":{"type":"string","description":"The backup stream URL."}},"description":"Information about the stream ingestion."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.stream_ingestion_disconnectedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["session.stream_ingestion_disconnected"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","stream_ingestion"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"stream_ingestion":{"required":["backup_stream_url","stream_id","stream_key","stream_name","stream_url"],"type":"object","properties":{"stream_id":{"type":"string","description":"The stream ingestion ID."},"stream_name":{"type":"string","description":"The stream ingestion name."},"stream_description":{"type":"string","description":"The stream ingestion description."},"stream_key":{"type":"string","description":"The stream ingestion key."},"stream_url":{"type":"string","description":"The stream URL."},"backup_stream_url":{"type":"string","description":"The backup stream URL."}},"description":"Information about the stream ingestion."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_recoveredEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_recovered"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object","operator","operator_id"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"operator":{"type":"string","description":"The email address of the user who deleted the recording.","format":"email"},"operator_id":{"type":"string","description":"The user ID of the user who deleted the recording."},"object":{"required":["session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_phone_callout_missedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","participant","session_id","session_key","session_name","user_key"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user_key":{"type":"string","description":"Another identifier for the inviter. Can be a number or characters."},"host_id":{"type":"string","description":"The user ID of the session host."},"participant":{"required":["from_number","invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the session."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"},"from_number":{"type":"integer","description":"The number used to call out to the invited user.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_phone_callout_rejectedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","participant","session_id","session_key","session_name","user_key"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user_key":{"type":"string","description":"Another identifier for the inviter. Can be a number or characters."},"host_id":{"type":"string","description":"The user ID of the session host."},"participant":{"required":["from_number","invitee_name","phone_number"],"type":"object","properties":{"invitee_name":{"type":"string","description":"The user's name to display in the session."},"phone_number":{"type":"integer","description":"The user's phone number.","format":"int64"},"from_number":{"type":"integer","description":"The number used to call out to the invited user.","format":"int64"}},"additionalProperties":false,"description":"Information about the invited user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_room_system_callout_acceptedEvent":{"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","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID of the session host."},"object":{"required":["host_id","inviter_name","message_id","participant","session_id","session_name"],"type":"object","properties":{"id":{"type":"integer","description":"The session ID.","format":"int64","deprecated":true},"uuid":{"type":"string","description":"The session's universally unique identifier (UUID). Each session instance generates a session UUID.","deprecated":true},"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"host_id":{"type":"string","description":"The user ID of the session host."},"message_id":{"type":"string","description":"The request unique identifier (UUID)."},"inviter_name":{"type":"string","description":"The user name of the event's trigger."},"participant":{"required":["call_type","device_ip"],"type":"object","properties":{"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`."},"device_ip":{"type":"string","description":"The user's device IP address."}},"additionalProperties":true,"description":"Information about the invited participant."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Session.recording_stoppedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["session.recording_stopped"]},"event_ts":{"type":"integer","description":"A timestamp, in milliseconds since epoch, at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["recording_file","session_id","session_key","session_name","start_time","timezone"],"type":"object","properties":{"session_id":{"type":"string","description":"Unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"start_time":{"type":"string","description":"The time at which the session started.","format":"date-time"},"timezone":{"type":"string","description":"The user's timezone."},"recording_file":{"type":"object","properties":{"recording_start":{"type":"string","description":"The recording start time."},"recording_end":{"type":"string","description":"The recording end time. Response in general query."}}}},"additionalProperties":false,"description":"Information about the session. This object only returns updated properties."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"Sessions"},{"name":"Cloud Recording"},{"name":"AI Interpreter"}],"servers":[{"url":"https://{your-endpoint-url}"}]}