mokkenstorm.dev
fork of hey-api/openapi-ts because I need some additional things
1{
2 "openapi": "3.1.0",
3 "info": {
4 "title": "Video SDK",
5 "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).",
6 "version": "1.0.0"
7 },
8 "webhooks": {
9 "session.user_phone_callout_ringing": {
10 "post": {
11 "tags": ["session"],
12 "operationId": "session.user_phone_callout_ringing",
13 "requestBody": {
14 "description": "# session.user_phone_callout_ringing\n\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\n\n**Event type**: `session.user_phone_callout_ringing`\n",
15 "content": {
16 "application/json": {
17 "schema": {
18 "type": "object",
19 "required": ["event", "event_ts", "payload"],
20 "properties": {
21 "event": {
22 "type": "string",
23 "description": "The name of the event."
24 },
25 "event_ts": {
26 "type": "integer",
27 "format": "int64",
28 "description": "A timestamp at which the event occurred."
29 },
30 "payload": {
31 "type": "object",
32 "required": ["account_id", "object"],
33 "properties": {
34 "account_id": {
35 "type": "string",
36 "description": "The account ID of the session host."
37 },
38 "object": {
39 "type": "object",
40 "description": "Information about the session.",
41 "required": [
42 "session_id",
43 "session_name",
44 "session_key",
45 "user_key",
46 "host_id",
47 "participant"
48 ],
49 "properties": {
50 "id": {
51 "type": "integer",
52 "format": "int64",
53 "description": "The session ID.",
54 "deprecated": true
55 },
56 "uuid": {
57 "type": "string",
58 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
59 "deprecated": true
60 },
61 "session_id": {
62 "type": "string",
63 "description": "Unique session identifier. Each instance of the session will have its own session_id."
64 },
65 "session_name": {
66 "type": "string",
67 "description": "Session name."
68 },
69 "session_key": {
70 "type": "string",
71 "description": "The Video SDK custom session ID."
72 },
73 "user_key": {
74 "type": "string",
75 "description": "Another identifier for the inviter. Can be a number or characters."
76 },
77 "host_id": {
78 "type": "string",
79 "description": "The user ID of the session host."
80 },
81 "participant": {
82 "type": "object",
83 "description": "Information about the invited user.",
84 "required": [
85 "invitee_name",
86 "phone_number",
87 "from_number"
88 ],
89 "properties": {
90 "invitee_name": {
91 "type": "string",
92 "description": "The user's name to display in the session."
93 },
94 "phone_number": {
95 "type": "integer",
96 "format": "int64",
97 "description": "The user's phone number."
98 },
99 "from_number": {
100 "type": "integer",
101 "format": "int64",
102 "description": "The number used to call out to the invited user."
103 }
104 },
105 "additionalProperties": false
106 }
107 },
108 "additionalProperties": false
109 }
110 },
111 "additionalProperties": false
112 }
113 },
114 "additionalProperties": false
115 },
116 "examples": {
117 "json-example": {
118 "summary": "JSON example",
119 "value": "{\n \"event\": \"session.user_phone_callout_ringing\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
120 }
121 }
122 }
123 }
124 },
125 "responses": {
126 "200": {
127 "content": {
128 "application/json": {
129 "schema": {
130 "type": "object",
131 "required": ["event", "event_ts", "payload"],
132 "properties": {
133 "event": {
134 "type": "string",
135 "description": "The name of the event."
136 },
137 "event_ts": {
138 "type": "integer",
139 "format": "int64",
140 "description": "A timestamp at which the event occurred."
141 },
142 "payload": {
143 "type": "object",
144 "required": ["account_id", "object"],
145 "properties": {
146 "account_id": {
147 "type": "string",
148 "description": "The account ID of the session host."
149 },
150 "object": {
151 "type": "object",
152 "description": "Information about the session.",
153 "required": [
154 "session_id",
155 "session_name",
156 "session_key",
157 "user_key",
158 "host_id",
159 "participant"
160 ],
161 "properties": {
162 "id": {
163 "type": "integer",
164 "format": "int64",
165 "description": "The session ID.",
166 "deprecated": true
167 },
168 "uuid": {
169 "type": "string",
170 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
171 "deprecated": true
172 },
173 "session_id": {
174 "type": "string",
175 "description": "Unique session identifier. Each instance of the session will have its own session_id."
176 },
177 "session_name": {
178 "type": "string",
179 "description": "Session name."
180 },
181 "session_key": {
182 "type": "string",
183 "description": "The Video SDK custom session ID."
184 },
185 "user_key": {
186 "type": "string",
187 "description": "Another identifier for the inviter. Can be a number or characters."
188 },
189 "host_id": {
190 "type": "string",
191 "description": "The user ID of the session host."
192 },
193 "participant": {
194 "type": "object",
195 "description": "Information about the invited user.",
196 "required": [
197 "invitee_name",
198 "phone_number",
199 "from_number"
200 ],
201 "properties": {
202 "invitee_name": {
203 "type": "string",
204 "description": "The user's name to display in the session."
205 },
206 "phone_number": {
207 "type": "integer",
208 "format": "int64",
209 "description": "The user's phone number."
210 },
211 "from_number": {
212 "type": "integer",
213 "format": "int64",
214 "description": "The number used to call out to the invited user."
215 }
216 },
217 "additionalProperties": false
218 }
219 },
220 "additionalProperties": false
221 }
222 },
223 "additionalProperties": false
224 }
225 },
226 "additionalProperties": false
227 },
228 "examples": {
229 "json-example": {
230 "summary": "JSON example",
231 "value": "{\n \"event\": \"session.user_phone_callout_ringing\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
232 }
233 }
234 }
235 }
236 }
237 }
238 }
239 },
240 "session.user_room_system_callout_ringing": {
241 "post": {
242 "tags": ["session"],
243 "operationId": "session.user_room_system_callout_ringing",
244 "requestBody": {
245 "description": "# session.user_room_system_callout_ringing\n\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\n\n**Event type**: `session.user_room_system_callout_ringing`\n",
246 "content": {
247 "application/json": {
248 "schema": {
249 "type": "object",
250 "required": ["event", "event_ts", "payload"],
251 "properties": {
252 "event": {
253 "type": "string",
254 "description": "The name of the event."
255 },
256 "event_ts": {
257 "type": "integer",
258 "format": "int64",
259 "description": "A timestamp at which the event occurred."
260 },
261 "payload": {
262 "type": "object",
263 "required": ["account_id", "object"],
264 "properties": {
265 "account_id": {
266 "type": "string",
267 "description": "The account ID of the session host."
268 },
269 "object": {
270 "type": "object",
271 "description": "Information about the session.",
272 "required": [
273 "session_id",
274 "session_name",
275 "host_id",
276 "message_id",
277 "inviter_name",
278 "participant"
279 ],
280 "properties": {
281 "id": {
282 "type": "integer",
283 "format": "int64",
284 "description": "The session ID.",
285 "deprecated": true
286 },
287 "uuid": {
288 "type": "string",
289 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
290 "deprecated": true
291 },
292 "session_id": {
293 "type": "string",
294 "description": "Unique session identifier. Each instance of the session will have its own session_id."
295 },
296 "session_name": {
297 "type": "string",
298 "description": "Session name."
299 },
300 "host_id": {
301 "type": "string",
302 "description": "The user ID of the session host."
303 },
304 "message_id": {
305 "type": "string",
306 "description": "The request unique identifier (UUID)."
307 },
308 "inviter_name": {
309 "type": "string",
310 "description": "The user name of the event's trigger."
311 },
312 "participant": {
313 "type": "object",
314 "description": "Information about the invited participant.",
315 "required": ["call_type", "device_ip"],
316 "properties": {
317 "call_type": {
318 "type": "string",
319 "description": "The type of call out. Use a value of h323 or sip."
320 },
321 "device_ip": {
322 "type": "string",
323 "description": "The user's device IP address."
324 }
325 },
326 "additionalProperties": true
327 }
328 },
329 "additionalProperties": false
330 }
331 },
332 "additionalProperties": false
333 }
334 },
335 "additionalProperties": false
336 },
337 "examples": {
338 "json-example": {
339 "summary": "JSON example",
340 "value": "{\n \"event\": \"session.user_room_system_callout_ringing\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
341 }
342 }
343 }
344 }
345 },
346 "responses": {
347 "200": {
348 "content": {
349 "application/json": {
350 "schema": {
351 "type": "object",
352 "required": ["event", "event_ts", "payload"],
353 "properties": {
354 "event": {
355 "type": "string",
356 "description": "The name of the event."
357 },
358 "event_ts": {
359 "type": "integer",
360 "format": "int64",
361 "description": "A timestamp at which the event occurred."
362 },
363 "payload": {
364 "type": "object",
365 "required": ["account_id", "object"],
366 "properties": {
367 "account_id": {
368 "type": "string",
369 "description": "The account ID of the session host."
370 },
371 "object": {
372 "type": "object",
373 "description": "Information about the session.",
374 "required": [
375 "session_id",
376 "session_name",
377 "host_id",
378 "message_id",
379 "inviter_name",
380 "participant"
381 ],
382 "properties": {
383 "id": {
384 "type": "integer",
385 "format": "int64",
386 "description": "The session ID.",
387 "deprecated": true
388 },
389 "uuid": {
390 "type": "string",
391 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
392 "deprecated": true
393 },
394 "session_id": {
395 "type": "string",
396 "description": "Unique session identifier. Each instance of the session will have its own session_id."
397 },
398 "session_name": {
399 "type": "string",
400 "description": "Session name."
401 },
402 "host_id": {
403 "type": "string",
404 "description": "The user ID of the session host."
405 },
406 "message_id": {
407 "type": "string",
408 "description": "The request unique identifier (UUID)."
409 },
410 "inviter_name": {
411 "type": "string",
412 "description": "The user name of the event's trigger."
413 },
414 "participant": {
415 "type": "object",
416 "description": "Information about the invited participant.",
417 "required": ["call_type", "device_ip"],
418 "properties": {
419 "call_type": {
420 "type": "string",
421 "description": "The type of call out. Use a value of h323 or sip."
422 },
423 "device_ip": {
424 "type": "string",
425 "description": "The user's device IP address."
426 }
427 },
428 "additionalProperties": true
429 }
430 },
431 "additionalProperties": false
432 }
433 },
434 "additionalProperties": false
435 }
436 },
437 "additionalProperties": false
438 },
439 "examples": {
440 "json-example": {
441 "summary": "JSON example",
442 "value": "{\n \"event\": \"session.user_room_system_callout_ringing\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
443 }
444 }
445 }
446 }
447 }
448 }
449 }
450 },
451 "session.recording_started": {
452 "post": {
453 "tags": ["session"],
454 "operationId": "session.recording_started",
455 "requestBody": {
456 "description": "# session.recording_started\n---\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\n\n**Event type**: `session.recording_started`\n",
457 "content": {
458 "application/json": {
459 "schema": {
460 "type": "object",
461 "required": ["event", "event_ts", "payload"],
462 "properties": {
463 "event": {
464 "type": "string",
465 "enum": ["session.recording_started"],
466 "description": "The event's name."
467 },
468 "event_ts": {
469 "type": "integer",
470 "format": "int64",
471 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
472 },
473 "payload": {
474 "type": "object",
475 "required": ["account_id", "object"],
476 "properties": {
477 "account_id": {
478 "type": "string",
479 "description": "The Video SDK account ID."
480 },
481 "object": {
482 "type": "object",
483 "description": "Information about the session. This object only returns updated properties.",
484 "required": [
485 "session_id",
486 "session_name",
487 "session_key",
488 "start_time",
489 "timezone",
490 "recording_file"
491 ],
492 "properties": {
493 "session_id": {
494 "type": "string",
495 "description": "Unique session identifier. Each instance of the session will have its own session_id."
496 },
497 "session_name": {
498 "type": "string",
499 "description": "Session name."
500 },
501 "session_key": {
502 "type": "string",
503 "description": "The Video SDK custom session ID."
504 },
505 "start_time": {
506 "type": "string",
507 "format": "date-time",
508 "description": "The time at which the session started."
509 },
510 "timezone": {
511 "type": "string",
512 "description": "The user's timezone."
513 },
514 "recording_file": {
515 "type": "object",
516 "properties": {
517 "recording_start": {
518 "type": "string",
519 "description": "The recording start time."
520 },
521 "recording_end": {
522 "type": "string",
523 "description": "The recording end time. Response in general query."
524 }
525 }
526 }
527 },
528 "additionalProperties": false
529 }
530 },
531 "additionalProperties": false
532 }
533 },
534 "additionalProperties": false
535 },
536 "examples": {
537 "json-example": {
538 "summary": "JSON example",
539 "value": "{\n \"event\": \"session.recording_started\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
540 }
541 }
542 }
543 }
544 },
545 "responses": {
546 "200": {
547 "content": {
548 "application/json": {
549 "schema": {
550 "type": "object",
551 "required": ["event", "event_ts", "payload"],
552 "properties": {
553 "event": {
554 "type": "string",
555 "enum": ["session.recording_started"],
556 "description": "The event's name."
557 },
558 "event_ts": {
559 "type": "integer",
560 "format": "int64",
561 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
562 },
563 "payload": {
564 "type": "object",
565 "required": ["account_id", "object"],
566 "properties": {
567 "account_id": {
568 "type": "string",
569 "description": "The Video SDK account ID."
570 },
571 "object": {
572 "type": "object",
573 "description": "Information about the session. This object only returns updated properties.",
574 "required": [
575 "session_id",
576 "session_name",
577 "session_key",
578 "start_time",
579 "timezone",
580 "recording_file"
581 ],
582 "properties": {
583 "session_id": {
584 "type": "string",
585 "description": "Unique session identifier. Each instance of the session will have its own session_id."
586 },
587 "session_name": {
588 "type": "string",
589 "description": "Session name."
590 },
591 "session_key": {
592 "type": "string",
593 "description": "The Video SDK custom session ID."
594 },
595 "start_time": {
596 "type": "string",
597 "format": "date-time",
598 "description": "The time at which the session started."
599 },
600 "timezone": {
601 "type": "string",
602 "description": "The user's timezone."
603 },
604 "recording_file": {
605 "type": "object",
606 "properties": {
607 "recording_start": {
608 "type": "string",
609 "description": "The recording start time."
610 },
611 "recording_end": {
612 "type": "string",
613 "description": "The recording end time. Response in general query."
614 }
615 }
616 }
617 },
618 "additionalProperties": false
619 }
620 },
621 "additionalProperties": false
622 }
623 },
624 "additionalProperties": false
625 },
626 "examples": {
627 "json-example": {
628 "summary": "JSON example",
629 "value": "{\n \"event\": \"session.recording_started\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
630 }
631 }
632 }
633 }
634 }
635 }
636 }
637 },
638 "session.recording_resumed": {
639 "post": {
640 "tags": ["session"],
641 "operationId": "session.recording_resumed",
642 "requestBody": {
643 "description": "# session.recording_resumed\n---\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\n\n**Event type**: `session.recording_resumed`\n",
644 "content": {
645 "application/json": {
646 "schema": {
647 "type": "object",
648 "required": ["event", "event_ts", "payload"],
649 "properties": {
650 "event": {
651 "type": "string",
652 "enum": ["session.recording_resumed"],
653 "description": "The event's name."
654 },
655 "event_ts": {
656 "type": "integer",
657 "format": "int64",
658 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
659 },
660 "payload": {
661 "type": "object",
662 "required": ["account_id", "object"],
663 "properties": {
664 "account_id": {
665 "type": "string",
666 "description": "The Video SDK account ID."
667 },
668 "object": {
669 "type": "object",
670 "description": "Information about the session. This object only returns updated properties.",
671 "required": [
672 "session_id",
673 "session_name",
674 "session_key",
675 "start_time",
676 "timezone",
677 "recording_file"
678 ],
679 "properties": {
680 "session_id": {
681 "type": "string",
682 "description": "Unique session identifier. Each instance of the session will have its own session_id."
683 },
684 "session_name": {
685 "type": "string",
686 "description": "Session name."
687 },
688 "session_key": {
689 "type": "string",
690 "description": "The Video SDK custom session ID."
691 },
692 "start_time": {
693 "type": "string",
694 "format": "date-time",
695 "description": "The time at which the session started."
696 },
697 "timezone": {
698 "type": "string",
699 "description": "The user's timezone."
700 },
701 "recording_file": {
702 "type": "object",
703 "properties": {
704 "recording_start": {
705 "type": "string",
706 "description": "The recording start time."
707 },
708 "recording_end": {
709 "type": "string",
710 "description": "The recording end time. Response in general query."
711 }
712 }
713 }
714 },
715 "additionalProperties": false
716 }
717 },
718 "additionalProperties": false
719 }
720 },
721 "additionalProperties": false
722 },
723 "examples": {
724 "json-example": {
725 "summary": "JSON example",
726 "value": "{\n \"event\": \"session.recording_resumed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
727 }
728 }
729 }
730 }
731 },
732 "responses": {
733 "200": {
734 "content": {
735 "application/json": {
736 "schema": {
737 "type": "object",
738 "required": ["event", "event_ts", "payload"],
739 "properties": {
740 "event": {
741 "type": "string",
742 "enum": ["session.recording_resumed"],
743 "description": "The event's name."
744 },
745 "event_ts": {
746 "type": "integer",
747 "format": "int64",
748 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
749 },
750 "payload": {
751 "type": "object",
752 "required": ["account_id", "object"],
753 "properties": {
754 "account_id": {
755 "type": "string",
756 "description": "The Video SDK account ID."
757 },
758 "object": {
759 "type": "object",
760 "description": "Information about the session. This object only returns updated properties.",
761 "required": [
762 "session_id",
763 "session_name",
764 "session_key",
765 "start_time",
766 "timezone",
767 "recording_file"
768 ],
769 "properties": {
770 "session_id": {
771 "type": "string",
772 "description": "Unique session identifier. Each instance of the session will have its own session_id."
773 },
774 "session_name": {
775 "type": "string",
776 "description": "Session name."
777 },
778 "session_key": {
779 "type": "string",
780 "description": "The Video SDK custom session ID."
781 },
782 "start_time": {
783 "type": "string",
784 "format": "date-time",
785 "description": "The time at which the session started."
786 },
787 "timezone": {
788 "type": "string",
789 "description": "The user's timezone."
790 },
791 "recording_file": {
792 "type": "object",
793 "properties": {
794 "recording_start": {
795 "type": "string",
796 "description": "The recording start time."
797 },
798 "recording_end": {
799 "type": "string",
800 "description": "The recording end time. Response in general query."
801 }
802 }
803 }
804 },
805 "additionalProperties": false
806 }
807 },
808 "additionalProperties": false
809 }
810 },
811 "additionalProperties": false
812 },
813 "examples": {
814 "json-example": {
815 "summary": "JSON example",
816 "value": "{\n \"event\": \"session.recording_resumed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
817 }
818 }
819 }
820 }
821 }
822 }
823 }
824 },
825 "session.live_streaming_stopped": {
826 "post": {
827 "tags": ["session"],
828 "operationId": "session.live_streaming_stopped",
829 "requestBody": {
830 "description": "# session.live_streaming_stopped\n---\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\n\n**Event type**: `session.live_streaming_stopped`\n",
831 "content": {
832 "application/json": {
833 "schema": {
834 "type": "object",
835 "required": ["event", "event_ts", "payload"],
836 "properties": {
837 "event": {
838 "type": "string",
839 "enum": ["session.live_streaming_stopped"],
840 "description": "The name of the event."
841 },
842 "event_ts": {
843 "type": "integer",
844 "format": "int64",
845 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
846 },
847 "payload": {
848 "type": "object",
849 "required": ["account_id", "object"],
850 "properties": {
851 "account_id": {
852 "type": "string",
853 "description": "The Video SDK account ID."
854 },
855 "object": {
856 "type": "object",
857 "description": "Information about the session.",
858 "required": [
859 "id",
860 "session_id",
861 "session_name",
862 "start_time",
863 "live_streaming"
864 ],
865 "properties": {
866 "id": {
867 "type": "string",
868 "description": "The session ID.",
869 "deprecated": true
870 },
871 "session_id": {
872 "type": "string",
873 "description": "Unique session identifier. Each instance of the session will have its own session_id."
874 },
875 "session_name": {
876 "type": "string",
877 "description": "Session name."
878 },
879 "session_key": {
880 "type": "string",
881 "description": "The Video SDK custom session ID."
882 },
883 "start_time": {
884 "type": "string",
885 "description": "The session's start time.",
886 "format": "date-time"
887 },
888 "live_streaming": {
889 "type": "object",
890 "description": "Information about the participant.",
891 "required": [
892 "service",
893 "custom_live_streaming_settings",
894 "date_time"
895 ],
896 "properties": {
897 "service": {
898 "type": "string",
899 "description": "The name of the Live Streaming service.",
900 "enum": [
901 "Facebook",
902 "Workplace_by_Facebook",
903 "YouTube",
904 "Custom_Live_Streaming_Service"
905 ]
906 },
907 "custom_live_streaming_settings": {
908 "type": "object",
909 "description": "The live stream settings.",
910 "required": [
911 "stream_url",
912 "stream_key",
913 "page_url"
914 ],
915 "properties": {
916 "stream_url": {
917 "type": "string",
918 "description": "The stream's URL."
919 },
920 "stream_key": {
921 "type": "string",
922 "description": "The stream's Key."
923 },
924 "page_url": {
925 "type": "string",
926 "description": "The live stream's page URL."
927 },
928 "resolution": {
929 "type": "string",
930 "description": "The number of pixels in each dimension that the video camera can display."
931 }
932 }
933 },
934 "date_time": {
935 "type": "string",
936 "description": "The live stream's stop time.",
937 "format": "date-time"
938 }
939 }
940 }
941 },
942 "additionalProperties": false
943 }
944 },
945 "additionalProperties": false
946 }
947 },
948 "additionalProperties": false
949 },
950 "examples": {
951 "json-example": {
952 "summary": "JSON example",
953 "value": "{\n \"event\": \"session.live_streaming_stopped\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:03:32Z\",\n \"live_streaming\": {\n \"service\": \"Custom_Live_Streaming_Service\",\n \"custom_live_streaming_settings\": {\n \"stream_url\": \"https://example.com/livestream\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"page_url\": \"https://example.com/livestream/123\",\n\t\t \"resolution\": \"1080p\"\n },\n \"date_time\": \"2021-08-02T12:22:45Z\"\n }\n }\n }\n}"
954 }
955 }
956 }
957 }
958 },
959 "responses": {
960 "200": {
961 "content": {
962 "application/json": {
963 "schema": {
964 "type": "object",
965 "required": ["event", "event_ts", "payload"],
966 "properties": {
967 "event": {
968 "type": "string",
969 "enum": ["session.live_streaming_stopped"],
970 "description": "The name of the event."
971 },
972 "event_ts": {
973 "type": "integer",
974 "format": "int64",
975 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
976 },
977 "payload": {
978 "type": "object",
979 "required": ["account_id", "object"],
980 "properties": {
981 "account_id": {
982 "type": "string",
983 "description": "The Video SDK account ID."
984 },
985 "object": {
986 "type": "object",
987 "description": "Information about the session.",
988 "required": [
989 "id",
990 "session_id",
991 "session_name",
992 "start_time",
993 "live_streaming"
994 ],
995 "properties": {
996 "id": {
997 "type": "string",
998 "description": "The session ID.",
999 "deprecated": true
1000 },
1001 "session_id": {
1002 "type": "string",
1003 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1004 },
1005 "session_name": {
1006 "type": "string",
1007 "description": "Session name."
1008 },
1009 "session_key": {
1010 "type": "string",
1011 "description": "The Video SDK custom session ID."
1012 },
1013 "start_time": {
1014 "type": "string",
1015 "description": "The session's start time.",
1016 "format": "date-time"
1017 },
1018 "live_streaming": {
1019 "type": "object",
1020 "description": "Information about the participant.",
1021 "required": [
1022 "service",
1023 "custom_live_streaming_settings",
1024 "date_time"
1025 ],
1026 "properties": {
1027 "service": {
1028 "type": "string",
1029 "description": "The name of the Live Streaming service.",
1030 "enum": [
1031 "Facebook",
1032 "Workplace_by_Facebook",
1033 "YouTube",
1034 "Custom_Live_Streaming_Service"
1035 ]
1036 },
1037 "custom_live_streaming_settings": {
1038 "type": "object",
1039 "description": "The live stream settings.",
1040 "required": [
1041 "stream_url",
1042 "stream_key",
1043 "page_url"
1044 ],
1045 "properties": {
1046 "stream_url": {
1047 "type": "string",
1048 "description": "The stream's URL."
1049 },
1050 "stream_key": {
1051 "type": "string",
1052 "description": "The stream's Key."
1053 },
1054 "page_url": {
1055 "type": "string",
1056 "description": "The live stream's page URL."
1057 },
1058 "resolution": {
1059 "type": "string",
1060 "description": "The number of pixels in each dimension that the video camera can display."
1061 }
1062 }
1063 },
1064 "date_time": {
1065 "type": "string",
1066 "description": "The live stream's stop time.",
1067 "format": "date-time"
1068 }
1069 }
1070 }
1071 },
1072 "additionalProperties": false
1073 }
1074 },
1075 "additionalProperties": false
1076 }
1077 },
1078 "additionalProperties": false
1079 },
1080 "examples": {
1081 "json-example": {
1082 "summary": "JSON example",
1083 "value": "{\n \"event\": \"session.live_streaming_stopped\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:03:32Z\",\n \"live_streaming\": {\n \"service\": \"Custom_Live_Streaming_Service\",\n \"custom_live_streaming_settings\": {\n \"stream_url\": \"https://example.com/livestream\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"page_url\": \"https://example.com/livestream/123\",\n\t\t \"resolution\": \"1080p\"\n },\n \"date_time\": \"2021-08-02T12:22:45Z\"\n }\n }\n }\n}"
1084 }
1085 }
1086 }
1087 }
1088 }
1089 }
1090 }
1091 },
1092 "session.stream_ingestion_stopped": {
1093 "post": {
1094 "tags": ["session"],
1095 "operationId": "session.stream_ingestion_stopped",
1096 "requestBody": {
1097 "description": "# session.stream_ingestion_stopped\nZoom 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\n\n**Event type**: `session.stream_ingestion_stopped`\n",
1098 "content": {
1099 "application/json": {
1100 "schema": {
1101 "type": "object",
1102 "required": ["event", "event_ts", "payload"],
1103 "properties": {
1104 "event": {
1105 "type": "string",
1106 "enum": ["session.stream_ingestion_stopped"],
1107 "description": "Event name."
1108 },
1109 "event_ts": {
1110 "type": "integer",
1111 "format": "int64",
1112 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
1113 },
1114 "payload": {
1115 "type": "object",
1116 "required": ["account_id", "object"],
1117 "properties": {
1118 "account_id": {
1119 "type": "string",
1120 "description": "The Video SDK account ID."
1121 },
1122 "object": {
1123 "type": "object",
1124 "description": "Information about the session.",
1125 "required": [
1126 "session_id",
1127 "session_name",
1128 "stream_ingestion"
1129 ],
1130 "properties": {
1131 "session_id": {
1132 "type": "string",
1133 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1134 },
1135 "session_name": {
1136 "type": "string",
1137 "description": "Session name."
1138 },
1139 "session_key": {
1140 "type": "string",
1141 "description": "The Video SDK custom session ID."
1142 },
1143 "stream_ingestion": {
1144 "type": "object",
1145 "description": "Information about the stream ingestion.",
1146 "required": [
1147 "stream_id",
1148 "stream_name",
1149 "stream_key",
1150 "stream_url",
1151 "backup_stream_url"
1152 ],
1153 "properties": {
1154 "stream_id": {
1155 "type": "string",
1156 "description": "The stream ingestion ID."
1157 },
1158 "stream_name": {
1159 "type": "string",
1160 "description": "The stream ingestion name."
1161 },
1162 "stream_description": {
1163 "type": "string",
1164 "description": "The stream ingestion description."
1165 },
1166 "stream_key": {
1167 "type": "string",
1168 "description": "The stream ingestion key."
1169 },
1170 "stream_url": {
1171 "type": "string",
1172 "description": "The stream URL."
1173 },
1174 "backup_stream_url": {
1175 "type": "string",
1176 "description": "The backup stream URL."
1177 }
1178 }
1179 }
1180 },
1181 "additionalProperties": false
1182 }
1183 },
1184 "additionalProperties": false
1185 }
1186 },
1187 "additionalProperties": false
1188 },
1189 "examples": {
1190 "json-example": {
1191 "summary": "JSON example",
1192 "value": "{\n \"event\": \"session.stream_ingestion_stopped\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
1193 }
1194 }
1195 }
1196 }
1197 },
1198 "responses": {
1199 "200": {
1200 "content": {
1201 "application/json": {
1202 "schema": {
1203 "type": "object",
1204 "required": ["event", "event_ts", "payload"],
1205 "properties": {
1206 "event": {
1207 "type": "string",
1208 "enum": ["session.stream_ingestion_stopped"],
1209 "description": "Event name."
1210 },
1211 "event_ts": {
1212 "type": "integer",
1213 "format": "int64",
1214 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
1215 },
1216 "payload": {
1217 "type": "object",
1218 "required": ["account_id", "object"],
1219 "properties": {
1220 "account_id": {
1221 "type": "string",
1222 "description": "The Video SDK account ID."
1223 },
1224 "object": {
1225 "type": "object",
1226 "description": "Information about the session.",
1227 "required": [
1228 "session_id",
1229 "session_name",
1230 "stream_ingestion"
1231 ],
1232 "properties": {
1233 "session_id": {
1234 "type": "string",
1235 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1236 },
1237 "session_name": {
1238 "type": "string",
1239 "description": "Session name."
1240 },
1241 "session_key": {
1242 "type": "string",
1243 "description": "The Video SDK custom session ID."
1244 },
1245 "stream_ingestion": {
1246 "type": "object",
1247 "description": "Information about the stream ingestion.",
1248 "required": [
1249 "stream_id",
1250 "stream_name",
1251 "stream_key",
1252 "stream_url",
1253 "backup_stream_url"
1254 ],
1255 "properties": {
1256 "stream_id": {
1257 "type": "string",
1258 "description": "The stream ingestion ID."
1259 },
1260 "stream_name": {
1261 "type": "string",
1262 "description": "The stream ingestion name."
1263 },
1264 "stream_description": {
1265 "type": "string",
1266 "description": "The stream ingestion description."
1267 },
1268 "stream_key": {
1269 "type": "string",
1270 "description": "The stream ingestion key."
1271 },
1272 "stream_url": {
1273 "type": "string",
1274 "description": "The stream URL."
1275 },
1276 "backup_stream_url": {
1277 "type": "string",
1278 "description": "The backup stream URL."
1279 }
1280 }
1281 }
1282 },
1283 "additionalProperties": false
1284 }
1285 },
1286 "additionalProperties": false
1287 }
1288 },
1289 "additionalProperties": false
1290 },
1291 "examples": {
1292 "json-example": {
1293 "summary": "JSON example",
1294 "value": "{\n \"event\": \"session.stream_ingestion_stopped\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
1295 }
1296 }
1297 }
1298 }
1299 }
1300 }
1301 }
1302 },
1303 "session.user_room_system_callout_rejected": {
1304 "post": {
1305 "tags": ["session"],
1306 "operationId": "session.user_room_system_callout_rejected",
1307 "requestBody": {
1308 "description": "# session.user_room_system_callout_rejected\n\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\n\n**Event type**: `session.user_room_system_callout_rejected`\n",
1309 "content": {
1310 "application/json": {
1311 "schema": {
1312 "type": "object",
1313 "required": ["event", "event_ts", "payload"],
1314 "properties": {
1315 "event": {
1316 "type": "string",
1317 "description": "The name of the event."
1318 },
1319 "event_ts": {
1320 "type": "integer",
1321 "format": "int64",
1322 "description": "A timestamp at which the event occurred."
1323 },
1324 "payload": {
1325 "type": "object",
1326 "required": ["account_id", "object"],
1327 "properties": {
1328 "account_id": {
1329 "type": "string",
1330 "description": "The account ID of the session host."
1331 },
1332 "object": {
1333 "type": "object",
1334 "description": "Information about the session.",
1335 "required": [
1336 "session_id",
1337 "session_name",
1338 "host_id",
1339 "message_id",
1340 "inviter_name",
1341 "participant"
1342 ],
1343 "properties": {
1344 "id": {
1345 "type": "integer",
1346 "format": "int64",
1347 "description": "The session ID.",
1348 "deprecated": true
1349 },
1350 "uuid": {
1351 "type": "string",
1352 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
1353 "deprecated": true
1354 },
1355 "session_id": {
1356 "type": "string",
1357 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1358 },
1359 "session_name": {
1360 "type": "string",
1361 "description": "Session name."
1362 },
1363 "host_id": {
1364 "type": "string",
1365 "description": "The user ID of the session host."
1366 },
1367 "message_id": {
1368 "type": "string",
1369 "description": "The request unique identifier (UUID)."
1370 },
1371 "inviter_name": {
1372 "type": "string",
1373 "description": "The user name of the event's trigger."
1374 },
1375 "participant": {
1376 "type": "object",
1377 "description": "Information about the invited participant.",
1378 "required": ["call_type", "device_ip"],
1379 "properties": {
1380 "call_type": {
1381 "type": "string",
1382 "description": "The type of call out. Use a value of h323 or sip."
1383 },
1384 "device_ip": {
1385 "type": "string",
1386 "description": "The user's device IP address."
1387 }
1388 },
1389 "additionalProperties": true
1390 }
1391 },
1392 "additionalProperties": false
1393 }
1394 },
1395 "additionalProperties": false
1396 }
1397 },
1398 "additionalProperties": false
1399 },
1400 "examples": {
1401 "json-example": {
1402 "summary": "JSON example",
1403 "value": "{\n \"event\": \"session.user_room_system_callout_rejected\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
1404 }
1405 }
1406 }
1407 }
1408 },
1409 "responses": {
1410 "200": {
1411 "content": {
1412 "application/json": {
1413 "schema": {
1414 "type": "object",
1415 "required": ["event", "event_ts", "payload"],
1416 "properties": {
1417 "event": {
1418 "type": "string",
1419 "description": "The name of the event."
1420 },
1421 "event_ts": {
1422 "type": "integer",
1423 "format": "int64",
1424 "description": "A timestamp at which the event occurred."
1425 },
1426 "payload": {
1427 "type": "object",
1428 "required": ["account_id", "object"],
1429 "properties": {
1430 "account_id": {
1431 "type": "string",
1432 "description": "The account ID of the session host."
1433 },
1434 "object": {
1435 "type": "object",
1436 "description": "Information about the session.",
1437 "required": [
1438 "session_id",
1439 "session_name",
1440 "host_id",
1441 "message_id",
1442 "inviter_name",
1443 "participant"
1444 ],
1445 "properties": {
1446 "id": {
1447 "type": "integer",
1448 "format": "int64",
1449 "description": "The session ID.",
1450 "deprecated": true
1451 },
1452 "uuid": {
1453 "type": "string",
1454 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
1455 "deprecated": true
1456 },
1457 "session_id": {
1458 "type": "string",
1459 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1460 },
1461 "session_name": {
1462 "type": "string",
1463 "description": "Session name."
1464 },
1465 "host_id": {
1466 "type": "string",
1467 "description": "The user ID of the session host."
1468 },
1469 "message_id": {
1470 "type": "string",
1471 "description": "The request unique identifier (UUID)."
1472 },
1473 "inviter_name": {
1474 "type": "string",
1475 "description": "The user name of the event's trigger."
1476 },
1477 "participant": {
1478 "type": "object",
1479 "description": "Information about the invited participant.",
1480 "required": ["call_type", "device_ip"],
1481 "properties": {
1482 "call_type": {
1483 "type": "string",
1484 "description": "The type of call out. Use a value of h323 or sip."
1485 },
1486 "device_ip": {
1487 "type": "string",
1488 "description": "The user's device IP address."
1489 }
1490 },
1491 "additionalProperties": true
1492 }
1493 },
1494 "additionalProperties": false
1495 }
1496 },
1497 "additionalProperties": false
1498 }
1499 },
1500 "additionalProperties": false
1501 },
1502 "examples": {
1503 "json-example": {
1504 "summary": "JSON example",
1505 "value": "{\n \"event\": \"session.user_room_system_callout_rejected\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
1506 }
1507 }
1508 }
1509 }
1510 }
1511 }
1512 }
1513 },
1514 "session.alert": {
1515 "post": {
1516 "tags": ["session"],
1517 "operationId": "session.alert",
1518 "requestBody": {
1519 "description": "# session.alert\n---\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\n\n**Event type**: `session.alert`\n",
1520 "content": {
1521 "application/json": {
1522 "schema": {
1523 "type": "object",
1524 "required": ["event", "event_ts", "payload"],
1525 "properties": {
1526 "event": {
1527 "type": "string",
1528 "enum": ["session.alert"],
1529 "description": "The event's name."
1530 },
1531 "event_ts": {
1532 "type": "integer",
1533 "format": "int64",
1534 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
1535 },
1536 "payload": {
1537 "type": "object",
1538 "required": ["account_id", "object"],
1539 "properties": {
1540 "account_id": {
1541 "type": "string",
1542 "description": "The Video SDK account ID."
1543 },
1544 "object": {
1545 "type": "object",
1546 "description": "Information about the session. This object only returns updated properties.",
1547 "required": [
1548 "id",
1549 "session_id",
1550 "session_name",
1551 "issues"
1552 ],
1553 "properties": {
1554 "id": {
1555 "type": "string",
1556 "description": "The session ID."
1557 },
1558 "session_id": {
1559 "type": "string",
1560 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1561 },
1562 "session_name": {
1563 "type": "string",
1564 "description": "Session name."
1565 },
1566 "session_key": {
1567 "type": "string",
1568 "description": "The Video SDK custom session ID."
1569 },
1570 "issues": {
1571 "type": "array",
1572 "items": {
1573 "type": "string",
1574 "enum": [
1575 "Unstable audio quality",
1576 "Unstable video quality",
1577 "Unstable screen share quality",
1578 "High CPU occupation",
1579 "Call Reconnection"
1580 ]
1581 },
1582 "description": "Issues that occurred during the session."
1583 }
1584 },
1585 "additionalProperties": false
1586 }
1587 },
1588 "additionalProperties": false
1589 }
1590 },
1591 "additionalProperties": false
1592 },
1593 "examples": {
1594 "json-example": {
1595 "summary": "JSON example",
1596 "value": "{\n \"event\": \"session.alert\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"issues\": \"Unstable audio quality\"\n }\n }\n}"
1597 }
1598 }
1599 }
1600 }
1601 },
1602 "responses": {
1603 "200": {
1604 "content": {
1605 "application/json": {
1606 "schema": {
1607 "type": "object",
1608 "required": ["event", "event_ts", "payload"],
1609 "properties": {
1610 "event": {
1611 "type": "string",
1612 "enum": ["session.alert"],
1613 "description": "The event's name."
1614 },
1615 "event_ts": {
1616 "type": "integer",
1617 "format": "int64",
1618 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
1619 },
1620 "payload": {
1621 "type": "object",
1622 "required": ["account_id", "object"],
1623 "properties": {
1624 "account_id": {
1625 "type": "string",
1626 "description": "The Video SDK account ID."
1627 },
1628 "object": {
1629 "type": "object",
1630 "description": "Information about the session. This object only returns updated properties.",
1631 "required": [
1632 "id",
1633 "session_id",
1634 "session_name",
1635 "issues"
1636 ],
1637 "properties": {
1638 "id": {
1639 "type": "string",
1640 "description": "The session ID."
1641 },
1642 "session_id": {
1643 "type": "string",
1644 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1645 },
1646 "session_name": {
1647 "type": "string",
1648 "description": "Session name."
1649 },
1650 "session_key": {
1651 "type": "string",
1652 "description": "The Video SDK custom session ID."
1653 },
1654 "issues": {
1655 "type": "array",
1656 "items": {
1657 "type": "string",
1658 "enum": [
1659 "Unstable audio quality",
1660 "Unstable video quality",
1661 "Unstable screen share quality",
1662 "High CPU occupation",
1663 "Call Reconnection"
1664 ]
1665 },
1666 "description": "Issues that occurred during the session."
1667 }
1668 },
1669 "additionalProperties": false
1670 }
1671 },
1672 "additionalProperties": false
1673 }
1674 },
1675 "additionalProperties": false
1676 },
1677 "examples": {
1678 "json-example": {
1679 "summary": "JSON example",
1680 "value": "{\n \"event\": \"session.alert\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"issues\": \"Unstable audio quality\"\n }\n }\n}"
1681 }
1682 }
1683 }
1684 }
1685 }
1686 }
1687 }
1688 },
1689 "session.sharing_ended": {
1690 "post": {
1691 "tags": ["session"],
1692 "operationId": "session.sharing_ended",
1693 "requestBody": {
1694 "description": "# session.sharing_ended\n---\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\n\n**Event type**: `session.sharing_ended`\n",
1695 "content": {
1696 "application/json": {
1697 "schema": {
1698 "type": "object",
1699 "required": ["event", "event_ts", "payload"],
1700 "properties": {
1701 "event": {
1702 "type": "string",
1703 "enum": ["session.sharing_ended"],
1704 "description": "The event's name."
1705 },
1706 "event_ts": {
1707 "type": "integer",
1708 "format": "int64",
1709 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
1710 },
1711 "payload": {
1712 "type": "object",
1713 "required": ["account_id", "object"],
1714 "properties": {
1715 "account_id": {
1716 "type": "string",
1717 "description": "The Video SDK account ID."
1718 },
1719 "object": {
1720 "type": "object",
1721 "description": "Information about the session. This object only returns updated properties.",
1722 "required": [
1723 "id",
1724 "session_id",
1725 "session_name",
1726 "user"
1727 ],
1728 "properties": {
1729 "id": {
1730 "type": "string",
1731 "description": "The session ID.",
1732 "deprecated": true
1733 },
1734 "session_id": {
1735 "type": "string",
1736 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1737 },
1738 "session_name": {
1739 "type": "string",
1740 "description": "Session name."
1741 },
1742 "session_key": {
1743 "type": "string",
1744 "description": "The Video SDK custom session ID."
1745 },
1746 "user": {
1747 "type": "object",
1748 "description": "Information about the user.",
1749 "required": ["id", "name", "sharing_details"],
1750 "properties": {
1751 "id": {
1752 "type": "string",
1753 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
1754 },
1755 "name": {
1756 "type": "string",
1757 "description": "The user's username."
1758 },
1759 "user_key": {
1760 "type": "string",
1761 "description": "Another identifier for the user. Can be a number or characters."
1762 },
1763 "sharing_details": {
1764 "type": "object",
1765 "description": "Information about the session's screen sharing.",
1766 "required": ["content", "date_time"],
1767 "properties": {
1768 "content": {
1769 "type": "string",
1770 "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.",
1771 "enum": [
1772 "application",
1773 "whiteboard",
1774 "desktop",
1775 "unknown"
1776 ]
1777 },
1778 "date_time": {
1779 "type": "string",
1780 "format": "date-time",
1781 "description": "The session's screen sharing date and time."
1782 }
1783 },
1784 "additionalProperties": false
1785 }
1786 },
1787 "additionalProperties": false
1788 }
1789 },
1790 "additionalProperties": false
1791 }
1792 },
1793 "additionalProperties": false
1794 }
1795 },
1796 "additionalProperties": false
1797 },
1798 "examples": {
1799 "json-example": {
1800 "summary": "JSON example",
1801 "value": "{\n \"event\": \"session.sharing_ended\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"username\",\n \"user_key\": \"ASD74dfDI854\",\n \"sharing_details\": {\n \"content\": \"application\",\n \"date_time\": \"2021-07-16T17:19:11Z\"\n }\n }\n },\n \"account_id\": \"EFgHiJABC000DEfGHI\"\n }\n}"
1802 }
1803 }
1804 }
1805 }
1806 },
1807 "responses": {
1808 "200": {
1809 "content": {
1810 "application/json": {
1811 "schema": {
1812 "type": "object",
1813 "required": ["event", "event_ts", "payload"],
1814 "properties": {
1815 "event": {
1816 "type": "string",
1817 "enum": ["session.sharing_ended"],
1818 "description": "The event's name."
1819 },
1820 "event_ts": {
1821 "type": "integer",
1822 "format": "int64",
1823 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
1824 },
1825 "payload": {
1826 "type": "object",
1827 "required": ["account_id", "object"],
1828 "properties": {
1829 "account_id": {
1830 "type": "string",
1831 "description": "The Video SDK account ID."
1832 },
1833 "object": {
1834 "type": "object",
1835 "description": "Information about the session. This object only returns updated properties.",
1836 "required": [
1837 "id",
1838 "session_id",
1839 "session_name",
1840 "user"
1841 ],
1842 "properties": {
1843 "id": {
1844 "type": "string",
1845 "description": "The session ID.",
1846 "deprecated": true
1847 },
1848 "session_id": {
1849 "type": "string",
1850 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1851 },
1852 "session_name": {
1853 "type": "string",
1854 "description": "Session name."
1855 },
1856 "session_key": {
1857 "type": "string",
1858 "description": "The Video SDK custom session ID."
1859 },
1860 "user": {
1861 "type": "object",
1862 "description": "Information about the user.",
1863 "required": ["id", "name", "sharing_details"],
1864 "properties": {
1865 "id": {
1866 "type": "string",
1867 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
1868 },
1869 "name": {
1870 "type": "string",
1871 "description": "The user's username."
1872 },
1873 "user_key": {
1874 "type": "string",
1875 "description": "Another identifier for the user. Can be a number or characters."
1876 },
1877 "sharing_details": {
1878 "type": "object",
1879 "description": "Information about the session's screen sharing.",
1880 "required": ["content", "date_time"],
1881 "properties": {
1882 "content": {
1883 "type": "string",
1884 "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.",
1885 "enum": [
1886 "application",
1887 "whiteboard",
1888 "desktop",
1889 "unknown"
1890 ]
1891 },
1892 "date_time": {
1893 "type": "string",
1894 "format": "date-time",
1895 "description": "The session's screen sharing date and time."
1896 }
1897 },
1898 "additionalProperties": false
1899 }
1900 },
1901 "additionalProperties": false
1902 }
1903 },
1904 "additionalProperties": false
1905 }
1906 },
1907 "additionalProperties": false
1908 }
1909 },
1910 "additionalProperties": false
1911 },
1912 "examples": {
1913 "json-example": {
1914 "summary": "JSON example",
1915 "value": "{\n \"event\": \"session.sharing_ended\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"username\",\n \"user_key\": \"ASD74dfDI854\",\n \"sharing_details\": {\n \"content\": \"application\",\n \"date_time\": \"2021-07-16T17:19:11Z\"\n }\n }\n },\n \"account_id\": \"EFgHiJABC000DEfGHI\"\n }\n}"
1916 }
1917 }
1918 }
1919 }
1920 }
1921 }
1922 }
1923 },
1924 "session.recording_paused": {
1925 "post": {
1926 "tags": ["session"],
1927 "operationId": "session.recording_paused",
1928 "requestBody": {
1929 "description": "# session.recording_paused\n---\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\n\n**Event type**: `session.recording_paused`\n",
1930 "content": {
1931 "application/json": {
1932 "schema": {
1933 "type": "object",
1934 "required": ["event", "event_ts", "payload"],
1935 "properties": {
1936 "event": {
1937 "type": "string",
1938 "enum": ["session.recording_paused"],
1939 "description": "The event's name."
1940 },
1941 "event_ts": {
1942 "type": "integer",
1943 "format": "int64",
1944 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
1945 },
1946 "payload": {
1947 "type": "object",
1948 "required": ["account_id", "object"],
1949 "properties": {
1950 "account_id": {
1951 "type": "string",
1952 "description": "The Video SDK account ID."
1953 },
1954 "object": {
1955 "type": "object",
1956 "description": "Information about the session. This object only returns updated properties.",
1957 "required": [
1958 "session_id",
1959 "session_name",
1960 "session_key",
1961 "start_time",
1962 "timezone",
1963 "recording_file"
1964 ],
1965 "properties": {
1966 "session_id": {
1967 "type": "string",
1968 "description": "Unique session identifier. Each instance of the session will have its own session_id."
1969 },
1970 "session_name": {
1971 "type": "string",
1972 "description": "Session name."
1973 },
1974 "session_key": {
1975 "type": "string",
1976 "description": "The Video SDK custom session ID."
1977 },
1978 "start_time": {
1979 "type": "string",
1980 "format": "date-time",
1981 "description": "The time at which the session started."
1982 },
1983 "timezone": {
1984 "type": "string",
1985 "description": "The user's timezone."
1986 },
1987 "recording_file": {
1988 "type": "object",
1989 "properties": {
1990 "recording_start": {
1991 "type": "string",
1992 "description": "The recording start time."
1993 },
1994 "recording_end": {
1995 "type": "string",
1996 "description": "The recording end time. Response in general query."
1997 }
1998 }
1999 }
2000 },
2001 "additionalProperties": false
2002 }
2003 },
2004 "additionalProperties": false
2005 }
2006 },
2007 "additionalProperties": false
2008 },
2009 "examples": {
2010 "json-example": {
2011 "summary": "JSON example",
2012 "value": "{\n \"event\": \"session.recording_paused\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
2013 }
2014 }
2015 }
2016 }
2017 },
2018 "responses": {
2019 "200": {
2020 "content": {
2021 "application/json": {
2022 "schema": {
2023 "type": "object",
2024 "required": ["event", "event_ts", "payload"],
2025 "properties": {
2026 "event": {
2027 "type": "string",
2028 "enum": ["session.recording_paused"],
2029 "description": "The event's name."
2030 },
2031 "event_ts": {
2032 "type": "integer",
2033 "format": "int64",
2034 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
2035 },
2036 "payload": {
2037 "type": "object",
2038 "required": ["account_id", "object"],
2039 "properties": {
2040 "account_id": {
2041 "type": "string",
2042 "description": "The Video SDK account ID."
2043 },
2044 "object": {
2045 "type": "object",
2046 "description": "Information about the session. This object only returns updated properties.",
2047 "required": [
2048 "session_id",
2049 "session_name",
2050 "session_key",
2051 "start_time",
2052 "timezone",
2053 "recording_file"
2054 ],
2055 "properties": {
2056 "session_id": {
2057 "type": "string",
2058 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2059 },
2060 "session_name": {
2061 "type": "string",
2062 "description": "Session name."
2063 },
2064 "session_key": {
2065 "type": "string",
2066 "description": "The Video SDK custom session ID."
2067 },
2068 "start_time": {
2069 "type": "string",
2070 "format": "date-time",
2071 "description": "The time at which the session started."
2072 },
2073 "timezone": {
2074 "type": "string",
2075 "description": "The user's timezone."
2076 },
2077 "recording_file": {
2078 "type": "object",
2079 "properties": {
2080 "recording_start": {
2081 "type": "string",
2082 "description": "The recording start time."
2083 },
2084 "recording_end": {
2085 "type": "string",
2086 "description": "The recording end time. Response in general query."
2087 }
2088 }
2089 }
2090 },
2091 "additionalProperties": false
2092 }
2093 },
2094 "additionalProperties": false
2095 }
2096 },
2097 "additionalProperties": false
2098 },
2099 "examples": {
2100 "json-example": {
2101 "summary": "JSON example",
2102 "value": "{\n \"event\": \"session.recording_paused\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
2103 }
2104 }
2105 }
2106 }
2107 }
2108 }
2109 }
2110 },
2111 "session.ended": {
2112 "post": {
2113 "tags": ["session"],
2114 "operationId": "session.ended",
2115 "requestBody": {
2116 "description": "# session.ended\n---\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\n\n**Event type**: `session.ended`\n",
2117 "content": {
2118 "application/json": {
2119 "schema": {
2120 "type": "object",
2121 "required": ["event", "event_ts", "payload"],
2122 "properties": {
2123 "event": {
2124 "type": "string",
2125 "enum": ["session.ended"],
2126 "description": "The name of the event."
2127 },
2128 "event_ts": {
2129 "type": "integer",
2130 "format": "int64",
2131 "description": "Timestamp at which the event occurred, in milliseconds since epoch. The value of this field is returned in long(int64) format."
2132 },
2133 "payload": {
2134 "type": "object",
2135 "required": ["account_id", "object"],
2136 "properties": {
2137 "account_id": {
2138 "type": "string",
2139 "description": "The Video SDK account ID."
2140 },
2141 "object": {
2142 "type": "object",
2143 "description": "Information about the session.",
2144 "required": [
2145 "id",
2146 "session_id",
2147 "session_name",
2148 "start_time",
2149 "end_time"
2150 ],
2151 "properties": {
2152 "id": {
2153 "type": "string",
2154 "description": "The session ID.",
2155 "deprecated": true
2156 },
2157 "session_id": {
2158 "type": "string",
2159 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2160 },
2161 "session_name": {
2162 "type": "string",
2163 "description": "Session name."
2164 },
2165 "session_key": {
2166 "type": "string",
2167 "description": "The Video SDK custom session ID."
2168 },
2169 "start_time": {
2170 "type": "string",
2171 "description": "The session's start time.",
2172 "format": "date-time"
2173 },
2174 "end_time": {
2175 "type": "string",
2176 "description": "The session's end time.",
2177 "format": "date-time"
2178 }
2179 },
2180 "additionalProperties": false
2181 }
2182 },
2183 "additionalProperties": false
2184 }
2185 },
2186 "additionalProperties": false
2187 },
2188 "examples": {
2189 "json-example": {
2190 "summary": "JSON example",
2191 "value": "{\n \"event\": \"session.ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:22:24Z\",\n \"end_time\": \"2021-08-02T13:22:24Z\"\n }\n }\n}"
2192 }
2193 }
2194 }
2195 }
2196 },
2197 "responses": {
2198 "200": {
2199 "content": {
2200 "application/json": {
2201 "schema": {
2202 "type": "object",
2203 "required": ["event", "event_ts", "payload"],
2204 "properties": {
2205 "event": {
2206 "type": "string",
2207 "enum": ["session.ended"],
2208 "description": "The name of the event."
2209 },
2210 "event_ts": {
2211 "type": "integer",
2212 "format": "int64",
2213 "description": "Timestamp at which the event occurred, in milliseconds since epoch. The value of this field is returned in long(int64) format."
2214 },
2215 "payload": {
2216 "type": "object",
2217 "required": ["account_id", "object"],
2218 "properties": {
2219 "account_id": {
2220 "type": "string",
2221 "description": "The Video SDK account ID."
2222 },
2223 "object": {
2224 "type": "object",
2225 "description": "Information about the session.",
2226 "required": [
2227 "id",
2228 "session_id",
2229 "session_name",
2230 "start_time",
2231 "end_time"
2232 ],
2233 "properties": {
2234 "id": {
2235 "type": "string",
2236 "description": "The session ID.",
2237 "deprecated": true
2238 },
2239 "session_id": {
2240 "type": "string",
2241 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2242 },
2243 "session_name": {
2244 "type": "string",
2245 "description": "Session name."
2246 },
2247 "session_key": {
2248 "type": "string",
2249 "description": "The Video SDK custom session ID."
2250 },
2251 "start_time": {
2252 "type": "string",
2253 "description": "The session's start time.",
2254 "format": "date-time"
2255 },
2256 "end_time": {
2257 "type": "string",
2258 "description": "The session's end time.",
2259 "format": "date-time"
2260 }
2261 },
2262 "additionalProperties": false
2263 }
2264 },
2265 "additionalProperties": false
2266 }
2267 },
2268 "additionalProperties": false
2269 },
2270 "examples": {
2271 "json-example": {
2272 "summary": "JSON example",
2273 "value": "{\n \"event\": \"session.ended\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:22:24Z\",\n \"end_time\": \"2021-08-02T13:22:24Z\"\n }\n }\n}"
2274 }
2275 }
2276 }
2277 }
2278 }
2279 }
2280 }
2281 },
2282 "session.started": {
2283 "post": {
2284 "tags": ["session"],
2285 "operationId": "session.started",
2286 "requestBody": {
2287 "description": "# session.started\n---\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\n\n**Event type**: `session.started`\n",
2288 "content": {
2289 "application/json": {
2290 "schema": {
2291 "type": "object",
2292 "required": ["event", "event_ts", "payload"],
2293 "properties": {
2294 "event": {
2295 "type": "string",
2296 "enum": ["session.started"],
2297 "description": "The name of the event."
2298 },
2299 "event_ts": {
2300 "type": "integer",
2301 "format": "int64",
2302 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
2303 },
2304 "payload": {
2305 "type": "object",
2306 "required": ["account_id", "object"],
2307 "properties": {
2308 "account_id": {
2309 "type": "string",
2310 "description": "The Video SDK account ID."
2311 },
2312 "object": {
2313 "type": "object",
2314 "description": "Information about the session.",
2315 "required": [
2316 "id",
2317 "session_id",
2318 "session_name",
2319 "start_time"
2320 ],
2321 "properties": {
2322 "id": {
2323 "type": "string",
2324 "description": "The session's ID.",
2325 "deprecated": true
2326 },
2327 "session_id": {
2328 "type": "string",
2329 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2330 },
2331 "session_name": {
2332 "type": "string",
2333 "description": "Session name."
2334 },
2335 "session_key": {
2336 "type": "string",
2337 "description": "The Video SDK custom session ID."
2338 },
2339 "start_time": {
2340 "type": "string",
2341 "description": "The session's start time.",
2342 "format": "date-time"
2343 }
2344 },
2345 "additionalProperties": false
2346 }
2347 },
2348 "additionalProperties": false
2349 }
2350 },
2351 "additionalProperties": false
2352 },
2353 "examples": {
2354 "json-example": {
2355 "summary": "JSON example",
2356 "value": "{\n \"event\": \"session.started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:22:24Z\"\n }\n }\n}"
2357 }
2358 }
2359 }
2360 }
2361 },
2362 "responses": {
2363 "200": {
2364 "content": {
2365 "application/json": {
2366 "schema": {
2367 "type": "object",
2368 "required": ["event", "event_ts", "payload"],
2369 "properties": {
2370 "event": {
2371 "type": "string",
2372 "enum": ["session.started"],
2373 "description": "The name of the event."
2374 },
2375 "event_ts": {
2376 "type": "integer",
2377 "format": "int64",
2378 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
2379 },
2380 "payload": {
2381 "type": "object",
2382 "required": ["account_id", "object"],
2383 "properties": {
2384 "account_id": {
2385 "type": "string",
2386 "description": "The Video SDK account ID."
2387 },
2388 "object": {
2389 "type": "object",
2390 "description": "Information about the session.",
2391 "required": [
2392 "id",
2393 "session_id",
2394 "session_name",
2395 "start_time"
2396 ],
2397 "properties": {
2398 "id": {
2399 "type": "string",
2400 "description": "The session's ID.",
2401 "deprecated": true
2402 },
2403 "session_id": {
2404 "type": "string",
2405 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2406 },
2407 "session_name": {
2408 "type": "string",
2409 "description": "Session name."
2410 },
2411 "session_key": {
2412 "type": "string",
2413 "description": "The Video SDK custom session ID."
2414 },
2415 "start_time": {
2416 "type": "string",
2417 "description": "The session's start time.",
2418 "format": "date-time"
2419 }
2420 },
2421 "additionalProperties": false
2422 }
2423 },
2424 "additionalProperties": false
2425 }
2426 },
2427 "additionalProperties": false
2428 },
2429 "examples": {
2430 "json-example": {
2431 "summary": "JSON example",
2432 "value": "{\n \"event\": \"session.started\",\n \"event_ts\": 1627906944384,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:22:24Z\"\n }\n }\n}"
2433 }
2434 }
2435 }
2436 }
2437 }
2438 }
2439 }
2440 },
2441 "session.stream_ingestion_unbind": {
2442 "post": {
2443 "tags": ["session"],
2444 "operationId": "session.stream_ingestion_unbind",
2445 "requestBody": {
2446 "description": "# session.stream_ingestion_unbind\nZoom 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\n\n**Event type**: `session.stream_ingestion_unbind`\n",
2447 "content": {
2448 "application/json": {
2449 "schema": {
2450 "type": "object",
2451 "required": ["event", "event_ts", "payload"],
2452 "properties": {
2453 "event": {
2454 "type": "string",
2455 "enum": ["session.stream_ingestion_unbind"],
2456 "description": "Event name."
2457 },
2458 "event_ts": {
2459 "type": "integer",
2460 "format": "int64",
2461 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."
2462 },
2463 "payload": {
2464 "type": "object",
2465 "required": ["account_id", "object"],
2466 "properties": {
2467 "account_id": {
2468 "type": "string",
2469 "description": "The Video SDK account ID."
2470 },
2471 "object": {
2472 "type": "object",
2473 "description": "Information about the session.",
2474 "required": [
2475 "session_id",
2476 "session_name",
2477 "stream_ingestion"
2478 ],
2479 "properties": {
2480 "session_id": {
2481 "type": "string",
2482 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2483 },
2484 "session_name": {
2485 "type": "string",
2486 "description": "Session name."
2487 },
2488 "session_key": {
2489 "type": "string",
2490 "description": "The Video SDK custom session ID."
2491 },
2492 "stream_ingestion": {
2493 "type": "object",
2494 "description": "Information about the stream ingestion.",
2495 "required": [
2496 "stream_id",
2497 "stream_name",
2498 "stream_key",
2499 "stream_url",
2500 "backup_stream_url"
2501 ],
2502 "properties": {
2503 "stream_id": {
2504 "type": "string",
2505 "description": "The stream ingestion ID."
2506 },
2507 "stream_name": {
2508 "type": "string",
2509 "description": "The stream ingestion name."
2510 },
2511 "stream_description": {
2512 "type": "string",
2513 "description": "The stream ingestion description."
2514 },
2515 "stream_key": {
2516 "type": "string",
2517 "description": "The stream ingestion key."
2518 },
2519 "stream_url": {
2520 "type": "string",
2521 "description": "The stream URL."
2522 },
2523 "backup_stream_url": {
2524 "type": "string",
2525 "description": "The backup stream URL."
2526 }
2527 }
2528 }
2529 },
2530 "additionalProperties": false
2531 }
2532 },
2533 "additionalProperties": false
2534 }
2535 },
2536 "additionalProperties": false
2537 },
2538 "examples": {
2539 "json-example": {
2540 "summary": "JSON example",
2541 "value": "{\n \"event\": \"session.stream_ingestion_unbind\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
2542 }
2543 }
2544 }
2545 }
2546 },
2547 "responses": {
2548 "200": {
2549 "content": {
2550 "application/json": {
2551 "schema": {
2552 "type": "object",
2553 "required": ["event", "event_ts", "payload"],
2554 "properties": {
2555 "event": {
2556 "type": "string",
2557 "enum": ["session.stream_ingestion_unbind"],
2558 "description": "Event name."
2559 },
2560 "event_ts": {
2561 "type": "integer",
2562 "format": "int64",
2563 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format."
2564 },
2565 "payload": {
2566 "type": "object",
2567 "required": ["account_id", "object"],
2568 "properties": {
2569 "account_id": {
2570 "type": "string",
2571 "description": "The Video SDK account ID."
2572 },
2573 "object": {
2574 "type": "object",
2575 "description": "Information about the session.",
2576 "required": [
2577 "session_id",
2578 "session_name",
2579 "stream_ingestion"
2580 ],
2581 "properties": {
2582 "session_id": {
2583 "type": "string",
2584 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2585 },
2586 "session_name": {
2587 "type": "string",
2588 "description": "Session name."
2589 },
2590 "session_key": {
2591 "type": "string",
2592 "description": "The Video SDK custom session ID."
2593 },
2594 "stream_ingestion": {
2595 "type": "object",
2596 "description": "Information about the stream ingestion.",
2597 "required": [
2598 "stream_id",
2599 "stream_name",
2600 "stream_key",
2601 "stream_url",
2602 "backup_stream_url"
2603 ],
2604 "properties": {
2605 "stream_id": {
2606 "type": "string",
2607 "description": "The stream ingestion ID."
2608 },
2609 "stream_name": {
2610 "type": "string",
2611 "description": "The stream ingestion name."
2612 },
2613 "stream_description": {
2614 "type": "string",
2615 "description": "The stream ingestion description."
2616 },
2617 "stream_key": {
2618 "type": "string",
2619 "description": "The stream ingestion key."
2620 },
2621 "stream_url": {
2622 "type": "string",
2623 "description": "The stream URL."
2624 },
2625 "backup_stream_url": {
2626 "type": "string",
2627 "description": "The backup stream URL."
2628 }
2629 }
2630 }
2631 },
2632 "additionalProperties": false
2633 }
2634 },
2635 "additionalProperties": false
2636 }
2637 },
2638 "additionalProperties": false
2639 },
2640 "examples": {
2641 "json-example": {
2642 "summary": "JSON example",
2643 "value": "{\n \"event\": \"session.stream_ingestion_unbind\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
2644 }
2645 }
2646 }
2647 }
2648 }
2649 }
2650 }
2651 },
2652 "session.live_streaming_started": {
2653 "post": {
2654 "tags": ["session"],
2655 "operationId": "session.live_streaming_started",
2656 "requestBody": {
2657 "description": "# session.live_streaming_started\n---\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\n\n**Event type**: `session.live_streaming_started`\n",
2658 "content": {
2659 "application/json": {
2660 "schema": {
2661 "type": "object",
2662 "required": ["event", "event_ts", "payload"],
2663 "properties": {
2664 "event": {
2665 "type": "string",
2666 "enum": ["session.live_streaming_started"],
2667 "description": "Name of the event."
2668 },
2669 "event_ts": {
2670 "type": "integer",
2671 "format": "int64",
2672 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
2673 },
2674 "payload": {
2675 "type": "object",
2676 "required": ["account_id", "object"],
2677 "properties": {
2678 "account_id": {
2679 "type": "string",
2680 "description": "The Video SDK account ID."
2681 },
2682 "object": {
2683 "type": "object",
2684 "description": "Information about the session.",
2685 "required": [
2686 "id",
2687 "session_id",
2688 "session_name",
2689 "start_time",
2690 "live_streaming"
2691 ],
2692 "properties": {
2693 "id": {
2694 "type": "string",
2695 "description": "The session ID.",
2696 "deprecated": true
2697 },
2698 "session_id": {
2699 "type": "string",
2700 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2701 },
2702 "session_name": {
2703 "type": "string",
2704 "description": "Session name."
2705 },
2706 "session_key": {
2707 "type": "string",
2708 "description": "The Video SDK custom session ID."
2709 },
2710 "start_time": {
2711 "type": "string",
2712 "description": "The session's start time.",
2713 "format": "date-time"
2714 },
2715 "live_streaming": {
2716 "type": "object",
2717 "description": "Information about the participant.",
2718 "required": [
2719 "service",
2720 "custom_live_streaming_settings",
2721 "date_time"
2722 ],
2723 "properties": {
2724 "service": {
2725 "type": "string",
2726 "description": "The name of the Live Streaming service.",
2727 "enum": [
2728 "Facebook",
2729 "Workplace_by_Facebook",
2730 "YouTube",
2731 "Custom_Live_Streaming_Service"
2732 ]
2733 },
2734 "custom_live_streaming_settings": {
2735 "type": "object",
2736 "description": "The live stream settings.",
2737 "required": [
2738 "stream_url",
2739 "stream_key",
2740 "page_url"
2741 ],
2742 "properties": {
2743 "stream_url": {
2744 "type": "string",
2745 "description": "The stream's URL."
2746 },
2747 "stream_key": {
2748 "type": "string",
2749 "description": "The stream's key."
2750 },
2751 "page_url": {
2752 "type": "string",
2753 "description": "The live stream's page URL."
2754 },
2755 "resolution": {
2756 "type": "string",
2757 "description": "The number of pixels in each dimension that the video camera can display."
2758 }
2759 }
2760 },
2761 "date_time": {
2762 "type": "string",
2763 "description": "The live stream's start time.",
2764 "format": "date-time"
2765 }
2766 }
2767 }
2768 },
2769 "additionalProperties": false
2770 }
2771 },
2772 "additionalProperties": false
2773 }
2774 },
2775 "additionalProperties": false
2776 },
2777 "examples": {
2778 "json-example": {
2779 "summary": "JSON example",
2780 "value": "{\n \"event\": \"session.live_streaming_started\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:03:32Z\",\n \"live_streaming\": {\n \"service\": \"Custom_Live_Streaming_Service\",\n \"custom_live_streaming_settings\": {\n \"stream_url\": \"https://example.com/livestream\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"page_url\": \"https://example.com/livestream/123\",\n\t\t \"resolution\": \"1080p\"\n },\n \"date_time\": \"2021-08-02T12:22:45Z\"\n }\n }\n }\n}"
2781 }
2782 }
2783 }
2784 }
2785 },
2786 "responses": {
2787 "200": {
2788 "content": {
2789 "application/json": {
2790 "schema": {
2791 "type": "object",
2792 "required": ["event", "event_ts", "payload"],
2793 "properties": {
2794 "event": {
2795 "type": "string",
2796 "enum": ["session.live_streaming_started"],
2797 "description": "Name of the event."
2798 },
2799 "event_ts": {
2800 "type": "integer",
2801 "format": "int64",
2802 "description": "Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format."
2803 },
2804 "payload": {
2805 "type": "object",
2806 "required": ["account_id", "object"],
2807 "properties": {
2808 "account_id": {
2809 "type": "string",
2810 "description": "The Video SDK account ID."
2811 },
2812 "object": {
2813 "type": "object",
2814 "description": "Information about the session.",
2815 "required": [
2816 "id",
2817 "session_id",
2818 "session_name",
2819 "start_time",
2820 "live_streaming"
2821 ],
2822 "properties": {
2823 "id": {
2824 "type": "string",
2825 "description": "The session ID.",
2826 "deprecated": true
2827 },
2828 "session_id": {
2829 "type": "string",
2830 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2831 },
2832 "session_name": {
2833 "type": "string",
2834 "description": "Session name."
2835 },
2836 "session_key": {
2837 "type": "string",
2838 "description": "The Video SDK custom session ID."
2839 },
2840 "start_time": {
2841 "type": "string",
2842 "description": "The session's start time.",
2843 "format": "date-time"
2844 },
2845 "live_streaming": {
2846 "type": "object",
2847 "description": "Information about the participant.",
2848 "required": [
2849 "service",
2850 "custom_live_streaming_settings",
2851 "date_time"
2852 ],
2853 "properties": {
2854 "service": {
2855 "type": "string",
2856 "description": "The name of the Live Streaming service.",
2857 "enum": [
2858 "Facebook",
2859 "Workplace_by_Facebook",
2860 "YouTube",
2861 "Custom_Live_Streaming_Service"
2862 ]
2863 },
2864 "custom_live_streaming_settings": {
2865 "type": "object",
2866 "description": "The live stream settings.",
2867 "required": [
2868 "stream_url",
2869 "stream_key",
2870 "page_url"
2871 ],
2872 "properties": {
2873 "stream_url": {
2874 "type": "string",
2875 "description": "The stream's URL."
2876 },
2877 "stream_key": {
2878 "type": "string",
2879 "description": "The stream's key."
2880 },
2881 "page_url": {
2882 "type": "string",
2883 "description": "The live stream's page URL."
2884 },
2885 "resolution": {
2886 "type": "string",
2887 "description": "The number of pixels in each dimension that the video camera can display."
2888 }
2889 }
2890 },
2891 "date_time": {
2892 "type": "string",
2893 "description": "The live stream's start time.",
2894 "format": "date-time"
2895 }
2896 }
2897 }
2898 },
2899 "additionalProperties": false
2900 }
2901 },
2902 "additionalProperties": false
2903 }
2904 },
2905 "additionalProperties": false
2906 },
2907 "examples": {
2908 "json-example": {
2909 "summary": "JSON example",
2910 "value": "{\n \"event\": \"session.live_streaming_started\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"id\": \"BrgGrWeZSwaXkLBTpvmmvg==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-08-02T12:03:32Z\",\n \"live_streaming\": {\n \"service\": \"Custom_Live_Streaming_Service\",\n \"custom_live_streaming_settings\": {\n \"stream_url\": \"https://example.com/livestream\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"page_url\": \"https://example.com/livestream/123\",\n\t\t \"resolution\": \"1080p\"\n },\n \"date_time\": \"2021-08-02T12:22:45Z\"\n }\n }\n }\n}"
2911 }
2912 }
2913 }
2914 }
2915 }
2916 }
2917 }
2918 },
2919 "session.user_room_system_callout_missed": {
2920 "post": {
2921 "tags": ["session"],
2922 "operationId": "session.user_room_system_callout_missed",
2923 "requestBody": {
2924 "description": "# session.user_room_system_callout_missed\n\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\n\n**Event type**: `session.user_room_system_callout_missed`\n",
2925 "content": {
2926 "application/json": {
2927 "schema": {
2928 "type": "object",
2929 "required": ["event", "event_ts", "payload"],
2930 "properties": {
2931 "event": {
2932 "type": "string",
2933 "description": "The name of the event."
2934 },
2935 "event_ts": {
2936 "type": "integer",
2937 "format": "int64",
2938 "description": "A timestamp at which the event occurred."
2939 },
2940 "payload": {
2941 "type": "object",
2942 "required": ["account_id", "object"],
2943 "properties": {
2944 "account_id": {
2945 "type": "string",
2946 "description": "The account ID of the session host."
2947 },
2948 "object": {
2949 "type": "object",
2950 "description": "Information about the session.",
2951 "required": [
2952 "session_id",
2953 "session_name",
2954 "host_id",
2955 "message_id",
2956 "inviter_name",
2957 "participant"
2958 ],
2959 "properties": {
2960 "id": {
2961 "type": "integer",
2962 "format": "int64",
2963 "description": "The session ID.",
2964 "deprecated": true
2965 },
2966 "uuid": {
2967 "type": "string",
2968 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
2969 "deprecated": true
2970 },
2971 "session_id": {
2972 "type": "string",
2973 "description": "Unique session identifier. Each instance of the session will have its own session_id."
2974 },
2975 "session_name": {
2976 "type": "string",
2977 "description": "Session name."
2978 },
2979 "host_id": {
2980 "type": "string",
2981 "description": "The user ID of the session host."
2982 },
2983 "message_id": {
2984 "type": "string",
2985 "description": "The request unique identifier (UUID)."
2986 },
2987 "inviter_name": {
2988 "type": "string",
2989 "description": "The user name of the event's trigger."
2990 },
2991 "participant": {
2992 "type": "object",
2993 "description": "Information about the invited participant.",
2994 "required": ["call_type", "device_ip"],
2995 "properties": {
2996 "call_type": {
2997 "type": "string",
2998 "description": "The type of call out. Use a value of h323 or sip."
2999 },
3000 "device_ip": {
3001 "type": "string",
3002 "description": "The user's device IP address."
3003 }
3004 },
3005 "additionalProperties": true
3006 }
3007 },
3008 "additionalProperties": false
3009 }
3010 },
3011 "additionalProperties": false
3012 }
3013 },
3014 "additionalProperties": false
3015 },
3016 "examples": {
3017 "json-example": {
3018 "summary": "JSON example",
3019 "value": "{\n \"event\": \"session.user_room_system_callout_missed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
3020 }
3021 }
3022 }
3023 }
3024 },
3025 "responses": {
3026 "200": {
3027 "content": {
3028 "application/json": {
3029 "schema": {
3030 "type": "object",
3031 "required": ["event", "event_ts", "payload"],
3032 "properties": {
3033 "event": {
3034 "type": "string",
3035 "description": "The name of the event."
3036 },
3037 "event_ts": {
3038 "type": "integer",
3039 "format": "int64",
3040 "description": "A timestamp at which the event occurred."
3041 },
3042 "payload": {
3043 "type": "object",
3044 "required": ["account_id", "object"],
3045 "properties": {
3046 "account_id": {
3047 "type": "string",
3048 "description": "The account ID of the session host."
3049 },
3050 "object": {
3051 "type": "object",
3052 "description": "Information about the session.",
3053 "required": [
3054 "session_id",
3055 "session_name",
3056 "host_id",
3057 "message_id",
3058 "inviter_name",
3059 "participant"
3060 ],
3061 "properties": {
3062 "id": {
3063 "type": "integer",
3064 "format": "int64",
3065 "description": "The session ID.",
3066 "deprecated": true
3067 },
3068 "uuid": {
3069 "type": "string",
3070 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
3071 "deprecated": true
3072 },
3073 "session_id": {
3074 "type": "string",
3075 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3076 },
3077 "session_name": {
3078 "type": "string",
3079 "description": "Session name."
3080 },
3081 "host_id": {
3082 "type": "string",
3083 "description": "The user ID of the session host."
3084 },
3085 "message_id": {
3086 "type": "string",
3087 "description": "The request unique identifier (UUID)."
3088 },
3089 "inviter_name": {
3090 "type": "string",
3091 "description": "The user name of the event's trigger."
3092 },
3093 "participant": {
3094 "type": "object",
3095 "description": "Information about the invited participant.",
3096 "required": ["call_type", "device_ip"],
3097 "properties": {
3098 "call_type": {
3099 "type": "string",
3100 "description": "The type of call out. Use a value of h323 or sip."
3101 },
3102 "device_ip": {
3103 "type": "string",
3104 "description": "The user's device IP address."
3105 }
3106 },
3107 "additionalProperties": true
3108 }
3109 },
3110 "additionalProperties": false
3111 }
3112 },
3113 "additionalProperties": false
3114 }
3115 },
3116 "additionalProperties": false
3117 },
3118 "examples": {
3119 "json-example": {
3120 "summary": "JSON example",
3121 "value": "{\n \"event\": \"session.user_room_system_callout_missed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
3122 }
3123 }
3124 }
3125 }
3126 }
3127 }
3128 }
3129 },
3130 "session.user_phone_callout_accepted": {
3131 "post": {
3132 "tags": ["session"],
3133 "operationId": "session.user_phone_callout_accepted",
3134 "requestBody": {
3135 "description": "# session.user_phone_callout_accepted\n\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\n\n**Event type**: `session.user_phone_callout_accepted`\n",
3136 "content": {
3137 "application/json": {
3138 "schema": {
3139 "type": "object",
3140 "required": ["event", "event_ts", "payload"],
3141 "properties": {
3142 "event": {
3143 "type": "string",
3144 "description": "The name of the event."
3145 },
3146 "event_ts": {
3147 "type": "integer",
3148 "format": "int64",
3149 "description": "A timestamp at which the event occurred."
3150 },
3151 "payload": {
3152 "type": "object",
3153 "required": ["account_id", "object"],
3154 "properties": {
3155 "account_id": {
3156 "type": "string",
3157 "description": "The account ID of the session host."
3158 },
3159 "object": {
3160 "type": "object",
3161 "description": "Information about the session.",
3162 "required": [
3163 "session_id",
3164 "session_name",
3165 "session_key",
3166 "user_key",
3167 "host_id",
3168 "participant"
3169 ],
3170 "properties": {
3171 "id": {
3172 "type": "integer",
3173 "format": "int64",
3174 "description": "The session ID.",
3175 "deprecated": true
3176 },
3177 "uuid": {
3178 "type": "string",
3179 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
3180 "deprecated": true
3181 },
3182 "session_id": {
3183 "type": "string",
3184 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3185 },
3186 "session_name": {
3187 "type": "string",
3188 "description": "Session name."
3189 },
3190 "session_key": {
3191 "type": "string",
3192 "description": "The Video SDK custom session ID."
3193 },
3194 "user_key": {
3195 "type": "string",
3196 "description": "Another identifier for the inviter. Can be a number or characters."
3197 },
3198 "host_id": {
3199 "type": "string",
3200 "description": "The user ID of the session host."
3201 },
3202 "participant": {
3203 "type": "object",
3204 "description": "Information about the invited participant.",
3205 "required": [
3206 "invitee_name",
3207 "phone_number",
3208 "from_number"
3209 ],
3210 "properties": {
3211 "invitee_name": {
3212 "type": "string",
3213 "description": "The user's name to display in the session."
3214 },
3215 "phone_number": {
3216 "type": "integer",
3217 "format": "int64",
3218 "description": "The user's phone number."
3219 },
3220 "from_number": {
3221 "type": "integer",
3222 "format": "int64",
3223 "description": "The number used to call out to the invited user."
3224 }
3225 },
3226 "additionalProperties": false
3227 }
3228 },
3229 "additionalProperties": false
3230 }
3231 },
3232 "additionalProperties": false
3233 }
3234 },
3235 "additionalProperties": false
3236 },
3237 "examples": {
3238 "json-example": {
3239 "summary": "JSON example",
3240 "value": "{\n \"event\": \"session.user_phone_callout_accepted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
3241 }
3242 }
3243 }
3244 }
3245 },
3246 "responses": {
3247 "200": {
3248 "content": {
3249 "application/json": {
3250 "schema": {
3251 "type": "object",
3252 "required": ["event", "event_ts", "payload"],
3253 "properties": {
3254 "event": {
3255 "type": "string",
3256 "description": "The name of the event."
3257 },
3258 "event_ts": {
3259 "type": "integer",
3260 "format": "int64",
3261 "description": "A timestamp at which the event occurred."
3262 },
3263 "payload": {
3264 "type": "object",
3265 "required": ["account_id", "object"],
3266 "properties": {
3267 "account_id": {
3268 "type": "string",
3269 "description": "The account ID of the session host."
3270 },
3271 "object": {
3272 "type": "object",
3273 "description": "Information about the session.",
3274 "required": [
3275 "session_id",
3276 "session_name",
3277 "session_key",
3278 "user_key",
3279 "host_id",
3280 "participant"
3281 ],
3282 "properties": {
3283 "id": {
3284 "type": "integer",
3285 "format": "int64",
3286 "description": "The session ID.",
3287 "deprecated": true
3288 },
3289 "uuid": {
3290 "type": "string",
3291 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
3292 "deprecated": true
3293 },
3294 "session_id": {
3295 "type": "string",
3296 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3297 },
3298 "session_name": {
3299 "type": "string",
3300 "description": "Session name."
3301 },
3302 "session_key": {
3303 "type": "string",
3304 "description": "The Video SDK custom session ID."
3305 },
3306 "user_key": {
3307 "type": "string",
3308 "description": "Another identifier for the inviter. Can be a number or characters."
3309 },
3310 "host_id": {
3311 "type": "string",
3312 "description": "The user ID of the session host."
3313 },
3314 "participant": {
3315 "type": "object",
3316 "description": "Information about the invited participant.",
3317 "required": [
3318 "invitee_name",
3319 "phone_number",
3320 "from_number"
3321 ],
3322 "properties": {
3323 "invitee_name": {
3324 "type": "string",
3325 "description": "The user's name to display in the session."
3326 },
3327 "phone_number": {
3328 "type": "integer",
3329 "format": "int64",
3330 "description": "The user's phone number."
3331 },
3332 "from_number": {
3333 "type": "integer",
3334 "format": "int64",
3335 "description": "The number used to call out to the invited user."
3336 }
3337 },
3338 "additionalProperties": false
3339 }
3340 },
3341 "additionalProperties": false
3342 }
3343 },
3344 "additionalProperties": false
3345 }
3346 },
3347 "additionalProperties": false
3348 },
3349 "examples": {
3350 "json-example": {
3351 "summary": "JSON example",
3352 "value": "{\n \"event\": \"session.user_phone_callout_accepted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
3353 }
3354 }
3355 }
3356 }
3357 }
3358 }
3359 }
3360 },
3361 "session.user_left": {
3362 "post": {
3363 "tags": ["session"],
3364 "operationId": "session.user_left",
3365 "requestBody": {
3366 "description": "# session.user_left\n\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\n\n**Event type**: `session.user_left`\n",
3367 "content": {
3368 "application/json": {
3369 "schema": {
3370 "type": "object",
3371 "required": ["event", "event_ts", "payload"],
3372 "properties": {
3373 "event": {
3374 "type": "string",
3375 "enum": ["session.user_left"],
3376 "description": "The event's name."
3377 },
3378 "event_ts": {
3379 "type": "integer",
3380 "format": "int64",
3381 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
3382 },
3383 "payload": {
3384 "type": "object",
3385 "required": ["account_id", "object"],
3386 "properties": {
3387 "account_id": {
3388 "type": "string",
3389 "description": "The Video SDK account ID."
3390 },
3391 "object": {
3392 "type": "object",
3393 "description": "Information about the session. This object only returns updated properties.",
3394 "required": [
3395 "id",
3396 "session_id",
3397 "session_name",
3398 "user"
3399 ],
3400 "properties": {
3401 "id": {
3402 "type": "string",
3403 "description": "The session ID."
3404 },
3405 "session_id": {
3406 "type": "string",
3407 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3408 },
3409 "session_name": {
3410 "type": "string",
3411 "description": "Session name."
3412 },
3413 "session_key": {
3414 "type": "string",
3415 "description": "The Video SDK custom session ID."
3416 },
3417 "user": {
3418 "type": "object",
3419 "description": "Information about the user.",
3420 "required": [
3421 "id",
3422 "name",
3423 "leave_time",
3424 "participant_uuid"
3425 ],
3426 "properties": {
3427 "id": {
3428 "type": "string",
3429 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
3430 },
3431 "name": {
3432 "type": "string",
3433 "description": "The user's username."
3434 },
3435 "leave_time": {
3436 "type": "string",
3437 "description": "The time at which the user left the session.",
3438 "format": "date-time"
3439 },
3440 "leave_reason": {
3441 "type": "string",
3442 "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.",
3443 "x-enum": [
3444 "$name left the session.",
3445 "$name got disconnected from the session.",
3446 "Host ended the session.",
3447 "Host closed the session.",
3448 "Host started a new session.",
3449 "Network connection error.",
3450 "Host did not join.",
3451 "Exceeded free session minutes limit.",
3452 "Removed by host.",
3453 "Unknown reason.",
3454 "Leave waiting room.",
3455 "Removed by host from waiting room."
3456 ]
3457 },
3458 "user_key": {
3459 "type": "string",
3460 "description": "Another identifier for the user. Can be a number or characters."
3461 },
3462 "phone_number": {
3463 "type": "string",
3464 "description": "Phone number of participant joined via PSTN."
3465 },
3466 "participant_uuid": {
3467 "type": "string",
3468 "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."
3469 }
3470 },
3471 "additionalProperties": false
3472 }
3473 },
3474 "additionalProperties": false
3475 }
3476 },
3477 "additionalProperties": false
3478 }
3479 },
3480 "additionalProperties": false
3481 },
3482 "examples": {
3483 "json-example": {
3484 "summary": "JSON example",
3485 "value": "{\n \"event\": \"session.user_left\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"example\",\n \"leave_time\": \"2021-07-16T17:19:11Z\",\n \"leave_reason\": \"Jill Chill left the session.<br>Reason: Host ended the session.\",\n \"user_key\": \"ASD74dfDI854\",\n \"phone_number\": \"8615250064084\",\n \"participant_uuid\": \"55555AAAiAAAAAiAiAiiAii\"\n }\n }\n }\n}"
3486 }
3487 }
3488 }
3489 }
3490 },
3491 "responses": {
3492 "200": {
3493 "content": {
3494 "application/json": {
3495 "schema": {
3496 "type": "object",
3497 "required": ["event", "event_ts", "payload"],
3498 "properties": {
3499 "event": {
3500 "type": "string",
3501 "enum": ["session.user_left"],
3502 "description": "The event's name."
3503 },
3504 "event_ts": {
3505 "type": "integer",
3506 "format": "int64",
3507 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
3508 },
3509 "payload": {
3510 "type": "object",
3511 "required": ["account_id", "object"],
3512 "properties": {
3513 "account_id": {
3514 "type": "string",
3515 "description": "The Video SDK account ID."
3516 },
3517 "object": {
3518 "type": "object",
3519 "description": "Information about the session. This object only returns updated properties.",
3520 "required": [
3521 "id",
3522 "session_id",
3523 "session_name",
3524 "user"
3525 ],
3526 "properties": {
3527 "id": {
3528 "type": "string",
3529 "description": "The session ID."
3530 },
3531 "session_id": {
3532 "type": "string",
3533 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3534 },
3535 "session_name": {
3536 "type": "string",
3537 "description": "Session name."
3538 },
3539 "session_key": {
3540 "type": "string",
3541 "description": "The Video SDK custom session ID."
3542 },
3543 "user": {
3544 "type": "object",
3545 "description": "Information about the user.",
3546 "required": [
3547 "id",
3548 "name",
3549 "leave_time",
3550 "participant_uuid"
3551 ],
3552 "properties": {
3553 "id": {
3554 "type": "string",
3555 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
3556 },
3557 "name": {
3558 "type": "string",
3559 "description": "The user's username."
3560 },
3561 "leave_time": {
3562 "type": "string",
3563 "description": "The time at which the user left the session.",
3564 "format": "date-time"
3565 },
3566 "leave_reason": {
3567 "type": "string",
3568 "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.",
3569 "x-enum": [
3570 "$name left the session.",
3571 "$name got disconnected from the session.",
3572 "Host ended the session.",
3573 "Host closed the session.",
3574 "Host started a new session.",
3575 "Network connection error.",
3576 "Host did not join.",
3577 "Exceeded free session minutes limit.",
3578 "Removed by host.",
3579 "Unknown reason.",
3580 "Leave waiting room.",
3581 "Removed by host from waiting room."
3582 ]
3583 },
3584 "user_key": {
3585 "type": "string",
3586 "description": "Another identifier for the user. Can be a number or characters."
3587 },
3588 "phone_number": {
3589 "type": "string",
3590 "description": "Phone number of participant joined via PSTN."
3591 },
3592 "participant_uuid": {
3593 "type": "string",
3594 "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."
3595 }
3596 },
3597 "additionalProperties": false
3598 }
3599 },
3600 "additionalProperties": false
3601 }
3602 },
3603 "additionalProperties": false
3604 }
3605 },
3606 "additionalProperties": false
3607 },
3608 "examples": {
3609 "json-example": {
3610 "summary": "JSON example",
3611 "value": "{\n \"event\": \"session.user_left\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"example\",\n \"leave_time\": \"2021-07-16T17:19:11Z\",\n \"leave_reason\": \"Jill Chill left the session.<br>Reason: Host ended the session.\",\n \"user_key\": \"ASD74dfDI854\",\n \"phone_number\": \"8615250064084\",\n \"participant_uuid\": \"55555AAAiAAAAAiAiAiiAii\"\n }\n }\n }\n}"
3612 }
3613 }
3614 }
3615 }
3616 }
3617 }
3618 }
3619 },
3620 "session.sharing_started": {
3621 "post": {
3622 "tags": ["session"],
3623 "operationId": "session.sharing_started",
3624 "requestBody": {
3625 "description": "# session.sharing_started\n\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\n\n**Event type**: `session.sharing_started`\n",
3626 "content": {
3627 "application/json": {
3628 "schema": {
3629 "type": "object",
3630 "required": ["event", "event_ts", "payload"],
3631 "properties": {
3632 "event": {
3633 "type": "string",
3634 "enum": ["session.sharing_started"],
3635 "description": "The event's name."
3636 },
3637 "event_ts": {
3638 "type": "integer",
3639 "format": "int64",
3640 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
3641 },
3642 "payload": {
3643 "type": "object",
3644 "required": ["account_id", "object"],
3645 "properties": {
3646 "account_id": {
3647 "type": "string",
3648 "description": "The Video SDK account ID."
3649 },
3650 "object": {
3651 "type": "object",
3652 "description": "Information about the session. This object only returns updated properties.",
3653 "required": [
3654 "id",
3655 "session_id",
3656 "session_name",
3657 "user"
3658 ],
3659 "properties": {
3660 "id": {
3661 "type": "string",
3662 "description": "The session ID."
3663 },
3664 "session_id": {
3665 "type": "string",
3666 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3667 },
3668 "session_name": {
3669 "type": "string",
3670 "description": "Session name."
3671 },
3672 "session_key": {
3673 "type": "string",
3674 "description": "The Video SDK custom session ID."
3675 },
3676 "user": {
3677 "type": "object",
3678 "description": "Information about the user.",
3679 "required": ["id", "name", "sharing_details"],
3680 "properties": {
3681 "id": {
3682 "type": "string",
3683 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
3684 },
3685 "name": {
3686 "type": "string",
3687 "description": "The user's username."
3688 },
3689 "user_key": {
3690 "type": "string",
3691 "description": "Another identifier for the user. Can be a number or characters."
3692 },
3693 "sharing_details": {
3694 "type": "object",
3695 "description": "Information about the session's screen sharing.",
3696 "required": ["content", "date_time"],
3697 "properties": {
3698 "content": {
3699 "type": "string",
3700 "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.",
3701 "enum": [
3702 "application",
3703 "whiteboard",
3704 "desktop",
3705 "unknown"
3706 ]
3707 },
3708 "date_time": {
3709 "type": "string",
3710 "format": "date-time",
3711 "description": "The session's screen sharing date and time."
3712 }
3713 },
3714 "additionalProperties": false
3715 }
3716 },
3717 "additionalProperties": false
3718 }
3719 },
3720 "additionalProperties": false
3721 }
3722 },
3723 "additionalProperties": false
3724 }
3725 },
3726 "additionalProperties": false
3727 },
3728 "examples": {
3729 "json-example": {
3730 "summary": "JSON example",
3731 "value": "{\n \"event\": \"session.sharing_started\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"object\": {\n \"id\": \"4118UHIiRCAAAtBlDkcVyw==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"username\",\n \"user_key\": \"ASD74dfDI854\",\n \"sharing_details\": {\n \"date_time\": \"2019-07-16T17:19:11Z\",\n \"content\": \"application\"\n }\n }\n },\n \"account_id\": \"EPeQtiABC000VYxHMA\"\n }\n}"
3732 }
3733 }
3734 }
3735 }
3736 },
3737 "responses": {
3738 "200": {
3739 "content": {
3740 "application/json": {
3741 "schema": {
3742 "type": "object",
3743 "required": ["event", "event_ts", "payload"],
3744 "properties": {
3745 "event": {
3746 "type": "string",
3747 "enum": ["session.sharing_started"],
3748 "description": "The event's name."
3749 },
3750 "event_ts": {
3751 "type": "integer",
3752 "format": "int64",
3753 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
3754 },
3755 "payload": {
3756 "type": "object",
3757 "required": ["account_id", "object"],
3758 "properties": {
3759 "account_id": {
3760 "type": "string",
3761 "description": "The Video SDK account ID."
3762 },
3763 "object": {
3764 "type": "object",
3765 "description": "Information about the session. This object only returns updated properties.",
3766 "required": [
3767 "id",
3768 "session_id",
3769 "session_name",
3770 "user"
3771 ],
3772 "properties": {
3773 "id": {
3774 "type": "string",
3775 "description": "The session ID."
3776 },
3777 "session_id": {
3778 "type": "string",
3779 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3780 },
3781 "session_name": {
3782 "type": "string",
3783 "description": "Session name."
3784 },
3785 "session_key": {
3786 "type": "string",
3787 "description": "The Video SDK custom session ID."
3788 },
3789 "user": {
3790 "type": "object",
3791 "description": "Information about the user.",
3792 "required": ["id", "name", "sharing_details"],
3793 "properties": {
3794 "id": {
3795 "type": "string",
3796 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
3797 },
3798 "name": {
3799 "type": "string",
3800 "description": "The user's username."
3801 },
3802 "user_key": {
3803 "type": "string",
3804 "description": "Another identifier for the user. Can be a number or characters."
3805 },
3806 "sharing_details": {
3807 "type": "object",
3808 "description": "Information about the session's screen sharing.",
3809 "required": ["content", "date_time"],
3810 "properties": {
3811 "content": {
3812 "type": "string",
3813 "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.",
3814 "enum": [
3815 "application",
3816 "whiteboard",
3817 "desktop",
3818 "unknown"
3819 ]
3820 },
3821 "date_time": {
3822 "type": "string",
3823 "format": "date-time",
3824 "description": "The session's screen sharing date and time."
3825 }
3826 },
3827 "additionalProperties": false
3828 }
3829 },
3830 "additionalProperties": false
3831 }
3832 },
3833 "additionalProperties": false
3834 }
3835 },
3836 "additionalProperties": false
3837 }
3838 },
3839 "additionalProperties": false
3840 },
3841 "examples": {
3842 "json-example": {
3843 "summary": "JSON example",
3844 "value": "{\n \"event\": \"session.sharing_started\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"object\": {\n \"id\": \"4118UHIiRCAAAtBlDkcVyw==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"username\",\n \"user_key\": \"ASD74dfDI854\",\n \"sharing_details\": {\n \"date_time\": \"2019-07-16T17:19:11Z\",\n \"content\": \"application\"\n }\n }\n },\n \"account_id\": \"EPeQtiABC000VYxHMA\"\n }\n}"
3845 }
3846 }
3847 }
3848 }
3849 }
3850 }
3851 }
3852 },
3853 "session.user_phone_callout_canceled": {
3854 "post": {
3855 "tags": ["session"],
3856 "operationId": "session.user_phone_callout_canceled",
3857 "requestBody": {
3858 "description": "# session.user_phone_callout_canceled\nThe **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\n\n**Event type**: `session.user_phone_callout_canceled`\n",
3859 "content": {
3860 "application/json": {
3861 "schema": {
3862 "type": "object",
3863 "required": ["event", "event_ts", "payload"],
3864 "properties": {
3865 "event": {
3866 "type": "string",
3867 "description": "The name of the event."
3868 },
3869 "event_ts": {
3870 "type": "integer",
3871 "format": "int64",
3872 "description": "A timestamp at which the event occurred."
3873 },
3874 "payload": {
3875 "type": "object",
3876 "required": ["account_id", "object"],
3877 "properties": {
3878 "account_id": {
3879 "type": "string",
3880 "description": "The account ID of the session host."
3881 },
3882 "object": {
3883 "type": "object",
3884 "description": "Information about the session.",
3885 "required": [
3886 "session_id",
3887 "session_name",
3888 "session_key",
3889 "user_key",
3890 "participant"
3891 ],
3892 "properties": {
3893 "session_id": {
3894 "type": "string",
3895 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3896 },
3897 "session_name": {
3898 "type": "string",
3899 "description": "Session name."
3900 },
3901 "session_key": {
3902 "type": "string",
3903 "description": "The Video SDK custom session ID."
3904 },
3905 "user_key": {
3906 "type": "string",
3907 "description": "Another identifier for the inviter. Can be a number or characters."
3908 },
3909 "participant": {
3910 "type": "object",
3911 "description": "Information about the invited participant.",
3912 "required": [
3913 "invitee_name",
3914 "phone_number",
3915 "from_number"
3916 ],
3917 "properties": {
3918 "invitee_name": {
3919 "type": "string",
3920 "description": "The user's name to display in the session."
3921 },
3922 "phone_number": {
3923 "type": "integer",
3924 "format": "int64",
3925 "description": "The user's phone number."
3926 },
3927 "from_number": {
3928 "type": "integer",
3929 "format": "int64",
3930 "description": "The number used to call out to the invited user."
3931 }
3932 },
3933 "additionalProperties": false
3934 }
3935 },
3936 "additionalProperties": false
3937 }
3938 },
3939 "additionalProperties": false
3940 }
3941 },
3942 "additionalProperties": false
3943 },
3944 "examples": {
3945 "json-example": {
3946 "summary": "JSON example",
3947 "value": "{\n \"event\": \"session.user_phone_callout_canceled\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
3948 }
3949 }
3950 }
3951 }
3952 },
3953 "responses": {
3954 "200": {
3955 "content": {
3956 "application/json": {
3957 "schema": {
3958 "type": "object",
3959 "required": ["event", "event_ts", "payload"],
3960 "properties": {
3961 "event": {
3962 "type": "string",
3963 "description": "The name of the event."
3964 },
3965 "event_ts": {
3966 "type": "integer",
3967 "format": "int64",
3968 "description": "A timestamp at which the event occurred."
3969 },
3970 "payload": {
3971 "type": "object",
3972 "required": ["account_id", "object"],
3973 "properties": {
3974 "account_id": {
3975 "type": "string",
3976 "description": "The account ID of the session host."
3977 },
3978 "object": {
3979 "type": "object",
3980 "description": "Information about the session.",
3981 "required": [
3982 "session_id",
3983 "session_name",
3984 "session_key",
3985 "user_key",
3986 "participant"
3987 ],
3988 "properties": {
3989 "session_id": {
3990 "type": "string",
3991 "description": "Unique session identifier. Each instance of the session will have its own session_id."
3992 },
3993 "session_name": {
3994 "type": "string",
3995 "description": "Session name."
3996 },
3997 "session_key": {
3998 "type": "string",
3999 "description": "The Video SDK custom session ID."
4000 },
4001 "user_key": {
4002 "type": "string",
4003 "description": "Another identifier for the inviter. Can be a number or characters."
4004 },
4005 "participant": {
4006 "type": "object",
4007 "description": "Information about the invited participant.",
4008 "required": [
4009 "invitee_name",
4010 "phone_number",
4011 "from_number"
4012 ],
4013 "properties": {
4014 "invitee_name": {
4015 "type": "string",
4016 "description": "The user's name to display in the session."
4017 },
4018 "phone_number": {
4019 "type": "integer",
4020 "format": "int64",
4021 "description": "The user's phone number."
4022 },
4023 "from_number": {
4024 "type": "integer",
4025 "format": "int64",
4026 "description": "The number used to call out to the invited user."
4027 }
4028 },
4029 "additionalProperties": false
4030 }
4031 },
4032 "additionalProperties": false
4033 }
4034 },
4035 "additionalProperties": false
4036 }
4037 },
4038 "additionalProperties": false
4039 },
4040 "examples": {
4041 "json-example": {
4042 "summary": "JSON example",
4043 "value": "{\n \"event\": \"session.user_phone_callout_canceled\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
4044 }
4045 }
4046 }
4047 }
4048 }
4049 }
4050 }
4051 },
4052 "session.recording_transcript_completed": {
4053 "post": {
4054 "tags": ["session"],
4055 "operationId": "session.recording_transcript_completed",
4056 "requestBody": {
4057 "description": "# session.recording_transcript_completed\n---\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 [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 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:\n\n\n\n**Event type**: `session.recording_transcript_completed`\n",
4058 "content": {
4059 "application/json": {
4060 "schema": {
4061 "type": "object",
4062 "required": ["event", "event_ts", "download_token", "payload"],
4063 "properties": {
4064 "event": {
4065 "type": "string",
4066 "enum": ["session.recording_transcript_completed"],
4067 "description": "The event's name."
4068 },
4069 "event_ts": {
4070 "type": "integer",
4071 "format": "int64",
4072 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
4073 },
4074 "download_token": {
4075 "type": "string",
4076 "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"
4077 },
4078 "payload": {
4079 "type": "object",
4080 "required": ["account_id", "object"],
4081 "properties": {
4082 "account_id": {
4083 "type": "string",
4084 "description": "The Video SDK account ID."
4085 },
4086 "object": {
4087 "type": "object",
4088 "description": "Information about the session. This object only returns updated properties.",
4089 "required": [
4090 "session_id",
4091 "session_name",
4092 "session_key",
4093 "start_time",
4094 "timezone",
4095 "recording_files"
4096 ],
4097 "properties": {
4098 "session_id": {
4099 "type": "string",
4100 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4101 },
4102 "session_name": {
4103 "type": "string",
4104 "description": "Session name."
4105 },
4106 "session_key": {
4107 "type": "string",
4108 "description": "The Video SDK custom session ID."
4109 },
4110 "start_time": {
4111 "type": "string",
4112 "format": "date-time",
4113 "description": "The time at which the session started."
4114 },
4115 "timezone": {
4116 "type": "string",
4117 "description": "The user's timezone."
4118 },
4119 "recording_files": {
4120 "type": "array",
4121 "title": "Recording file List",
4122 "description": "List of recording file.",
4123 "items": {
4124 "type": "object",
4125 "properties": {
4126 "id": {
4127 "type": "string",
4128 "description": "The recording file ID. Included in the response of general query."
4129 },
4130 "recording_start": {
4131 "type": "string",
4132 "description": "The recording start time."
4133 },
4134 "recording_end": {
4135 "type": "string",
4136 "description": "The recording end time. Response in general query."
4137 },
4138 "file_name": {
4139 "type": "string",
4140 "description": "Name of the file."
4141 },
4142 "file_path": {
4143 "type": "string",
4144 "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."
4145 },
4146 "file_type": {
4147 "type": "string",
4148 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
4149 "enum": [
4150 "MP4",
4151 "M4A",
4152 "CHAT",
4153 "TRANSCRIPT",
4154 "CSV",
4155 "CC",
4156 "TB",
4157 "CHAT_MESSAGE",
4158 "TIMELINE"
4159 ]
4160 },
4161 "file_size": {
4162 "type": "number",
4163 "description": "The recording file size."
4164 },
4165 "file_extension": {
4166 "type": "string",
4167 "description": "The archived file's file extension.",
4168 "enum": [
4169 "MP4",
4170 "M4A",
4171 "TXT",
4172 "VTT",
4173 "CSV",
4174 "JSON",
4175 "JPG"
4176 ]
4177 },
4178 "download_url": {
4179 "type": "string",
4180 "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}."
4181 },
4182 "status": {
4183 "type": "string",
4184 "description": "The recording status.",
4185 "enum": ["completed"]
4186 },
4187 "recording_type": {
4188 "type": "string",
4189 "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",
4190 "enum": [
4191 "shared_screen_with_speaker_view(CC)",
4192 "shared_screen_with_speaker_view",
4193 "shared_screen_with_gallery_view",
4194 "gallery_view",
4195 "shared_screen",
4196 "audio_only",
4197 "audio_transcript",
4198 "chat_file",
4199 "active_speaker",
4200 "host_video",
4201 "audio_only_each_participant",
4202 "cc_transcript",
4203 "closed_caption",
4204 "poll",
4205 "timeline",
4206 "thumbnail",
4207 "chat_message"
4208 ]
4209 }
4210 }
4211 }
4212 }
4213 },
4214 "additionalProperties": false
4215 }
4216 },
4217 "additionalProperties": false
4218 }
4219 },
4220 "additionalProperties": false
4221 },
4222 "examples": {
4223 "json-example": {
4224 "summary": "JSON example",
4225 "value": "{\n \"event\": \"session.recording_transcript_completed\",\n \"event_ts\": 1626230691572,\n \"download_token\": \"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ\",\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"recording_type\": \"audio_only\",\n \"file_type\": \"TRANSCRIPT\",\n \"file_size\": 246560,\n \"file_extension\": \"M4A\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_transcript\"\n }\n ]\n }\n }\n}"
4226 }
4227 }
4228 }
4229 }
4230 },
4231 "responses": {
4232 "200": {
4233 "content": {
4234 "application/json": {
4235 "schema": {
4236 "type": "object",
4237 "required": [
4238 "event",
4239 "event_ts",
4240 "download_token",
4241 "payload"
4242 ],
4243 "properties": {
4244 "event": {
4245 "type": "string",
4246 "enum": ["session.recording_transcript_completed"],
4247 "description": "The event's name."
4248 },
4249 "event_ts": {
4250 "type": "integer",
4251 "format": "int64",
4252 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
4253 },
4254 "download_token": {
4255 "type": "string",
4256 "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"
4257 },
4258 "payload": {
4259 "type": "object",
4260 "required": ["account_id", "object"],
4261 "properties": {
4262 "account_id": {
4263 "type": "string",
4264 "description": "The Video SDK account ID."
4265 },
4266 "object": {
4267 "type": "object",
4268 "description": "Information about the session. This object only returns updated properties.",
4269 "required": [
4270 "session_id",
4271 "session_name",
4272 "session_key",
4273 "start_time",
4274 "timezone",
4275 "recording_files"
4276 ],
4277 "properties": {
4278 "session_id": {
4279 "type": "string",
4280 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4281 },
4282 "session_name": {
4283 "type": "string",
4284 "description": "Session name."
4285 },
4286 "session_key": {
4287 "type": "string",
4288 "description": "The Video SDK custom session ID."
4289 },
4290 "start_time": {
4291 "type": "string",
4292 "format": "date-time",
4293 "description": "The time at which the session started."
4294 },
4295 "timezone": {
4296 "type": "string",
4297 "description": "The user's timezone."
4298 },
4299 "recording_files": {
4300 "type": "array",
4301 "title": "Recording file List",
4302 "description": "List of recording file.",
4303 "items": {
4304 "type": "object",
4305 "properties": {
4306 "id": {
4307 "type": "string",
4308 "description": "The recording file ID. Included in the response of general query."
4309 },
4310 "recording_start": {
4311 "type": "string",
4312 "description": "The recording start time."
4313 },
4314 "recording_end": {
4315 "type": "string",
4316 "description": "The recording end time. Response in general query."
4317 },
4318 "file_name": {
4319 "type": "string",
4320 "description": "Name of the file."
4321 },
4322 "file_path": {
4323 "type": "string",
4324 "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."
4325 },
4326 "file_type": {
4327 "type": "string",
4328 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
4329 "enum": [
4330 "MP4",
4331 "M4A",
4332 "CHAT",
4333 "TRANSCRIPT",
4334 "CSV",
4335 "CC",
4336 "TB",
4337 "CHAT_MESSAGE",
4338 "TIMELINE"
4339 ]
4340 },
4341 "file_size": {
4342 "type": "number",
4343 "description": "The recording file size."
4344 },
4345 "file_extension": {
4346 "type": "string",
4347 "description": "The archived file's file extension.",
4348 "enum": [
4349 "MP4",
4350 "M4A",
4351 "TXT",
4352 "VTT",
4353 "CSV",
4354 "JSON",
4355 "JPG"
4356 ]
4357 },
4358 "download_url": {
4359 "type": "string",
4360 "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}."
4361 },
4362 "status": {
4363 "type": "string",
4364 "description": "The recording status.",
4365 "enum": ["completed"]
4366 },
4367 "recording_type": {
4368 "type": "string",
4369 "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",
4370 "enum": [
4371 "shared_screen_with_speaker_view(CC)",
4372 "shared_screen_with_speaker_view",
4373 "shared_screen_with_gallery_view",
4374 "gallery_view",
4375 "shared_screen",
4376 "audio_only",
4377 "audio_transcript",
4378 "chat_file",
4379 "active_speaker",
4380 "host_video",
4381 "audio_only_each_participant",
4382 "cc_transcript",
4383 "closed_caption",
4384 "poll",
4385 "timeline",
4386 "thumbnail",
4387 "chat_message"
4388 ]
4389 }
4390 }
4391 }
4392 }
4393 },
4394 "additionalProperties": false
4395 }
4396 },
4397 "additionalProperties": false
4398 }
4399 },
4400 "additionalProperties": false
4401 },
4402 "examples": {
4403 "json-example": {
4404 "summary": "JSON example",
4405 "value": "{\n \"event\": \"session.recording_transcript_completed\",\n \"event_ts\": 1626230691572,\n \"download_token\": \"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ\",\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"recording_type\": \"audio_only\",\n \"file_type\": \"TRANSCRIPT\",\n \"file_size\": 246560,\n \"file_extension\": \"M4A\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_transcript\"\n }\n ]\n }\n }\n}"
4406 }
4407 }
4408 }
4409 }
4410 }
4411 }
4412 }
4413 },
4414 "session.recording_deleted": {
4415 "post": {
4416 "tags": ["session"],
4417 "operationId": "session.recording_deleted",
4418 "requestBody": {
4419 "description": "# session.recording_deleted\n---\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\n\n**Event type**: `session.recording_deleted`\n",
4420 "content": {
4421 "application/json": {
4422 "schema": {
4423 "type": "object",
4424 "required": ["event", "event_ts", "payload"],
4425 "properties": {
4426 "event": {
4427 "type": "string",
4428 "enum": ["session.recording_deleted"],
4429 "description": "The event's name."
4430 },
4431 "event_ts": {
4432 "type": "integer",
4433 "format": "int64",
4434 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
4435 },
4436 "payload": {
4437 "type": "object",
4438 "required": [
4439 "account_id",
4440 "operator",
4441 "operator_id",
4442 "object"
4443 ],
4444 "properties": {
4445 "account_id": {
4446 "type": "string",
4447 "description": "The Video SDK account ID."
4448 },
4449 "operator": {
4450 "type": "string",
4451 "format": "email",
4452 "description": "The email address of the user who deleted the recording."
4453 },
4454 "operator_id": {
4455 "type": "string",
4456 "description": "The user ID of the user who deleted the recording."
4457 },
4458 "object": {
4459 "type": "object",
4460 "description": "Information about the session. This object only returns updated properties.",
4461 "required": [
4462 "session_id",
4463 "session_name",
4464 "session_key",
4465 "start_time",
4466 "timezone"
4467 ],
4468 "properties": {
4469 "session_id": {
4470 "type": "string",
4471 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4472 },
4473 "session_name": {
4474 "type": "string",
4475 "description": "Session name."
4476 },
4477 "session_key": {
4478 "type": "string",
4479 "description": "The Video SDK custom session ID."
4480 },
4481 "start_time": {
4482 "type": "string",
4483 "format": "date-time",
4484 "description": "The time at which the session started."
4485 },
4486 "timezone": {
4487 "type": "string",
4488 "description": "The user's timezone."
4489 }
4490 },
4491 "additionalProperties": false
4492 }
4493 },
4494 "additionalProperties": false
4495 }
4496 },
4497 "additionalProperties": false
4498 },
4499 "examples": {
4500 "json-example": {
4501 "summary": "JSON example",
4502 "value": "{\n \"event\": \"session.recording_deleted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
4503 }
4504 }
4505 }
4506 }
4507 },
4508 "responses": {
4509 "200": {
4510 "content": {
4511 "application/json": {
4512 "schema": {
4513 "type": "object",
4514 "required": ["event", "event_ts", "payload"],
4515 "properties": {
4516 "event": {
4517 "type": "string",
4518 "enum": ["session.recording_deleted"],
4519 "description": "The event's name."
4520 },
4521 "event_ts": {
4522 "type": "integer",
4523 "format": "int64",
4524 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
4525 },
4526 "payload": {
4527 "type": "object",
4528 "required": [
4529 "account_id",
4530 "operator",
4531 "operator_id",
4532 "object"
4533 ],
4534 "properties": {
4535 "account_id": {
4536 "type": "string",
4537 "description": "The Video SDK account ID."
4538 },
4539 "operator": {
4540 "type": "string",
4541 "format": "email",
4542 "description": "The email address of the user who deleted the recording."
4543 },
4544 "operator_id": {
4545 "type": "string",
4546 "description": "The user ID of the user who deleted the recording."
4547 },
4548 "object": {
4549 "type": "object",
4550 "description": "Information about the session. This object only returns updated properties.",
4551 "required": [
4552 "session_id",
4553 "session_name",
4554 "session_key",
4555 "start_time",
4556 "timezone"
4557 ],
4558 "properties": {
4559 "session_id": {
4560 "type": "string",
4561 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4562 },
4563 "session_name": {
4564 "type": "string",
4565 "description": "Session name."
4566 },
4567 "session_key": {
4568 "type": "string",
4569 "description": "The Video SDK custom session ID."
4570 },
4571 "start_time": {
4572 "type": "string",
4573 "format": "date-time",
4574 "description": "The time at which the session started."
4575 },
4576 "timezone": {
4577 "type": "string",
4578 "description": "The user's timezone."
4579 }
4580 },
4581 "additionalProperties": false
4582 }
4583 },
4584 "additionalProperties": false
4585 }
4586 },
4587 "additionalProperties": false
4588 },
4589 "examples": {
4590 "json-example": {
4591 "summary": "JSON example",
4592 "value": "{\n \"event\": \"session.recording_deleted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
4593 }
4594 }
4595 }
4596 }
4597 }
4598 }
4599 }
4600 },
4601 "session.user_room_system_callout_failed": {
4602 "post": {
4603 "tags": ["session"],
4604 "operationId": "session.user_room_system_callout_failed",
4605 "requestBody": {
4606 "description": "# session.user_room_system_callout_failed\n\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\n\n**Event type**: `session.user_room_system_callout_failed`\n",
4607 "content": {
4608 "application/json": {
4609 "schema": {
4610 "type": "object",
4611 "required": ["event", "event_ts", "payload"],
4612 "properties": {
4613 "event": {
4614 "type": "string",
4615 "description": "The name of the event."
4616 },
4617 "event_ts": {
4618 "type": "integer",
4619 "format": "int64",
4620 "description": "A timestamp at which the event occurred."
4621 },
4622 "payload": {
4623 "type": "object",
4624 "required": ["account_id", "object"],
4625 "properties": {
4626 "account_id": {
4627 "type": "string",
4628 "description": "The account ID of the session host."
4629 },
4630 "object": {
4631 "type": "object",
4632 "description": "Information about the session.",
4633 "required": [
4634 "session_id",
4635 "session_name",
4636 "host_id",
4637 "message_id",
4638 "inviter_name",
4639 "reason_type",
4640 "participant"
4641 ],
4642 "properties": {
4643 "id": {
4644 "type": "integer",
4645 "format": "int64",
4646 "description": "The session ID.",
4647 "deprecated": true
4648 },
4649 "uuid": {
4650 "type": "string",
4651 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
4652 "deprecated": true
4653 },
4654 "session_id": {
4655 "type": "string",
4656 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4657 },
4658 "session_name": {
4659 "type": "string",
4660 "description": "Session name."
4661 },
4662 "host_id": {
4663 "type": "string",
4664 "description": "The user ID of the session host."
4665 },
4666 "message_id": {
4667 "type": "string",
4668 "description": "The request unique identifier (UUID)."
4669 },
4670 "inviter_name": {
4671 "type": "string",
4672 "description": "The user name of the event's trigger."
4673 },
4674 "reason_type": {
4675 "type": "integer",
4676 "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.",
4677 "enum": [0, 1, 2, 3, 4, 7, 8, 9, 10, 11, 12, 13, 14]
4678 },
4679 "participant": {
4680 "type": "object",
4681 "description": "Information about the invited participant.",
4682 "required": ["call_type", "device_ip"],
4683 "properties": {
4684 "call_type": {
4685 "type": "string",
4686 "description": "The type of call out. Use a value of h323 or sip."
4687 },
4688 "device_ip": {
4689 "type": "string",
4690 "description": "The user's device IP address."
4691 }
4692 },
4693 "additionalProperties": true
4694 }
4695 },
4696 "additionalProperties": false
4697 }
4698 },
4699 "additionalProperties": false
4700 }
4701 },
4702 "additionalProperties": false
4703 },
4704 "examples": {
4705 "json-example": {
4706 "summary": "JSON example",
4707 "value": "{\n \"event\": \"session.user_room_system_callout_failed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"reason_type\": 1,\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
4708 }
4709 }
4710 }
4711 }
4712 },
4713 "responses": {
4714 "200": {
4715 "content": {
4716 "application/json": {
4717 "schema": {
4718 "type": "object",
4719 "required": ["event", "event_ts", "payload"],
4720 "properties": {
4721 "event": {
4722 "type": "string",
4723 "description": "The name of the event."
4724 },
4725 "event_ts": {
4726 "type": "integer",
4727 "format": "int64",
4728 "description": "A timestamp at which the event occurred."
4729 },
4730 "payload": {
4731 "type": "object",
4732 "required": ["account_id", "object"],
4733 "properties": {
4734 "account_id": {
4735 "type": "string",
4736 "description": "The account ID of the session host."
4737 },
4738 "object": {
4739 "type": "object",
4740 "description": "Information about the session.",
4741 "required": [
4742 "session_id",
4743 "session_name",
4744 "host_id",
4745 "message_id",
4746 "inviter_name",
4747 "reason_type",
4748 "participant"
4749 ],
4750 "properties": {
4751 "id": {
4752 "type": "integer",
4753 "format": "int64",
4754 "description": "The session ID.",
4755 "deprecated": true
4756 },
4757 "uuid": {
4758 "type": "string",
4759 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
4760 "deprecated": true
4761 },
4762 "session_id": {
4763 "type": "string",
4764 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4765 },
4766 "session_name": {
4767 "type": "string",
4768 "description": "Session name."
4769 },
4770 "host_id": {
4771 "type": "string",
4772 "description": "The user ID of the session host."
4773 },
4774 "message_id": {
4775 "type": "string",
4776 "description": "The request unique identifier (UUID)."
4777 },
4778 "inviter_name": {
4779 "type": "string",
4780 "description": "The user name of the event's trigger."
4781 },
4782 "reason_type": {
4783 "type": "integer",
4784 "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.",
4785 "enum": [
4786 0, 1, 2, 3, 4, 7, 8, 9, 10, 11, 12, 13, 14
4787 ]
4788 },
4789 "participant": {
4790 "type": "object",
4791 "description": "Information about the invited participant.",
4792 "required": ["call_type", "device_ip"],
4793 "properties": {
4794 "call_type": {
4795 "type": "string",
4796 "description": "The type of call out. Use a value of h323 or sip."
4797 },
4798 "device_ip": {
4799 "type": "string",
4800 "description": "The user's device IP address."
4801 }
4802 },
4803 "additionalProperties": true
4804 }
4805 },
4806 "additionalProperties": false
4807 }
4808 },
4809 "additionalProperties": false
4810 }
4811 },
4812 "additionalProperties": false
4813 },
4814 "examples": {
4815 "json-example": {
4816 "summary": "JSON example",
4817 "value": "{\n \"event\": \"session.user_room_system_callout_failed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"reason_type\": 1,\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
4818 }
4819 }
4820 }
4821 }
4822 }
4823 }
4824 }
4825 },
4826 "session.recording_completed": {
4827 "post": {
4828 "tags": ["session"],
4829 "operationId": "session.recording_completed",
4830 "requestBody": {
4831 "description": "# session.recording_completed\n---\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:\n\n\n\n**Event type**: `session.recording_completed`\n",
4832 "content": {
4833 "application/json": {
4834 "schema": {
4835 "type": "object",
4836 "required": ["event", "event_ts", "download_token", "payload"],
4837 "properties": {
4838 "event": {
4839 "type": "string",
4840 "enum": ["session.recording_completed"],
4841 "description": "The event's name."
4842 },
4843 "event_ts": {
4844 "type": "integer",
4845 "format": "int64",
4846 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
4847 },
4848 "download_token": {
4849 "type": "string",
4850 "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"
4851 },
4852 "payload": {
4853 "type": "object",
4854 "required": ["account_id", "object"],
4855 "properties": {
4856 "account_id": {
4857 "type": "string",
4858 "description": "The Video SDK account ID."
4859 },
4860 "object": {
4861 "type": "object",
4862 "description": "Information about the session. This object only returns updated properties.",
4863 "required": [
4864 "session_id",
4865 "session_name",
4866 "session_key",
4867 "start_time",
4868 "timezone",
4869 "recording_files"
4870 ],
4871 "properties": {
4872 "session_id": {
4873 "type": "string",
4874 "description": "Unique session identifier. Each instance of the session will have its own session_id."
4875 },
4876 "session_name": {
4877 "type": "string",
4878 "description": "Session name."
4879 },
4880 "session_key": {
4881 "type": "string",
4882 "description": "The Video SDK custom session ID."
4883 },
4884 "start_time": {
4885 "type": "string",
4886 "format": "date-time",
4887 "description": "The time at which the session started."
4888 },
4889 "timezone": {
4890 "type": "string",
4891 "description": "The user's timezone."
4892 },
4893 "recording_files": {
4894 "type": "array",
4895 "title": "Recording file List",
4896 "description": "List of recording file.",
4897 "items": {
4898 "type": "object",
4899 "properties": {
4900 "id": {
4901 "type": "string",
4902 "description": "The recording file ID. Included in the response of general query."
4903 },
4904 "recording_start": {
4905 "type": "string",
4906 "description": "The recording start time."
4907 },
4908 "recording_end": {
4909 "type": "string",
4910 "description": "The recording end time. Response in general query."
4911 },
4912 "file_name": {
4913 "type": "string",
4914 "description": "Name of the file."
4915 },
4916 "file_path": {
4917 "type": "string",
4918 "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."
4919 },
4920 "file_type": {
4921 "type": "string",
4922 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
4923 "enum": [
4924 "MP4",
4925 "M4A",
4926 "CHAT",
4927 "TRANSCRIPT",
4928 "CSV",
4929 "CC",
4930 "TB",
4931 "CHAT_MESSAGE"
4932 ]
4933 },
4934 "file_size": {
4935 "type": "number",
4936 "description": "The recording file size."
4937 },
4938 "file_extension": {
4939 "type": "string",
4940 "description": "The archived file's file extension.",
4941 "enum": [
4942 "MP4",
4943 "M4A",
4944 "TXT",
4945 "VTT",
4946 "CSV",
4947 "JSON",
4948 "JPG"
4949 ]
4950 },
4951 "download_url": {
4952 "type": "string",
4953 "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). 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"
4954 },
4955 "status": {
4956 "type": "string",
4957 "description": "The recording status.",
4958 "enum": ["completed"]
4959 },
4960 "recording_type": {
4961 "type": "string",
4962 "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",
4963 "enum": [
4964 "shared_screen_with_speaker_view(CC)",
4965 "shared_screen_with_speaker_view",
4966 "shared_screen_with_gallery_view",
4967 "gallery_view",
4968 "shared_screen",
4969 "audio_only",
4970 "audio_transcript",
4971 "chat_file",
4972 "active_speaker",
4973 "host_video",
4974 "audio_only_each_participant",
4975 "cc_transcript",
4976 "closed_caption",
4977 "poll",
4978 "timeline",
4979 "thumbnail",
4980 "chat_message"
4981 ]
4982 }
4983 }
4984 }
4985 },
4986 "participant_audio_files": {
4987 "type": "array",
4988 "title": "Recording file List",
4989 "description": "List of recording file.",
4990 "items": {
4991 "type": "object",
4992 "properties": {
4993 "id": {
4994 "type": "string",
4995 "description": "The recording file ID. Included in the response of general query."
4996 },
4997 "recording_start": {
4998 "type": "string",
4999 "description": "The recording start time."
5000 },
5001 "recording_end": {
5002 "type": "string",
5003 "description": "The recording end time. Response in general query."
5004 },
5005 "file_name": {
5006 "type": "string",
5007 "description": "Name of the file."
5008 },
5009 "file_path": {
5010 "type": "string",
5011 "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."
5012 },
5013 "file_type": {
5014 "type": "string",
5015 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
5016 "enum": [
5017 "MP4",
5018 "M4A",
5019 "CHAT",
5020 "TRANSCRIPT",
5021 "CSV",
5022 "CC",
5023 "TB",
5024 "CHAT_MESSAGE"
5025 ]
5026 },
5027 "file_size": {
5028 "type": "number",
5029 "description": "The recording file size."
5030 },
5031 "file_extension": {
5032 "type": "string",
5033 "description": "The archived file's file extension.",
5034 "enum": [
5035 "MP4",
5036 "M4A",
5037 "TXT",
5038 "VTT",
5039 "CSV",
5040 "JSON",
5041 "JPG"
5042 ]
5043 },
5044 "download_url": {
5045 "type": "string",
5046 "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). 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"
5047 },
5048 "status": {
5049 "type": "string",
5050 "description": "The recording status.",
5051 "enum": ["completed"]
5052 },
5053 "recording_type": {
5054 "type": "string",
5055 "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",
5056 "enum": [
5057 "shared_screen_with_speaker_view(CC)",
5058 "shared_screen_with_speaker_view",
5059 "shared_screen_with_gallery_view",
5060 "gallery_view",
5061 "shared_screen",
5062 "audio_only",
5063 "audio_transcript",
5064 "chat_file",
5065 "active_speaker",
5066 "host_video",
5067 "audio_only_each_participant",
5068 "cc_transcript",
5069 "closed_caption",
5070 "poll",
5071 "timeline",
5072 "thumbnail",
5073 "chat_message"
5074 ]
5075 },
5076 "user_id": {
5077 "type": "string",
5078 "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."
5079 },
5080 "user_key": {
5081 "type": "string",
5082 "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."
5083 }
5084 }
5085 }
5086 },
5087 "participant_video_files": {
5088 "type": "array",
5089 "title": "Recording file List",
5090 "description": "List of recording file.",
5091 "items": {
5092 "type": "object",
5093 "properties": {
5094 "id": {
5095 "type": "string",
5096 "description": "The recording file ID. Included in the response of general query."
5097 },
5098 "recording_start": {
5099 "type": "string",
5100 "description": "The recording start time."
5101 },
5102 "recording_end": {
5103 "type": "string",
5104 "description": "The recording end time. Response in general query."
5105 },
5106 "file_name": {
5107 "type": "string",
5108 "description": "Name of the file."
5109 },
5110 "file_path": {
5111 "type": "string",
5112 "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."
5113 },
5114 "file_type": {
5115 "type": "string",
5116 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: Video file of the recording.",
5117 "enum": ["MP4"]
5118 },
5119 "file_size": {
5120 "type": "number",
5121 "description": "The recording file size."
5122 },
5123 "file_extension": {
5124 "type": "string",
5125 "description": "The archived file's file extension.",
5126 "enum": ["MP4"]
5127 },
5128 "download_url": {
5129 "type": "string",
5130 "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). 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"
5131 },
5132 "status": {
5133 "type": "string",
5134 "description": "The recording status.",
5135 "enum": ["completed"]
5136 },
5137 "recording_type": {
5138 "type": "string",
5139 "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",
5140 "enum": [
5141 "individual_user",
5142 "individual_shared_screen"
5143 ]
5144 },
5145 "user_id": {
5146 "type": "string",
5147 "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."
5148 },
5149 "user_key": {
5150 "type": "string",
5151 "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."
5152 }
5153 }
5154 }
5155 }
5156 },
5157 "additionalProperties": false
5158 }
5159 },
5160 "additionalProperties": false
5161 }
5162 },
5163 "additionalProperties": false
5164 },
5165 "examples": {
5166 "json-example": {
5167 "summary": "JSON example",
5168 "value": "{\n \"event\": \"session.recording_completed\",\n \"event_ts\": 1626230691572,\n \"download_token\": \"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ\",\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"recording_type\": \"audio_only\",\n \"file_type\": \"M4A\",\n \"file_size\": 246560,\n \"file_extension\": \"M4A\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\"\n }\n ],\n \"participant_audio_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"file_type\": \"M4A\",\n \"file_name\": \"MyRecording\",\n \"file_size\": 246560,\n \"file_extension\": \"MP4\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\",\n \"user_id\": \"16778240\",\n \"user_key\": \"key1\"\n }\n ],\n \"participant_video_files\": [\n {\n \"id\": \"0a564312-edf7-495e-b916-6873a7b32c50\",\n \"status\": \"completed\",\n \"recording_start\": \"2022-12-06T01:01:30Z\",\n \"recording_end\": \"2022-12-06T01:10:32Z\",\n \"file_type\": \"MP4\",\n \"file_size\": 1200500,\n \"download_url\": \"https://example.com/rec/download/cWfE3Ye3UUFgTxbBcii5t\",\n \"recording_type\": \"individual_shared_screen\",\n \"file_name\": \"Separated Share Video - user@example.com\",\n \"file_extension\": \"MP4\",\n \"user_id\": \"16778240\",\n \"user_key\": \"key1\"\n }\n ]\n }\n }\n}"
5169 }
5170 }
5171 }
5172 }
5173 },
5174 "responses": {
5175 "200": {
5176 "content": {
5177 "application/json": {
5178 "schema": {
5179 "type": "object",
5180 "required": [
5181 "event",
5182 "event_ts",
5183 "download_token",
5184 "payload"
5185 ],
5186 "properties": {
5187 "event": {
5188 "type": "string",
5189 "enum": ["session.recording_completed"],
5190 "description": "The event's name."
5191 },
5192 "event_ts": {
5193 "type": "integer",
5194 "format": "int64",
5195 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
5196 },
5197 "download_token": {
5198 "type": "string",
5199 "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"
5200 },
5201 "payload": {
5202 "type": "object",
5203 "required": ["account_id", "object"],
5204 "properties": {
5205 "account_id": {
5206 "type": "string",
5207 "description": "The Video SDK account ID."
5208 },
5209 "object": {
5210 "type": "object",
5211 "description": "Information about the session. This object only returns updated properties.",
5212 "required": [
5213 "session_id",
5214 "session_name",
5215 "session_key",
5216 "start_time",
5217 "timezone",
5218 "recording_files"
5219 ],
5220 "properties": {
5221 "session_id": {
5222 "type": "string",
5223 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5224 },
5225 "session_name": {
5226 "type": "string",
5227 "description": "Session name."
5228 },
5229 "session_key": {
5230 "type": "string",
5231 "description": "The Video SDK custom session ID."
5232 },
5233 "start_time": {
5234 "type": "string",
5235 "format": "date-time",
5236 "description": "The time at which the session started."
5237 },
5238 "timezone": {
5239 "type": "string",
5240 "description": "The user's timezone."
5241 },
5242 "recording_files": {
5243 "type": "array",
5244 "title": "Recording file List",
5245 "description": "List of recording file.",
5246 "items": {
5247 "type": "object",
5248 "properties": {
5249 "id": {
5250 "type": "string",
5251 "description": "The recording file ID. Included in the response of general query."
5252 },
5253 "recording_start": {
5254 "type": "string",
5255 "description": "The recording start time."
5256 },
5257 "recording_end": {
5258 "type": "string",
5259 "description": "The recording end time. Response in general query."
5260 },
5261 "file_name": {
5262 "type": "string",
5263 "description": "Name of the file."
5264 },
5265 "file_path": {
5266 "type": "string",
5267 "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."
5268 },
5269 "file_type": {
5270 "type": "string",
5271 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
5272 "enum": [
5273 "MP4",
5274 "M4A",
5275 "CHAT",
5276 "TRANSCRIPT",
5277 "CSV",
5278 "CC",
5279 "TB",
5280 "CHAT_MESSAGE"
5281 ]
5282 },
5283 "file_size": {
5284 "type": "number",
5285 "description": "The recording file size."
5286 },
5287 "file_extension": {
5288 "type": "string",
5289 "description": "The archived file's file extension.",
5290 "enum": [
5291 "MP4",
5292 "M4A",
5293 "TXT",
5294 "VTT",
5295 "CSV",
5296 "JSON",
5297 "JPG"
5298 ]
5299 },
5300 "download_url": {
5301 "type": "string",
5302 "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). 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"
5303 },
5304 "status": {
5305 "type": "string",
5306 "description": "The recording status.",
5307 "enum": ["completed"]
5308 },
5309 "recording_type": {
5310 "type": "string",
5311 "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",
5312 "enum": [
5313 "shared_screen_with_speaker_view(CC)",
5314 "shared_screen_with_speaker_view",
5315 "shared_screen_with_gallery_view",
5316 "gallery_view",
5317 "shared_screen",
5318 "audio_only",
5319 "audio_transcript",
5320 "chat_file",
5321 "active_speaker",
5322 "host_video",
5323 "audio_only_each_participant",
5324 "cc_transcript",
5325 "closed_caption",
5326 "poll",
5327 "timeline",
5328 "thumbnail",
5329 "chat_message"
5330 ]
5331 }
5332 }
5333 }
5334 },
5335 "participant_audio_files": {
5336 "type": "array",
5337 "title": "Recording file List",
5338 "description": "List of recording file.",
5339 "items": {
5340 "type": "object",
5341 "properties": {
5342 "id": {
5343 "type": "string",
5344 "description": "The recording file ID. Included in the response of general query."
5345 },
5346 "recording_start": {
5347 "type": "string",
5348 "description": "The recording start time."
5349 },
5350 "recording_end": {
5351 "type": "string",
5352 "description": "The recording end time. Response in general query."
5353 },
5354 "file_name": {
5355 "type": "string",
5356 "description": "Name of the file."
5357 },
5358 "file_path": {
5359 "type": "string",
5360 "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."
5361 },
5362 "file_type": {
5363 "type": "string",
5364 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: 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\tid, status, file_size, recording_type.",
5365 "enum": [
5366 "MP4",
5367 "M4A",
5368 "CHAT",
5369 "TRANSCRIPT",
5370 "CSV",
5371 "CC",
5372 "TB",
5373 "CHAT_MESSAGE"
5374 ]
5375 },
5376 "file_size": {
5377 "type": "number",
5378 "description": "The recording file size."
5379 },
5380 "file_extension": {
5381 "type": "string",
5382 "description": "The archived file's file extension.",
5383 "enum": [
5384 "MP4",
5385 "M4A",
5386 "TXT",
5387 "VTT",
5388 "CSV",
5389 "JSON",
5390 "JPG"
5391 ]
5392 },
5393 "download_url": {
5394 "type": "string",
5395 "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). 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"
5396 },
5397 "status": {
5398 "type": "string",
5399 "description": "The recording status.",
5400 "enum": ["completed"]
5401 },
5402 "recording_type": {
5403 "type": "string",
5404 "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",
5405 "enum": [
5406 "shared_screen_with_speaker_view(CC)",
5407 "shared_screen_with_speaker_view",
5408 "shared_screen_with_gallery_view",
5409 "gallery_view",
5410 "shared_screen",
5411 "audio_only",
5412 "audio_transcript",
5413 "chat_file",
5414 "active_speaker",
5415 "host_video",
5416 "audio_only_each_participant",
5417 "cc_transcript",
5418 "closed_caption",
5419 "poll",
5420 "timeline",
5421 "thumbnail",
5422 "chat_message"
5423 ]
5424 },
5425 "user_id": {
5426 "type": "string",
5427 "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."
5428 },
5429 "user_key": {
5430 "type": "string",
5431 "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."
5432 }
5433 }
5434 }
5435 },
5436 "participant_video_files": {
5437 "type": "array",
5438 "title": "Recording file List",
5439 "description": "List of recording file.",
5440 "items": {
5441 "type": "object",
5442 "properties": {
5443 "id": {
5444 "type": "string",
5445 "description": "The recording file ID. Included in the response of general query."
5446 },
5447 "recording_start": {
5448 "type": "string",
5449 "description": "The recording start time."
5450 },
5451 "recording_end": {
5452 "type": "string",
5453 "description": "The recording end time. Response in general query."
5454 },
5455 "file_name": {
5456 "type": "string",
5457 "description": "Name of the file."
5458 },
5459 "file_path": {
5460 "type": "string",
5461 "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."
5462 },
5463 "file_type": {
5464 "type": "string",
5465 "description": "The recording file type. The value of this field could be one of the following:<br>\nMP4: Video file of the recording.",
5466 "enum": ["MP4"]
5467 },
5468 "file_size": {
5469 "type": "number",
5470 "description": "The recording file size."
5471 },
5472 "file_extension": {
5473 "type": "string",
5474 "description": "The archived file's file extension.",
5475 "enum": ["MP4"]
5476 },
5477 "download_url": {
5478 "type": "string",
5479 "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). 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"
5480 },
5481 "status": {
5482 "type": "string",
5483 "description": "The recording status.",
5484 "enum": ["completed"]
5485 },
5486 "recording_type": {
5487 "type": "string",
5488 "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",
5489 "enum": [
5490 "individual_user",
5491 "individual_shared_screen"
5492 ]
5493 },
5494 "user_id": {
5495 "type": "string",
5496 "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."
5497 },
5498 "user_key": {
5499 "type": "string",
5500 "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."
5501 }
5502 }
5503 }
5504 }
5505 },
5506 "additionalProperties": false
5507 }
5508 },
5509 "additionalProperties": false
5510 }
5511 },
5512 "additionalProperties": false
5513 },
5514 "examples": {
5515 "json-example": {
5516 "summary": "JSON example",
5517 "value": "{\n \"event\": \"session.recording_completed\",\n \"event_ts\": 1626230691572,\n \"download_token\": \"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ\",\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"recording_type\": \"audio_only\",\n \"file_type\": \"M4A\",\n \"file_size\": 246560,\n \"file_extension\": \"M4A\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\"\n }\n ],\n \"participant_audio_files\": [\n {\n \"id\": \"ed6c2f27-2ae7-42f4-b3d0-835b493e4fa8\",\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\",\n \"file_type\": \"M4A\",\n \"file_name\": \"MyRecording\",\n \"file_size\": 246560,\n \"file_extension\": \"MP4\",\n \"download_url\": \"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngAAAA\",\n \"status\": \"completed\",\n \"recording_type\": \"audio_only\",\n \"user_id\": \"16778240\",\n \"user_key\": \"key1\"\n }\n ],\n \"participant_video_files\": [\n {\n \"id\": \"0a564312-edf7-495e-b916-6873a7b32c50\",\n \"status\": \"completed\",\n \"recording_start\": \"2022-12-06T01:01:30Z\",\n \"recording_end\": \"2022-12-06T01:10:32Z\",\n \"file_type\": \"MP4\",\n \"file_size\": 1200500,\n \"download_url\": \"https://example.com/rec/download/cWfE3Ye3UUFgTxbBcii5t\",\n \"recording_type\": \"individual_shared_screen\",\n \"file_name\": \"Separated Share Video - user@example.com\",\n \"file_extension\": \"MP4\",\n \"user_id\": \"16778240\",\n \"user_key\": \"key1\"\n }\n ]\n }\n }\n}"
5518 }
5519 }
5520 }
5521 }
5522 }
5523 }
5524 }
5525 },
5526 "session.recording_transcript_failed": {
5527 "post": {
5528 "tags": ["session"],
5529 "operationId": "session.recording_transcript_failed",
5530 "requestBody": {
5531 "description": "# session.recording_transcript_failed\n---\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 [Enable cloud recording](https://developers.zoom.us/docs/video-sdk/account/#enable-cloud-recording) 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:\n\n\n\n**Event type**: `session.recording_transcript_failed`\n",
5532 "content": {
5533 "application/json": {
5534 "schema": {
5535 "type": "object",
5536 "required": ["event", "event_ts", "payload"],
5537 "properties": {
5538 "event": {
5539 "type": "string",
5540 "enum": ["session.recording_transcript_failed"],
5541 "description": "The event's name."
5542 },
5543 "event_ts": {
5544 "type": "integer",
5545 "format": "int64",
5546 "description": "A timestamp, in milliseconds since epoch, when the event occurred."
5547 },
5548 "payload": {
5549 "type": "object",
5550 "required": ["account_id", "object"],
5551 "properties": {
5552 "account_id": {
5553 "type": "string",
5554 "description": "The Video SDK account ID."
5555 },
5556 "object": {
5557 "type": "object",
5558 "description": "Information about the session. This object only returns updated properties.",
5559 "required": [
5560 "session_id",
5561 "session_name",
5562 "session_key",
5563 "start_time",
5564 "timezone"
5565 ],
5566 "properties": {
5567 "session_id": {
5568 "type": "string",
5569 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5570 },
5571 "session_name": {
5572 "type": "string",
5573 "description": "Session name."
5574 },
5575 "session_key": {
5576 "type": "string",
5577 "description": "The Video SDK custom session ID."
5578 },
5579 "start_time": {
5580 "type": "string",
5581 "format": "date-time",
5582 "description": "The time when the session started."
5583 },
5584 "timezone": {
5585 "type": "string",
5586 "description": "The user's timezone."
5587 }
5588 },
5589 "additionalProperties": false
5590 }
5591 },
5592 "additionalProperties": false
5593 }
5594 },
5595 "additionalProperties": false
5596 },
5597 "examples": {
5598 "json-example": {
5599 "summary": "JSON example",
5600 "value": "{\n \"event\": \"session.recording_transcript_completed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
5601 }
5602 }
5603 }
5604 }
5605 },
5606 "responses": {
5607 "200": {
5608 "content": {
5609 "application/json": {
5610 "schema": {
5611 "type": "object",
5612 "required": ["event", "event_ts", "payload"],
5613 "properties": {
5614 "event": {
5615 "type": "string",
5616 "enum": ["session.recording_transcript_failed"],
5617 "description": "The event's name."
5618 },
5619 "event_ts": {
5620 "type": "integer",
5621 "format": "int64",
5622 "description": "A timestamp, in milliseconds since epoch, when the event occurred."
5623 },
5624 "payload": {
5625 "type": "object",
5626 "required": ["account_id", "object"],
5627 "properties": {
5628 "account_id": {
5629 "type": "string",
5630 "description": "The Video SDK account ID."
5631 },
5632 "object": {
5633 "type": "object",
5634 "description": "Information about the session. This object only returns updated properties.",
5635 "required": [
5636 "session_id",
5637 "session_name",
5638 "session_key",
5639 "start_time",
5640 "timezone"
5641 ],
5642 "properties": {
5643 "session_id": {
5644 "type": "string",
5645 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5646 },
5647 "session_name": {
5648 "type": "string",
5649 "description": "Session name."
5650 },
5651 "session_key": {
5652 "type": "string",
5653 "description": "The Video SDK custom session ID."
5654 },
5655 "start_time": {
5656 "type": "string",
5657 "format": "date-time",
5658 "description": "The time when the session started."
5659 },
5660 "timezone": {
5661 "type": "string",
5662 "description": "The user's timezone."
5663 }
5664 },
5665 "additionalProperties": false
5666 }
5667 },
5668 "additionalProperties": false
5669 }
5670 },
5671 "additionalProperties": false
5672 },
5673 "examples": {
5674 "json-example": {
5675 "summary": "JSON example",
5676 "value": "{\n \"event\": \"session.recording_transcript_completed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
5677 }
5678 }
5679 }
5680 }
5681 }
5682 }
5683 }
5684 },
5685 "session.recording_trashed": {
5686 "post": {
5687 "tags": ["session"],
5688 "operationId": "session.recording_trashed",
5689 "requestBody": {
5690 "description": "# session.recording_trashed\n---\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\n\n**Event type**: `session.recording_trashed`\n",
5691 "content": {
5692 "application/json": {
5693 "schema": {
5694 "type": "object",
5695 "required": ["event", "event_ts", "payload"],
5696 "properties": {
5697 "event": {
5698 "type": "string",
5699 "enum": ["session.recording_trashed"],
5700 "description": "The event's name."
5701 },
5702 "event_ts": {
5703 "type": "integer",
5704 "format": "int64",
5705 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
5706 },
5707 "payload": {
5708 "type": "object",
5709 "required": [
5710 "account_id",
5711 "operator",
5712 "operator_id",
5713 "object"
5714 ],
5715 "properties": {
5716 "account_id": {
5717 "type": "string",
5718 "description": "The Video SDK account ID."
5719 },
5720 "operator": {
5721 "type": "string",
5722 "format": "email",
5723 "description": "The email address of the user who deleted the recording."
5724 },
5725 "operator_id": {
5726 "type": "string",
5727 "description": "The user ID of the user who deleted the recording."
5728 },
5729 "object": {
5730 "type": "object",
5731 "description": "Information about the session. This object only returns updated properties.",
5732 "required": [
5733 "session_id",
5734 "session_name",
5735 "session_key",
5736 "start_time",
5737 "timezone"
5738 ],
5739 "properties": {
5740 "session_id": {
5741 "type": "string",
5742 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5743 },
5744 "session_name": {
5745 "type": "string",
5746 "description": "Session name."
5747 },
5748 "session_key": {
5749 "type": "string",
5750 "description": "The Video SDK custom session ID."
5751 },
5752 "start_time": {
5753 "type": "string",
5754 "format": "date-time",
5755 "description": "The time at which the session started."
5756 },
5757 "timezone": {
5758 "type": "string",
5759 "description": "The user's timezone."
5760 }
5761 },
5762 "additionalProperties": false
5763 }
5764 },
5765 "additionalProperties": false
5766 }
5767 },
5768 "additionalProperties": false
5769 },
5770 "examples": {
5771 "json-example": {
5772 "summary": "JSON example",
5773 "value": "{\n \"event\": \"session.recording_trashed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
5774 }
5775 }
5776 }
5777 }
5778 },
5779 "responses": {
5780 "200": {
5781 "content": {
5782 "application/json": {
5783 "schema": {
5784 "type": "object",
5785 "required": ["event", "event_ts", "payload"],
5786 "properties": {
5787 "event": {
5788 "type": "string",
5789 "enum": ["session.recording_trashed"],
5790 "description": "The event's name."
5791 },
5792 "event_ts": {
5793 "type": "integer",
5794 "format": "int64",
5795 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
5796 },
5797 "payload": {
5798 "type": "object",
5799 "required": [
5800 "account_id",
5801 "operator",
5802 "operator_id",
5803 "object"
5804 ],
5805 "properties": {
5806 "account_id": {
5807 "type": "string",
5808 "description": "The Video SDK account ID."
5809 },
5810 "operator": {
5811 "type": "string",
5812 "format": "email",
5813 "description": "The email address of the user who deleted the recording."
5814 },
5815 "operator_id": {
5816 "type": "string",
5817 "description": "The user ID of the user who deleted the recording."
5818 },
5819 "object": {
5820 "type": "object",
5821 "description": "Information about the session. This object only returns updated properties.",
5822 "required": [
5823 "session_id",
5824 "session_name",
5825 "session_key",
5826 "start_time",
5827 "timezone"
5828 ],
5829 "properties": {
5830 "session_id": {
5831 "type": "string",
5832 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5833 },
5834 "session_name": {
5835 "type": "string",
5836 "description": "Session name."
5837 },
5838 "session_key": {
5839 "type": "string",
5840 "description": "The Video SDK custom session ID."
5841 },
5842 "start_time": {
5843 "type": "string",
5844 "format": "date-time",
5845 "description": "The time at which the session started."
5846 },
5847 "timezone": {
5848 "type": "string",
5849 "description": "The user's timezone."
5850 }
5851 },
5852 "additionalProperties": false
5853 }
5854 },
5855 "additionalProperties": false
5856 }
5857 },
5858 "additionalProperties": false
5859 },
5860 "examples": {
5861 "json-example": {
5862 "summary": "JSON example",
5863 "value": "{\n \"event\": \"session.recording_trashed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
5864 }
5865 }
5866 }
5867 }
5868 }
5869 }
5870 }
5871 },
5872 "session.user_joined": {
5873 "post": {
5874 "tags": ["session"],
5875 "operationId": "session.user_joined",
5876 "requestBody": {
5877 "description": "# session.user_joined\n---\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\n\n**Event type**: `session.user_joined`\n",
5878 "content": {
5879 "application/json": {
5880 "schema": {
5881 "type": "object",
5882 "required": ["event", "event_ts", "payload"],
5883 "properties": {
5884 "event": {
5885 "type": "string",
5886 "enum": ["session.user_joined"],
5887 "description": "The event's name."
5888 },
5889 "event_ts": {
5890 "type": "integer",
5891 "format": "int64",
5892 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
5893 },
5894 "payload": {
5895 "type": "object",
5896 "required": ["account_id", "object"],
5897 "properties": {
5898 "account_id": {
5899 "type": "string",
5900 "description": "The Video SDK account ID."
5901 },
5902 "object": {
5903 "type": "object",
5904 "description": "Information about the session. This object only returns updated properties.",
5905 "required": [
5906 "id",
5907 "session_id",
5908 "session_name",
5909 "user"
5910 ],
5911 "properties": {
5912 "id": {
5913 "type": "string",
5914 "description": "The session ID."
5915 },
5916 "session_id": {
5917 "type": "string",
5918 "description": "Unique session identifier. Each instance of the session will have its own session_id."
5919 },
5920 "session_name": {
5921 "type": "string",
5922 "description": "Session name."
5923 },
5924 "session_key": {
5925 "type": "string",
5926 "description": "The Video SDK custom session ID."
5927 },
5928 "user": {
5929 "type": "object",
5930 "description": "Information about the user.",
5931 "required": [
5932 "id",
5933 "name",
5934 "join_time",
5935 "participant_uuid"
5936 ],
5937 "properties": {
5938 "id": {
5939 "type": "string",
5940 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
5941 },
5942 "name": {
5943 "type": "string",
5944 "description": "The user's username."
5945 },
5946 "join_time": {
5947 "type": "string",
5948 "description": "The time at which the user joined the session.",
5949 "format": "date-time"
5950 },
5951 "user_key": {
5952 "type": "string",
5953 "description": "Another identifier for the user. Can be a number or characters."
5954 },
5955 "phone_number": {
5956 "type": "string",
5957 "description": "Phone number of participant joined via PSTN."
5958 },
5959 "participant_uuid": {
5960 "type": "string",
5961 "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."
5962 }
5963 },
5964 "additionalProperties": false
5965 }
5966 },
5967 "additionalProperties": false
5968 }
5969 },
5970 "additionalProperties": false
5971 }
5972 },
5973 "additionalProperties": false
5974 },
5975 "examples": {
5976 "json-example": {
5977 "summary": "JSON example",
5978 "value": "{\n \"event\": \"session.user_joined\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"example\",\n \"join_time\": \"2021-07-16T17:19:11Z\",\n \"user_key\": \"ASD74dfDI854\",\n \"phone_number\": \"8615250064084\",\n \"participant_uuid\": \"55555AAAiAAAAAiAiAiiAii\"\n }\n }\n }\n}"
5979 }
5980 }
5981 }
5982 }
5983 },
5984 "responses": {
5985 "200": {
5986 "content": {
5987 "application/json": {
5988 "schema": {
5989 "type": "object",
5990 "required": ["event", "event_ts", "payload"],
5991 "properties": {
5992 "event": {
5993 "type": "string",
5994 "enum": ["session.user_joined"],
5995 "description": "The event's name."
5996 },
5997 "event_ts": {
5998 "type": "integer",
5999 "format": "int64",
6000 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
6001 },
6002 "payload": {
6003 "type": "object",
6004 "required": ["account_id", "object"],
6005 "properties": {
6006 "account_id": {
6007 "type": "string",
6008 "description": "The Video SDK account ID."
6009 },
6010 "object": {
6011 "type": "object",
6012 "description": "Information about the session. This object only returns updated properties.",
6013 "required": [
6014 "id",
6015 "session_id",
6016 "session_name",
6017 "user"
6018 ],
6019 "properties": {
6020 "id": {
6021 "type": "string",
6022 "description": "The session ID."
6023 },
6024 "session_id": {
6025 "type": "string",
6026 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6027 },
6028 "session_name": {
6029 "type": "string",
6030 "description": "Session name."
6031 },
6032 "session_key": {
6033 "type": "string",
6034 "description": "The Video SDK custom session ID."
6035 },
6036 "user": {
6037 "type": "object",
6038 "description": "Information about the user.",
6039 "required": [
6040 "id",
6041 "name",
6042 "join_time",
6043 "participant_uuid"
6044 ],
6045 "properties": {
6046 "id": {
6047 "type": "string",
6048 "description": "The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."
6049 },
6050 "name": {
6051 "type": "string",
6052 "description": "The user's username."
6053 },
6054 "join_time": {
6055 "type": "string",
6056 "description": "The time at which the user joined the session.",
6057 "format": "date-time"
6058 },
6059 "user_key": {
6060 "type": "string",
6061 "description": "Another identifier for the user. Can be a number or characters."
6062 },
6063 "phone_number": {
6064 "type": "string",
6065 "description": "Phone number of participant joined via PSTN."
6066 },
6067 "participant_uuid": {
6068 "type": "string",
6069 "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."
6070 }
6071 },
6072 "additionalProperties": false
6073 }
6074 },
6075 "additionalProperties": false
6076 }
6077 },
6078 "additionalProperties": false
6079 }
6080 },
6081 "additionalProperties": false
6082 },
6083 "examples": {
6084 "json-example": {
6085 "summary": "JSON example",
6086 "value": "{\n \"event\": \"session.user_joined\",\n \"event_ts\": 1626473951859,\n \"payload\": {\n \"account_id\": \"EFgHiJABC000DEfGHI\",\n \"object\": {\n \"id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user\": {\n \"id\": \"25508864\",\n \"name\": \"example\",\n \"join_time\": \"2021-07-16T17:19:11Z\",\n \"user_key\": \"ASD74dfDI854\",\n \"phone_number\": \"8615250064084\",\n \"participant_uuid\": \"55555AAAiAAAAAiAiAiiAii\"\n }\n }\n }\n}"
6087 }
6088 }
6089 }
6090 }
6091 }
6092 }
6093 }
6094 },
6095 "session.stream_ingestion_started": {
6096 "post": {
6097 "tags": ["session"],
6098 "operationId": "session.stream_ingestion_started",
6099 "requestBody": {
6100 "description": "# session.stream_ingestion_started\nZoom 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\n\n**Event type**: `session.stream_ingestion_started`\n",
6101 "content": {
6102 "application/json": {
6103 "schema": {
6104 "type": "object",
6105 "required": ["event", "event_ts", "payload"],
6106 "properties": {
6107 "event": {
6108 "type": "string",
6109 "enum": ["session.stream_ingestion_started"],
6110 "description": "Event name."
6111 },
6112 "event_ts": {
6113 "type": "integer",
6114 "format": "int64",
6115 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6116 },
6117 "payload": {
6118 "type": "object",
6119 "required": ["account_id", "object"],
6120 "properties": {
6121 "account_id": {
6122 "type": "string",
6123 "description": "The Video SDK account ID."
6124 },
6125 "object": {
6126 "type": "object",
6127 "description": "Information about the session.",
6128 "required": [
6129 "session_id",
6130 "session_name",
6131 "stream_ingestion"
6132 ],
6133 "properties": {
6134 "session_id": {
6135 "type": "string",
6136 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6137 },
6138 "session_name": {
6139 "type": "string",
6140 "description": "Session name."
6141 },
6142 "session_key": {
6143 "type": "string",
6144 "description": "The Video SDK custom session ID."
6145 },
6146 "stream_ingestion": {
6147 "type": "object",
6148 "description": "Information about the stream ingestion.",
6149 "required": [
6150 "stream_id",
6151 "stream_name",
6152 "stream_key",
6153 "stream_url",
6154 "backup_stream_url"
6155 ],
6156 "properties": {
6157 "stream_id": {
6158 "type": "string",
6159 "description": "The stream ingestion ID."
6160 },
6161 "stream_name": {
6162 "type": "string",
6163 "description": "The stream ingestion name."
6164 },
6165 "stream_description": {
6166 "type": "string",
6167 "description": "The stream ingestion description."
6168 },
6169 "stream_key": {
6170 "type": "string",
6171 "description": "The stream ingestion key."
6172 },
6173 "stream_url": {
6174 "type": "string",
6175 "description": "The stream URL."
6176 },
6177 "backup_stream_url": {
6178 "type": "string",
6179 "description": "The backup stream URL."
6180 }
6181 }
6182 }
6183 },
6184 "additionalProperties": false
6185 }
6186 },
6187 "additionalProperties": false
6188 }
6189 },
6190 "additionalProperties": false
6191 },
6192 "examples": {
6193 "json-example": {
6194 "summary": "JSON example",
6195 "value": "{\n \"event\": \"session.stream_ingestion_started\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6196 }
6197 }
6198 }
6199 }
6200 },
6201 "responses": {
6202 "200": {
6203 "content": {
6204 "application/json": {
6205 "schema": {
6206 "type": "object",
6207 "required": ["event", "event_ts", "payload"],
6208 "properties": {
6209 "event": {
6210 "type": "string",
6211 "enum": ["session.stream_ingestion_started"],
6212 "description": "Event name."
6213 },
6214 "event_ts": {
6215 "type": "integer",
6216 "format": "int64",
6217 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6218 },
6219 "payload": {
6220 "type": "object",
6221 "required": ["account_id", "object"],
6222 "properties": {
6223 "account_id": {
6224 "type": "string",
6225 "description": "The Video SDK account ID."
6226 },
6227 "object": {
6228 "type": "object",
6229 "description": "Information about the session.",
6230 "required": [
6231 "session_id",
6232 "session_name",
6233 "stream_ingestion"
6234 ],
6235 "properties": {
6236 "session_id": {
6237 "type": "string",
6238 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6239 },
6240 "session_name": {
6241 "type": "string",
6242 "description": "Session name."
6243 },
6244 "session_key": {
6245 "type": "string",
6246 "description": "The Video SDK custom session ID."
6247 },
6248 "stream_ingestion": {
6249 "type": "object",
6250 "description": "Information about the stream ingestion.",
6251 "required": [
6252 "stream_id",
6253 "stream_name",
6254 "stream_key",
6255 "stream_url",
6256 "backup_stream_url"
6257 ],
6258 "properties": {
6259 "stream_id": {
6260 "type": "string",
6261 "description": "The stream ingestion ID."
6262 },
6263 "stream_name": {
6264 "type": "string",
6265 "description": "The stream ingestion name."
6266 },
6267 "stream_description": {
6268 "type": "string",
6269 "description": "The stream ingestion description."
6270 },
6271 "stream_key": {
6272 "type": "string",
6273 "description": "The stream ingestion key."
6274 },
6275 "stream_url": {
6276 "type": "string",
6277 "description": "The stream URL."
6278 },
6279 "backup_stream_url": {
6280 "type": "string",
6281 "description": "The backup stream URL."
6282 }
6283 }
6284 }
6285 },
6286 "additionalProperties": false
6287 }
6288 },
6289 "additionalProperties": false
6290 }
6291 },
6292 "additionalProperties": false
6293 },
6294 "examples": {
6295 "json-example": {
6296 "summary": "JSON example",
6297 "value": "{\n \"event\": \"session.stream_ingestion_started\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6298 }
6299 }
6300 }
6301 }
6302 }
6303 }
6304 }
6305 },
6306 "session.stream_ingestion_connected": {
6307 "post": {
6308 "tags": ["session"],
6309 "operationId": "session.stream_ingestion_connected",
6310 "requestBody": {
6311 "description": "# session.stream_ingestion_connected\nZoom 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\n\n**Event type**: `session.stream_ingestion_connected`\n",
6312 "content": {
6313 "application/json": {
6314 "schema": {
6315 "type": "object",
6316 "required": ["event", "event_ts", "payload"],
6317 "properties": {
6318 "event": {
6319 "type": "string",
6320 "enum": ["session.stream_ingestion_connected"],
6321 "description": "Name of the event."
6322 },
6323 "event_ts": {
6324 "type": "integer",
6325 "format": "int64",
6326 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6327 },
6328 "payload": {
6329 "type": "object",
6330 "required": ["account_id", "object"],
6331 "properties": {
6332 "account_id": {
6333 "type": "string",
6334 "description": "The Video SDK account ID."
6335 },
6336 "object": {
6337 "type": "object",
6338 "description": "Information about the session.",
6339 "required": [
6340 "session_id",
6341 "session_name",
6342 "stream_ingestion"
6343 ],
6344 "properties": {
6345 "session_id": {
6346 "type": "string",
6347 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6348 },
6349 "session_name": {
6350 "type": "string",
6351 "description": "Session name."
6352 },
6353 "session_key": {
6354 "type": "string",
6355 "description": "The Video SDK custom session ID."
6356 },
6357 "stream_ingestion": {
6358 "type": "object",
6359 "description": "Information about the stream ingestion.",
6360 "required": [
6361 "stream_id",
6362 "stream_name",
6363 "stream_key",
6364 "stream_url",
6365 "backup_stream_url"
6366 ],
6367 "properties": {
6368 "stream_id": {
6369 "type": "string",
6370 "description": "The stream ingestion ID."
6371 },
6372 "stream_name": {
6373 "type": "string",
6374 "description": "The stream ingestion name."
6375 },
6376 "stream_description": {
6377 "type": "string",
6378 "description": "The stream ingestion description."
6379 },
6380 "stream_key": {
6381 "type": "string",
6382 "description": "The stream ingestion key."
6383 },
6384 "stream_url": {
6385 "type": "string",
6386 "description": "The stream URL."
6387 },
6388 "backup_stream_url": {
6389 "type": "string",
6390 "description": "The backup stream URL."
6391 }
6392 }
6393 }
6394 },
6395 "additionalProperties": false
6396 }
6397 },
6398 "additionalProperties": false
6399 }
6400 },
6401 "additionalProperties": false
6402 },
6403 "examples": {
6404 "json-example": {
6405 "summary": "JSON example",
6406 "value": "{\n \"event\": \"session.stream_ingestion_connected\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6407 }
6408 }
6409 }
6410 }
6411 },
6412 "responses": {
6413 "200": {
6414 "content": {
6415 "application/json": {
6416 "schema": {
6417 "type": "object",
6418 "required": ["event", "event_ts", "payload"],
6419 "properties": {
6420 "event": {
6421 "type": "string",
6422 "enum": ["session.stream_ingestion_connected"],
6423 "description": "Name of the event."
6424 },
6425 "event_ts": {
6426 "type": "integer",
6427 "format": "int64",
6428 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6429 },
6430 "payload": {
6431 "type": "object",
6432 "required": ["account_id", "object"],
6433 "properties": {
6434 "account_id": {
6435 "type": "string",
6436 "description": "The Video SDK account ID."
6437 },
6438 "object": {
6439 "type": "object",
6440 "description": "Information about the session.",
6441 "required": [
6442 "session_id",
6443 "session_name",
6444 "stream_ingestion"
6445 ],
6446 "properties": {
6447 "session_id": {
6448 "type": "string",
6449 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6450 },
6451 "session_name": {
6452 "type": "string",
6453 "description": "Session name."
6454 },
6455 "session_key": {
6456 "type": "string",
6457 "description": "The Video SDK custom session ID."
6458 },
6459 "stream_ingestion": {
6460 "type": "object",
6461 "description": "Information about the stream ingestion.",
6462 "required": [
6463 "stream_id",
6464 "stream_name",
6465 "stream_key",
6466 "stream_url",
6467 "backup_stream_url"
6468 ],
6469 "properties": {
6470 "stream_id": {
6471 "type": "string",
6472 "description": "The stream ingestion ID."
6473 },
6474 "stream_name": {
6475 "type": "string",
6476 "description": "The stream ingestion name."
6477 },
6478 "stream_description": {
6479 "type": "string",
6480 "description": "The stream ingestion description."
6481 },
6482 "stream_key": {
6483 "type": "string",
6484 "description": "The stream ingestion key."
6485 },
6486 "stream_url": {
6487 "type": "string",
6488 "description": "The stream URL."
6489 },
6490 "backup_stream_url": {
6491 "type": "string",
6492 "description": "The backup stream URL."
6493 }
6494 }
6495 }
6496 },
6497 "additionalProperties": false
6498 }
6499 },
6500 "additionalProperties": false
6501 }
6502 },
6503 "additionalProperties": false
6504 },
6505 "examples": {
6506 "json-example": {
6507 "summary": "JSON example",
6508 "value": "{\n \"event\": \"session.stream_ingestion_connected\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6509 }
6510 }
6511 }
6512 }
6513 }
6514 }
6515 }
6516 },
6517 "session.stream_ingestion_disconnected": {
6518 "post": {
6519 "tags": ["session"],
6520 "operationId": "session.stream_ingestion_disconnected",
6521 "requestBody": {
6522 "description": "# session.stream_ingestion_disconnected\nZoom 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\n\n**Event type**: `session.stream_ingestion_disconnected`\n",
6523 "content": {
6524 "application/json": {
6525 "schema": {
6526 "type": "object",
6527 "required": ["event", "event_ts", "payload"],
6528 "properties": {
6529 "event": {
6530 "type": "string",
6531 "enum": ["session.stream_ingestion_disconnected"],
6532 "description": "Name of the event."
6533 },
6534 "event_ts": {
6535 "type": "integer",
6536 "format": "int64",
6537 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6538 },
6539 "payload": {
6540 "type": "object",
6541 "required": ["account_id", "object"],
6542 "properties": {
6543 "account_id": {
6544 "type": "string",
6545 "description": "The Video SDK account ID."
6546 },
6547 "object": {
6548 "type": "object",
6549 "description": "Information about the session.",
6550 "required": [
6551 "session_id",
6552 "session_name",
6553 "stream_ingestion"
6554 ],
6555 "properties": {
6556 "session_id": {
6557 "type": "string",
6558 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6559 },
6560 "session_name": {
6561 "type": "string",
6562 "description": "Session name."
6563 },
6564 "session_key": {
6565 "type": "string",
6566 "description": "The Video SDK custom session ID."
6567 },
6568 "stream_ingestion": {
6569 "type": "object",
6570 "description": "Information about the stream ingestion.",
6571 "required": [
6572 "stream_id",
6573 "stream_name",
6574 "stream_key",
6575 "stream_url",
6576 "backup_stream_url"
6577 ],
6578 "properties": {
6579 "stream_id": {
6580 "type": "string",
6581 "description": "The stream ingestion ID."
6582 },
6583 "stream_name": {
6584 "type": "string",
6585 "description": "The stream ingestion name."
6586 },
6587 "stream_description": {
6588 "type": "string",
6589 "description": "The stream ingestion description."
6590 },
6591 "stream_key": {
6592 "type": "string",
6593 "description": "The stream ingestion key."
6594 },
6595 "stream_url": {
6596 "type": "string",
6597 "description": "The stream URL."
6598 },
6599 "backup_stream_url": {
6600 "type": "string",
6601 "description": "The backup stream URL."
6602 }
6603 }
6604 }
6605 },
6606 "additionalProperties": false
6607 }
6608 },
6609 "additionalProperties": false
6610 }
6611 },
6612 "additionalProperties": false
6613 },
6614 "examples": {
6615 "json-example": {
6616 "summary": "JSON example",
6617 "value": "{\n \"event\": \"session.stream_ingestion_disconnected\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6618 }
6619 }
6620 }
6621 }
6622 },
6623 "responses": {
6624 "200": {
6625 "content": {
6626 "application/json": {
6627 "schema": {
6628 "type": "object",
6629 "required": ["event", "event_ts", "payload"],
6630 "properties": {
6631 "event": {
6632 "type": "string",
6633 "enum": ["session.stream_ingestion_disconnected"],
6634 "description": "Name of the event."
6635 },
6636 "event_ts": {
6637 "type": "integer",
6638 "format": "int64",
6639 "description": "Timestamp (in milliseconds since epoch) when the event occurred. The value of this field is returned in long (int64) format."
6640 },
6641 "payload": {
6642 "type": "object",
6643 "required": ["account_id", "object"],
6644 "properties": {
6645 "account_id": {
6646 "type": "string",
6647 "description": "The Video SDK account ID."
6648 },
6649 "object": {
6650 "type": "object",
6651 "description": "Information about the session.",
6652 "required": [
6653 "session_id",
6654 "session_name",
6655 "stream_ingestion"
6656 ],
6657 "properties": {
6658 "session_id": {
6659 "type": "string",
6660 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6661 },
6662 "session_name": {
6663 "type": "string",
6664 "description": "Session name."
6665 },
6666 "session_key": {
6667 "type": "string",
6668 "description": "The Video SDK custom session ID."
6669 },
6670 "stream_ingestion": {
6671 "type": "object",
6672 "description": "Information about the stream ingestion.",
6673 "required": [
6674 "stream_id",
6675 "stream_name",
6676 "stream_key",
6677 "stream_url",
6678 "backup_stream_url"
6679 ],
6680 "properties": {
6681 "stream_id": {
6682 "type": "string",
6683 "description": "The stream ingestion ID."
6684 },
6685 "stream_name": {
6686 "type": "string",
6687 "description": "The stream ingestion name."
6688 },
6689 "stream_description": {
6690 "type": "string",
6691 "description": "The stream ingestion description."
6692 },
6693 "stream_key": {
6694 "type": "string",
6695 "description": "The stream ingestion key."
6696 },
6697 "stream_url": {
6698 "type": "string",
6699 "description": "The stream URL."
6700 },
6701 "backup_stream_url": {
6702 "type": "string",
6703 "description": "The backup stream URL."
6704 }
6705 }
6706 }
6707 },
6708 "additionalProperties": false
6709 }
6710 },
6711 "additionalProperties": false
6712 }
6713 },
6714 "additionalProperties": false
6715 },
6716 "examples": {
6717 "json-example": {
6718 "summary": "JSON example",
6719 "value": "{\n \"event\": \"session.stream_ingestion_disconnected\",\n \"event_ts\": 1627906965803,\n \"payload\": {\n \"account_id\": \"D8cJuqWVQ623CI4Q8yQK0Q\",\n \"object\": {\n \"session_id\": \"4567UVWxYZABCdEfGhiJkl==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"stream_ingestion\": {\n \"stream_id\": \"sfk/aOFJSJSYhGwk1hnxgw==\",\n \"stream_name\": \"stream ingestion1\",\n \"stream_description\": \"stream ingestion1\",\n \"stream_key\": \"ABCDEFG12345HIJ6789\",\n \"stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\",\n \"backup_stream_url\": \"rtmp://a.rtmp.zoomevent.com/live1\"\n }\n }\n }\n}"
6720 }
6721 }
6722 }
6723 }
6724 }
6725 }
6726 }
6727 },
6728 "session.recording_recovered": {
6729 "post": {
6730 "tags": ["session"],
6731 "operationId": "session.recording_recovered",
6732 "requestBody": {
6733 "description": "# session.recording_recovered\n---\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\n\n**Event type**: `session.recording_recovered`\n",
6734 "content": {
6735 "application/json": {
6736 "schema": {
6737 "type": "object",
6738 "required": ["event", "event_ts", "payload"],
6739 "properties": {
6740 "event": {
6741 "type": "string",
6742 "enum": ["session.recording_recovered"],
6743 "description": "The event's name."
6744 },
6745 "event_ts": {
6746 "type": "integer",
6747 "format": "int64",
6748 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
6749 },
6750 "payload": {
6751 "type": "object",
6752 "required": [
6753 "account_id",
6754 "operator",
6755 "operator_id",
6756 "object"
6757 ],
6758 "properties": {
6759 "account_id": {
6760 "type": "string",
6761 "description": "The Video SDK account ID."
6762 },
6763 "operator": {
6764 "type": "string",
6765 "format": "email",
6766 "description": "The email address of the user who deleted the recording."
6767 },
6768 "operator_id": {
6769 "type": "string",
6770 "description": "The user ID of the user who deleted the recording."
6771 },
6772 "object": {
6773 "type": "object",
6774 "description": "Information about the session. This object only returns updated properties.",
6775 "required": [
6776 "session_id",
6777 "session_name",
6778 "session_key",
6779 "start_time",
6780 "timezone"
6781 ],
6782 "properties": {
6783 "session_id": {
6784 "type": "string",
6785 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6786 },
6787 "session_name": {
6788 "type": "string",
6789 "description": "Session name."
6790 },
6791 "session_key": {
6792 "type": "string",
6793 "description": "The Video SDK custom session ID."
6794 },
6795 "start_time": {
6796 "type": "string",
6797 "format": "date-time",
6798 "description": "The time at which the session started."
6799 },
6800 "timezone": {
6801 "type": "string",
6802 "description": "The user's timezone."
6803 }
6804 },
6805 "additionalProperties": false
6806 }
6807 },
6808 "additionalProperties": false
6809 }
6810 },
6811 "additionalProperties": false
6812 },
6813 "examples": {
6814 "json-example": {
6815 "summary": "JSON example",
6816 "value": "{\n \"event\": \"session.recording_recovered\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
6817 }
6818 }
6819 }
6820 }
6821 },
6822 "responses": {
6823 "200": {
6824 "content": {
6825 "application/json": {
6826 "schema": {
6827 "type": "object",
6828 "required": ["event", "event_ts", "payload"],
6829 "properties": {
6830 "event": {
6831 "type": "string",
6832 "enum": ["session.recording_recovered"],
6833 "description": "The event's name."
6834 },
6835 "event_ts": {
6836 "type": "integer",
6837 "format": "int64",
6838 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
6839 },
6840 "payload": {
6841 "type": "object",
6842 "required": [
6843 "account_id",
6844 "operator",
6845 "operator_id",
6846 "object"
6847 ],
6848 "properties": {
6849 "account_id": {
6850 "type": "string",
6851 "description": "The Video SDK account ID."
6852 },
6853 "operator": {
6854 "type": "string",
6855 "format": "email",
6856 "description": "The email address of the user who deleted the recording."
6857 },
6858 "operator_id": {
6859 "type": "string",
6860 "description": "The user ID of the user who deleted the recording."
6861 },
6862 "object": {
6863 "type": "object",
6864 "description": "Information about the session. This object only returns updated properties.",
6865 "required": [
6866 "session_id",
6867 "session_name",
6868 "session_key",
6869 "start_time",
6870 "timezone"
6871 ],
6872 "properties": {
6873 "session_id": {
6874 "type": "string",
6875 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6876 },
6877 "session_name": {
6878 "type": "string",
6879 "description": "Session name."
6880 },
6881 "session_key": {
6882 "type": "string",
6883 "description": "The Video SDK custom session ID."
6884 },
6885 "start_time": {
6886 "type": "string",
6887 "format": "date-time",
6888 "description": "The time at which the session started."
6889 },
6890 "timezone": {
6891 "type": "string",
6892 "description": "The user's timezone."
6893 }
6894 },
6895 "additionalProperties": false
6896 }
6897 },
6898 "additionalProperties": false
6899 }
6900 },
6901 "additionalProperties": false
6902 },
6903 "examples": {
6904 "json-example": {
6905 "summary": "JSON example",
6906 "value": "{\n \"event\": \"session.recording_recovered\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n\t\"operator\" : \"user@example.com\",\n\t\"operator_id\" : \"I7zp-pYbTl22Z29H796Ixg\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\"\n }\n }\n}"
6907 }
6908 }
6909 }
6910 }
6911 }
6912 }
6913 }
6914 },
6915 "session.user_phone_callout_missed": {
6916 "post": {
6917 "tags": ["session"],
6918 "operationId": "session.user_phone_callout_missed",
6919 "requestBody": {
6920 "description": "# session.user_phone_callout_missed\n\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\n\n**Event type**: `session.user_phone_callout_missed`\n",
6921 "content": {
6922 "application/json": {
6923 "schema": {
6924 "type": "object",
6925 "required": ["event", "event_ts", "payload"],
6926 "properties": {
6927 "event": {
6928 "type": "string",
6929 "description": "The name of the event."
6930 },
6931 "event_ts": {
6932 "type": "integer",
6933 "format": "int64",
6934 "description": "A timestamp at which the event occurred."
6935 },
6936 "payload": {
6937 "type": "object",
6938 "required": ["account_id", "object"],
6939 "properties": {
6940 "account_id": {
6941 "type": "string",
6942 "description": "The account ID of the session host."
6943 },
6944 "object": {
6945 "type": "object",
6946 "description": "Information about the session.",
6947 "required": [
6948 "session_id",
6949 "session_name",
6950 "session_key",
6951 "user_key",
6952 "host_id",
6953 "participant"
6954 ],
6955 "properties": {
6956 "id": {
6957 "type": "integer",
6958 "format": "int64",
6959 "description": "The session ID.",
6960 "deprecated": true
6961 },
6962 "uuid": {
6963 "type": "string",
6964 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
6965 "deprecated": true
6966 },
6967 "session_id": {
6968 "type": "string",
6969 "description": "Unique session identifier. Each instance of the session will have its own session_id."
6970 },
6971 "session_name": {
6972 "type": "string",
6973 "description": "Session name."
6974 },
6975 "session_key": {
6976 "type": "string",
6977 "description": "The Video SDK custom session ID."
6978 },
6979 "user_key": {
6980 "type": "string",
6981 "description": "Another identifier for the inviter. Can be a number or characters."
6982 },
6983 "host_id": {
6984 "type": "string",
6985 "description": "The user ID of the session host."
6986 },
6987 "participant": {
6988 "type": "object",
6989 "description": "Information about the invited user.",
6990 "required": [
6991 "invitee_name",
6992 "phone_number",
6993 "from_number"
6994 ],
6995 "properties": {
6996 "invitee_name": {
6997 "type": "string",
6998 "description": "The user's name to display in the session."
6999 },
7000 "phone_number": {
7001 "type": "integer",
7002 "format": "int64",
7003 "description": "The user's phone number."
7004 },
7005 "from_number": {
7006 "type": "integer",
7007 "format": "int64",
7008 "description": "The number used to call out to the invited user."
7009 }
7010 },
7011 "additionalProperties": false
7012 }
7013 },
7014 "additionalProperties": false
7015 }
7016 },
7017 "additionalProperties": false
7018 }
7019 },
7020 "additionalProperties": false
7021 },
7022 "examples": {
7023 "json-example": {
7024 "summary": "JSON example",
7025 "value": "{\n \"event\": \"session.user_phone_callout_missed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
7026 }
7027 }
7028 }
7029 }
7030 },
7031 "responses": {
7032 "200": {
7033 "content": {
7034 "application/json": {
7035 "schema": {
7036 "type": "object",
7037 "required": ["event", "event_ts", "payload"],
7038 "properties": {
7039 "event": {
7040 "type": "string",
7041 "description": "The name of the event."
7042 },
7043 "event_ts": {
7044 "type": "integer",
7045 "format": "int64",
7046 "description": "A timestamp at which the event occurred."
7047 },
7048 "payload": {
7049 "type": "object",
7050 "required": ["account_id", "object"],
7051 "properties": {
7052 "account_id": {
7053 "type": "string",
7054 "description": "The account ID of the session host."
7055 },
7056 "object": {
7057 "type": "object",
7058 "description": "Information about the session.",
7059 "required": [
7060 "session_id",
7061 "session_name",
7062 "session_key",
7063 "user_key",
7064 "host_id",
7065 "participant"
7066 ],
7067 "properties": {
7068 "id": {
7069 "type": "integer",
7070 "format": "int64",
7071 "description": "The session ID.",
7072 "deprecated": true
7073 },
7074 "uuid": {
7075 "type": "string",
7076 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
7077 "deprecated": true
7078 },
7079 "session_id": {
7080 "type": "string",
7081 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7082 },
7083 "session_name": {
7084 "type": "string",
7085 "description": "Session name."
7086 },
7087 "session_key": {
7088 "type": "string",
7089 "description": "The Video SDK custom session ID."
7090 },
7091 "user_key": {
7092 "type": "string",
7093 "description": "Another identifier for the inviter. Can be a number or characters."
7094 },
7095 "host_id": {
7096 "type": "string",
7097 "description": "The user ID of the session host."
7098 },
7099 "participant": {
7100 "type": "object",
7101 "description": "Information about the invited user.",
7102 "required": [
7103 "invitee_name",
7104 "phone_number",
7105 "from_number"
7106 ],
7107 "properties": {
7108 "invitee_name": {
7109 "type": "string",
7110 "description": "The user's name to display in the session."
7111 },
7112 "phone_number": {
7113 "type": "integer",
7114 "format": "int64",
7115 "description": "The user's phone number."
7116 },
7117 "from_number": {
7118 "type": "integer",
7119 "format": "int64",
7120 "description": "The number used to call out to the invited user."
7121 }
7122 },
7123 "additionalProperties": false
7124 }
7125 },
7126 "additionalProperties": false
7127 }
7128 },
7129 "additionalProperties": false
7130 }
7131 },
7132 "additionalProperties": false
7133 },
7134 "examples": {
7135 "json-example": {
7136 "summary": "JSON example",
7137 "value": "{\n \"event\": \"session.user_phone_callout_missed\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
7138 }
7139 }
7140 }
7141 }
7142 }
7143 }
7144 }
7145 },
7146 "session.user_phone_callout_rejected": {
7147 "post": {
7148 "tags": ["session"],
7149 "operationId": "session.user_phone_callout_rejected",
7150 "requestBody": {
7151 "description": "# session.user_phone_callout_rejected\n\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\n\n**Event type**: `session.user_phone_callout_rejected`\n",
7152 "content": {
7153 "application/json": {
7154 "schema": {
7155 "type": "object",
7156 "required": ["event", "event_ts", "payload"],
7157 "properties": {
7158 "event": {
7159 "type": "string",
7160 "description": "The name of the event."
7161 },
7162 "event_ts": {
7163 "type": "integer",
7164 "format": "int64",
7165 "description": "A timestamp at which the event occurred."
7166 },
7167 "payload": {
7168 "type": "object",
7169 "required": ["account_id", "object"],
7170 "properties": {
7171 "account_id": {
7172 "type": "string",
7173 "description": "The account ID of the session host."
7174 },
7175 "object": {
7176 "type": "object",
7177 "description": "Information about the session.",
7178 "required": [
7179 "session_id",
7180 "session_name",
7181 "session_key",
7182 "user_key",
7183 "host_id",
7184 "participant"
7185 ],
7186 "properties": {
7187 "id": {
7188 "type": "integer",
7189 "format": "int64",
7190 "description": "The session ID.",
7191 "deprecated": true
7192 },
7193 "uuid": {
7194 "type": "string",
7195 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
7196 "deprecated": true
7197 },
7198 "session_id": {
7199 "type": "string",
7200 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7201 },
7202 "session_name": {
7203 "type": "string",
7204 "description": "Session name."
7205 },
7206 "session_key": {
7207 "type": "string",
7208 "description": "The Video SDK custom session ID."
7209 },
7210 "user_key": {
7211 "type": "string",
7212 "description": "Another identifier for the inviter. Can be a number or characters."
7213 },
7214 "host_id": {
7215 "type": "string",
7216 "description": "The user ID of the session host."
7217 },
7218 "participant": {
7219 "type": "object",
7220 "description": "Information about the invited user.",
7221 "required": [
7222 "invitee_name",
7223 "phone_number",
7224 "from_number"
7225 ],
7226 "properties": {
7227 "invitee_name": {
7228 "type": "string",
7229 "description": "The user's name to display in the session."
7230 },
7231 "phone_number": {
7232 "type": "integer",
7233 "format": "int64",
7234 "description": "The user's phone number."
7235 },
7236 "from_number": {
7237 "type": "integer",
7238 "format": "int64",
7239 "description": "The number used to call out to the invited user."
7240 }
7241 },
7242 "additionalProperties": false
7243 }
7244 },
7245 "additionalProperties": false
7246 }
7247 },
7248 "additionalProperties": false
7249 }
7250 },
7251 "additionalProperties": false
7252 },
7253 "examples": {
7254 "json-example": {
7255 "summary": "JSON example",
7256 "value": "{\n \"event\": \"session.user_phone_callout_rejected\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
7257 }
7258 }
7259 }
7260 }
7261 },
7262 "responses": {
7263 "200": {
7264 "content": {
7265 "application/json": {
7266 "schema": {
7267 "type": "object",
7268 "required": ["event", "event_ts", "payload"],
7269 "properties": {
7270 "event": {
7271 "type": "string",
7272 "description": "The name of the event."
7273 },
7274 "event_ts": {
7275 "type": "integer",
7276 "format": "int64",
7277 "description": "A timestamp at which the event occurred."
7278 },
7279 "payload": {
7280 "type": "object",
7281 "required": ["account_id", "object"],
7282 "properties": {
7283 "account_id": {
7284 "type": "string",
7285 "description": "The account ID of the session host."
7286 },
7287 "object": {
7288 "type": "object",
7289 "description": "Information about the session.",
7290 "required": [
7291 "session_id",
7292 "session_name",
7293 "session_key",
7294 "user_key",
7295 "host_id",
7296 "participant"
7297 ],
7298 "properties": {
7299 "id": {
7300 "type": "integer",
7301 "format": "int64",
7302 "description": "The session ID.",
7303 "deprecated": true
7304 },
7305 "uuid": {
7306 "type": "string",
7307 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
7308 "deprecated": true
7309 },
7310 "session_id": {
7311 "type": "string",
7312 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7313 },
7314 "session_name": {
7315 "type": "string",
7316 "description": "Session name."
7317 },
7318 "session_key": {
7319 "type": "string",
7320 "description": "The Video SDK custom session ID."
7321 },
7322 "user_key": {
7323 "type": "string",
7324 "description": "Another identifier for the inviter. Can be a number or characters."
7325 },
7326 "host_id": {
7327 "type": "string",
7328 "description": "The user ID of the session host."
7329 },
7330 "participant": {
7331 "type": "object",
7332 "description": "Information about the invited user.",
7333 "required": [
7334 "invitee_name",
7335 "phone_number",
7336 "from_number"
7337 ],
7338 "properties": {
7339 "invitee_name": {
7340 "type": "string",
7341 "description": "The user's name to display in the session."
7342 },
7343 "phone_number": {
7344 "type": "integer",
7345 "format": "int64",
7346 "description": "The user's phone number."
7347 },
7348 "from_number": {
7349 "type": "integer",
7350 "format": "int64",
7351 "description": "The number used to call out to the invited user."
7352 }
7353 },
7354 "additionalProperties": false
7355 }
7356 },
7357 "additionalProperties": false
7358 }
7359 },
7360 "additionalProperties": false
7361 }
7362 },
7363 "additionalProperties": false
7364 },
7365 "examples": {
7366 "json-example": {
7367 "summary": "JSON example",
7368 "value": "{\n \"event\": \"session.user_phone_callout_rejected\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"session_key\": \"ABC36jaBI145\",\n \"user_key\": \"ASD74dfDI854\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"participant\": {\n \"invitee_name\": \"Jill Chill\",\n \"phone_number\": 15555550100,\n \"from_number\": 13167900000\n }\n }\n }\n}"
7369 }
7370 }
7371 }
7372 }
7373 }
7374 }
7375 }
7376 },
7377 "session.user_room_system_callout_accepted": {
7378 "post": {
7379 "tags": ["session"],
7380 "operationId": "session.user_room_system_callout_accepted",
7381 "requestBody": {
7382 "description": "# session.user_room_system_callout_accepted\n\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\n\n**Event type**: `session.user_room_system_callout_accepted`\n",
7383 "content": {
7384 "application/json": {
7385 "schema": {
7386 "type": "object",
7387 "required": ["event", "event_ts", "payload"],
7388 "properties": {
7389 "event": {
7390 "type": "string",
7391 "description": "The name of the event."
7392 },
7393 "event_ts": {
7394 "type": "integer",
7395 "format": "int64",
7396 "description": "A timestamp at which the event occurred."
7397 },
7398 "payload": {
7399 "type": "object",
7400 "required": ["account_id", "object"],
7401 "properties": {
7402 "account_id": {
7403 "type": "string",
7404 "description": "The account ID of the session host."
7405 },
7406 "object": {
7407 "type": "object",
7408 "description": "Information about the session.",
7409 "required": [
7410 "session_id",
7411 "session_name",
7412 "host_id",
7413 "message_id",
7414 "inviter_name",
7415 "participant"
7416 ],
7417 "properties": {
7418 "id": {
7419 "type": "integer",
7420 "format": "int64",
7421 "description": "The session ID.",
7422 "deprecated": true
7423 },
7424 "uuid": {
7425 "type": "string",
7426 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
7427 "deprecated": true
7428 },
7429 "session_id": {
7430 "type": "string",
7431 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7432 },
7433 "session_name": {
7434 "type": "string",
7435 "description": "Session name."
7436 },
7437 "host_id": {
7438 "type": "string",
7439 "description": "The user ID of the session host."
7440 },
7441 "message_id": {
7442 "type": "string",
7443 "description": "The request unique identifier (UUID)."
7444 },
7445 "inviter_name": {
7446 "type": "string",
7447 "description": "The user name of the event's trigger."
7448 },
7449 "participant": {
7450 "type": "object",
7451 "description": "Information about the invited participant.",
7452 "required": ["call_type", "device_ip"],
7453 "properties": {
7454 "call_type": {
7455 "type": "string",
7456 "description": "The type of call out. Use a value of h323 or sip."
7457 },
7458 "device_ip": {
7459 "type": "string",
7460 "description": "The user's device IP address."
7461 }
7462 },
7463 "additionalProperties": true
7464 }
7465 },
7466 "additionalProperties": false
7467 }
7468 },
7469 "additionalProperties": false
7470 }
7471 },
7472 "additionalProperties": false
7473 },
7474 "examples": {
7475 "json-example": {
7476 "summary": "JSON example",
7477 "value": "{\n \"event\": \"session.user_room_system_callout_accepted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
7478 }
7479 }
7480 }
7481 }
7482 },
7483 "responses": {
7484 "200": {
7485 "content": {
7486 "application/json": {
7487 "schema": {
7488 "type": "object",
7489 "required": ["event", "event_ts", "payload"],
7490 "properties": {
7491 "event": {
7492 "type": "string",
7493 "description": "The name of the event."
7494 },
7495 "event_ts": {
7496 "type": "integer",
7497 "format": "int64",
7498 "description": "A timestamp at which the event occurred."
7499 },
7500 "payload": {
7501 "type": "object",
7502 "required": ["account_id", "object"],
7503 "properties": {
7504 "account_id": {
7505 "type": "string",
7506 "description": "The account ID of the session host."
7507 },
7508 "object": {
7509 "type": "object",
7510 "description": "Information about the session.",
7511 "required": [
7512 "session_id",
7513 "session_name",
7514 "host_id",
7515 "message_id",
7516 "inviter_name",
7517 "participant"
7518 ],
7519 "properties": {
7520 "id": {
7521 "type": "integer",
7522 "format": "int64",
7523 "description": "The session ID.",
7524 "deprecated": true
7525 },
7526 "uuid": {
7527 "type": "string",
7528 "description": "The session's universally unique identifier (UUID). Each session instance generates a session UUID.",
7529 "deprecated": true
7530 },
7531 "session_id": {
7532 "type": "string",
7533 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7534 },
7535 "session_name": {
7536 "type": "string",
7537 "description": "Session name."
7538 },
7539 "host_id": {
7540 "type": "string",
7541 "description": "The user ID of the session host."
7542 },
7543 "message_id": {
7544 "type": "string",
7545 "description": "The request unique identifier (UUID)."
7546 },
7547 "inviter_name": {
7548 "type": "string",
7549 "description": "The user name of the event's trigger."
7550 },
7551 "participant": {
7552 "type": "object",
7553 "description": "Information about the invited participant.",
7554 "required": ["call_type", "device_ip"],
7555 "properties": {
7556 "call_type": {
7557 "type": "string",
7558 "description": "The type of call out. Use a value of h323 or sip."
7559 },
7560 "device_ip": {
7561 "type": "string",
7562 "description": "The user's device IP address."
7563 }
7564 },
7565 "additionalProperties": true
7566 }
7567 },
7568 "additionalProperties": false
7569 }
7570 },
7571 "additionalProperties": false
7572 }
7573 },
7574 "additionalProperties": false
7575 },
7576 "examples": {
7577 "json-example": {
7578 "summary": "JSON example",
7579 "value": "{\n \"event\": \"session.user_room_system_callout_accepted\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"dzVA4QmMQfyISoRcpFO8CA\",\n \"object\": {\n \"id\": 713592696,\n \"uuid\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_id\": \"4444AAAiAAAAAiAiAiiAii==\",\n \"session_name\": \"My Session\",\n \"host_id\": \"ICuPoX4ERtikRcKqkVxunQ\",\n \"message_id\": \"atsXxhSEQWit9t+U02HXNQ==\",\n \"inviter_name\": \"Jill Chill\",\n \"participant\": {\n \"call_type\": \"h323\",\n \"device_ip\": \"10.100.111.237\"\n }\n }\n }\n}"
7580 }
7581 }
7582 }
7583 }
7584 }
7585 }
7586 }
7587 },
7588 "session.recording_stopped": {
7589 "post": {
7590 "tags": ["session"],
7591 "operationId": "session.recording_stopped",
7592 "requestBody": {
7593 "description": "# session.recording_stopped\n---\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\n\n**Event type**: `session.recording_stopped`\n",
7594 "content": {
7595 "application/json": {
7596 "schema": {
7597 "type": "object",
7598 "required": ["event", "event_ts", "payload"],
7599 "properties": {
7600 "event": {
7601 "type": "string",
7602 "enum": ["session.recording_stopped"],
7603 "description": "The event's name."
7604 },
7605 "event_ts": {
7606 "type": "integer",
7607 "format": "int64",
7608 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
7609 },
7610 "payload": {
7611 "type": "object",
7612 "required": ["account_id", "object"],
7613 "properties": {
7614 "account_id": {
7615 "type": "string",
7616 "description": "The Video SDK account ID."
7617 },
7618 "object": {
7619 "type": "object",
7620 "description": "Information about the session. This object only returns updated properties.",
7621 "required": [
7622 "session_id",
7623 "session_name",
7624 "session_key",
7625 "start_time",
7626 "timezone",
7627 "recording_file"
7628 ],
7629 "properties": {
7630 "session_id": {
7631 "type": "string",
7632 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7633 },
7634 "session_name": {
7635 "type": "string",
7636 "description": "Session name."
7637 },
7638 "session_key": {
7639 "type": "string",
7640 "description": "The Video SDK custom session ID."
7641 },
7642 "start_time": {
7643 "type": "string",
7644 "format": "date-time",
7645 "description": "The time at which the session started."
7646 },
7647 "timezone": {
7648 "type": "string",
7649 "description": "The user's timezone."
7650 },
7651 "recording_file": {
7652 "type": "object",
7653 "properties": {
7654 "recording_start": {
7655 "type": "string",
7656 "description": "The recording start time."
7657 },
7658 "recording_end": {
7659 "type": "string",
7660 "description": "The recording end time. Response in general query."
7661 }
7662 }
7663 }
7664 },
7665 "additionalProperties": false
7666 }
7667 },
7668 "additionalProperties": false
7669 }
7670 },
7671 "additionalProperties": false
7672 },
7673 "examples": {
7674 "json-example": {
7675 "summary": "JSON example",
7676 "value": "{\n \"event\": \"session.recording_stopped\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
7677 }
7678 }
7679 }
7680 }
7681 },
7682 "responses": {
7683 "200": {
7684 "content": {
7685 "application/json": {
7686 "schema": {
7687 "type": "object",
7688 "required": ["event", "event_ts", "payload"],
7689 "properties": {
7690 "event": {
7691 "type": "string",
7692 "enum": ["session.recording_stopped"],
7693 "description": "The event's name."
7694 },
7695 "event_ts": {
7696 "type": "integer",
7697 "format": "int64",
7698 "description": "A timestamp, in milliseconds since epoch, at which the event occurred."
7699 },
7700 "payload": {
7701 "type": "object",
7702 "required": ["account_id", "object"],
7703 "properties": {
7704 "account_id": {
7705 "type": "string",
7706 "description": "The Video SDK account ID."
7707 },
7708 "object": {
7709 "type": "object",
7710 "description": "Information about the session. This object only returns updated properties.",
7711 "required": [
7712 "session_id",
7713 "session_name",
7714 "session_key",
7715 "start_time",
7716 "timezone",
7717 "recording_file"
7718 ],
7719 "properties": {
7720 "session_id": {
7721 "type": "string",
7722 "description": "Unique session identifier. Each instance of the session will have its own session_id."
7723 },
7724 "session_name": {
7725 "type": "string",
7726 "description": "Session name."
7727 },
7728 "session_key": {
7729 "type": "string",
7730 "description": "The Video SDK custom session ID."
7731 },
7732 "start_time": {
7733 "type": "string",
7734 "format": "date-time",
7735 "description": "The time at which the session started."
7736 },
7737 "timezone": {
7738 "type": "string",
7739 "description": "The user's timezone."
7740 },
7741 "recording_file": {
7742 "type": "object",
7743 "properties": {
7744 "recording_start": {
7745 "type": "string",
7746 "description": "The recording start time."
7747 },
7748 "recording_end": {
7749 "type": "string",
7750 "description": "The recording end time. Response in general query."
7751 }
7752 }
7753 }
7754 },
7755 "additionalProperties": false
7756 }
7757 },
7758 "additionalProperties": false
7759 }
7760 },
7761 "additionalProperties": false
7762 },
7763 "examples": {
7764 "json-example": {
7765 "summary": "JSON example",
7766 "value": "{\n \"event\": \"session.recording_stopped\",\n \"event_ts\": 1626230691572,\n \"payload\": {\n \"account_id\": \"AAAAAABBBB\",\n \"object\": {\n \"session_id\": 1234567890,\n \"session_name\": \"My Personal Recording\",\n \"session_key\": \"ABC36jaBI145\",\n \"start_time\": \"2021-07-13T21:44:51Z\",\n \"timezone\": \"America/Los_Angeles\",\n \"recording_file\": {\n \"recording_start\": \"2021-03-23T22:14:57Z\",\n \"recording_end\": \"2021-03-23T23:15:41Z\"\n }\n }\n }\n}"
7767 }
7768 }
7769 }
7770 }
7771 }
7772 }
7773 }
7774 }
7775 }
7776}