{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.digitalsamba.com" } ], "info": { "name": "Digital Samba Embedded", "_postman_id": "3270c5b4-1fa6-4d4b-9fd6-80ce9a92b0e6", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Default room settings", "description": "\nConfiguring your room defaults.\n\nDocumentation<\/a>", "item": [ { "name": "Get default room settings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1", "query": [], "raw": "{{baseUrl}}\/api\/v1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"fc16892a-556b-4c2d-a522-82e6b3e884cc\",\n \"owner_id\": \"57670ebd-0de2-4f92-8bce-661bec142dde\",\n \"domain\": \"local\",\n \"is_locked\": false,\n \"topbar_enabled\": true,\n \"toolbar_enabled\": true,\n \"toolbar_position\": \"bottom\",\n \"toolbar_color\": \"#000000\",\n \"primary_color\": \"#3771E0\",\n \"background_color\": \"#000000\",\n \"palette_mode\": \"light\",\n \"language\": \"en\",\n \"language_selection_enabled\": true,\n \"audio_on_join_enabled\": true,\n \"video_on_join_enabled\": true,\n \"screenshare_enabled\": true,\n \"participants_list_enabled\": true,\n \"chat_enabled\": true,\n \"private_chat_enabled\": true,\n \"private_group_chat_enabled\": false,\n \"private_group_chat_name\": \"Moderators\",\n \"pin_enabled\": true,\n \"full_screen_enabled\": true,\n \"minimize_own_tile_enabled\": true,\n \"minimize_own_tile_on_join_enabled\": false,\n \"end_session_enabled\": true,\n \"e2ee_enabled\": false,\n \"layout_mode_switch_enabled\": true,\n \"simple_notifications_enabled\": true,\n \"join_screen_enabled\": true,\n \"logo_enabled\": false,\n \"custom_logo\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/fYwFJWsfpfMK2PECyW5JmXapPobecasL2bh3RndH.png\",\n \"application_logo\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/fMwFJWsfpfDc2PECyW5JmXapPobecasL2bh3RndH.png\",\n \"favicon\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/wgjrUhRrnkaLAEgrrUMvmhMRKzYUvhvc5pbCjdK1.png\",\n \"recordings_enabled\": true,\n \"recording_logo_enabled\": true,\n \"virtual_backgrounds_enabled\": true,\n \"raise_hand_enabled\": true,\n \"participant_names_in_recordings_enabled\": true,\n \"hide_tiles_in_recordings_enabled\": false,\n \"invite_participants_enabled\": true,\n \"whiteboard_enabled\": true,\n \"qa_enabled\": true,\n \"files_panel_enabled\": true,\n \"consent_message_enabled\": true,\n \"recording_consent_message_enabled\": true,\n \"consent_message_type\": \"generic\",\n \"consent_message\": \"By joining, you consent to the processing of your personal data in accordance with our [link https:\/\/www.digitalsamba.com\/redirect\/privacy-policy]Privacy Policy[\/link].\",\n \"checkbox_message\": \"Don\u2019t show this again.\",\n \"recordings_layout_mode\": \"tiled\",\n \"layout_mode_on_join\": \"tiled\",\n \"content_library_enabled\": true,\n \"library_id\": \"15bf7fba-7de2-4dbf-877c-62103cc274c4\", \n \"roles\": [\n {\n \"id\": \"76bb6199-2900-4b8d-b1bf-351dec4a8db4\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"allow_private_group_chat\": false\n }, \n {\n \"id\": \"768db499-8db4-351d-4b8d-351dec4a8db4\",\n \"name\": \"speaker\",\n \"display_name\": \"Speakers\",\n \"allow_private_group_chat\": false\n } \n ],\n \"default_role\": {\n \"id\": \"76bb6199-2900-4b8d-b1bf-351dec4a8db4\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\"\n },\n \"custom_cname\": null,\n \"captions_enabled\": false,\n \"captions_in_recordings_enabled\": false,\n \"captions_language\": \"en\",\n \"max_participants\": 100,\n \"max_sessions\": 5,\n \"session_length\": 90,\n \"html_title\": \"My Title\",\n \"subscription_start\": \"2024-04-17 00:00:00\",\n \"subscription_end\": \"2024-05-16 23:59:59\"\n}", "name": "" } ] }, { "name": "Update default room settings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1", "query": [], "raw": "{{baseUrl}}\/api\/v1" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"doloribus\",\"default_role\":\"moderator\",\"roles\":[\"moderator\"],\"is_locked\":false,\"session_length\":90,\"topbar_enabled\":true,\"pip_enabled\":true,\"auto_pip_enabled\":true,\"toolbar_enabled\":true,\"toolbar_position\":\"bottom\",\"toolbar_color\":\"#000000\",\"primary_color\":\"#3771E0\",\"background_color\":\"#000000\",\"palette_mode\":\"light\",\"language\":\"en\",\"languages\":[\"en\",\"es-ES\"],\"language_selection_enabled\":true,\"room_reactions_enabled\":true,\"chat_reactions_enabled\":true,\"chat_reactions_extended_enabled\":false,\"audio_on_join_enabled\":true,\"video_on_join_enabled\":true,\"hd_video_on_join_enabled\":false,\"hd_video_quality\":\"720_2.5\",\"audio_quality\":\"32\",\"audio_autogain_enabled\":true,\"audio_noise_suppression_enabled\":true,\"audio_echo_cancellation_enabled\":true,\"mute_sound_enabled\":false,\"participants_list_enabled\":true,\"pin_enabled\":true,\"full_screen_enabled\":true,\"minimize_own_tile_enabled\":true,\"minimize_own_tile_on_join_enabled\":false,\"end_session_enabled\":true,\"leave_session_enabled\":true,\"rejoin_session_enabled\":true,\"connection_message_enabled\":true,\"connection_quality_indicator_enabled\":false,\"pin_panels_enabled\":false,\"chat_enabled\":true,\"private_chat_enabled\":true,\"private_group_chat_enabled\":false,\"private_group_chat_name\":\"Presenters\",\"private_group_chat_roles\":[\"moderator\"],\"chat_persistence_enabled\":false,\"e2ee_enabled\":false,\"e2ee_badge_enabled\":true,\"layout_mode_switch_enabled\":true,\"simple_notifications_enabled\":true,\"join_screen_enabled\":true,\"screenshare_enabled\":true,\"recordings_enabled\":true,\"recording_autostart_enabled\":false,\"recording_bookmarks_enabled\":false,\"recording_breakout_autostart_enabled\":false,\"logo_enabled\":true,\"custom_logo\":\"autem\",\"application_logo\":\"ea\",\"favicon\":\"illo\",\"recording_logo_enabled\":true,\"virtual_backgrounds_enabled\":true,\"virtual_backgrounds_v2_enabled\":false,\"raise_hand_enabled\":true,\"participant_names_in_recordings_enabled\":true,\"hide_tiles_in_recordings_enabled\":false,\"invite_participants_enabled\":true,\"invite_participants_advanced_enabled\":false,\"whiteboard_enabled\":true,\"qa_enabled\":true,\"qa_default_filter\":\"all\",\"upvote_qa_enabled\":true,\"shared_notes_enabled\":true,\"polls_enabled\":true,\"watermark_enabled\":false,\"watermark_text\":\"Confidential\",\"consent_message_enabled\":true,\"recording_consent_message_enabled\":true,\"consent_message_type\":\"generic\",\"consent_message\":\"By joining, you consent to the processing of your personal data in accordance with our [link https:\\\/\\\/www.digitalsamba.com\\\/redirect\\\/privacy-policy]Privacy Policy[\\\/link].\",\"checkbox_message\":\"Don\u2019t show this again.\",\"recordings_layout_mode\":\"tiled\",\"layout_mode_on_join\":\"tiled\",\"html_title\":\"My room\",\"lobby_message\":\"You are in the session lobby\",\"lobby_sound_enabled\":false,\"content_library_enabled\":true,\"default_content_library\":\"room\",\"library_id\":\"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\"transcription_enabled\":false,\"transcription_auto_start_enabled\":true,\"captions_enabled\":false,\"captions_language\":\"en\",\"captions_in_recordings_enabled\":false}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"fc16892a-556b-4c2d-a522-82e6b3e884cc\",\n \"owner_id\": \"57670ebd-0de2-4f92-8bce-661bec142dde\",\n \"domain\": \"local\",\n \"is_locked\": false,\n \"topbar_enabled\": true,\n \"toolbar_enabled\": true,\n \"toolbar_position\": \"bottom\",\n \"toolbar_color\": \"#000000\",\n \"primary_color\": \"#3771E0\",\n \"background_color\": \"#000000\",\n \"palette_mode\": \"light\",\n \"language\": \"en\",\n \"language_selection_enabled\": true,\n \"audio_on_join_enabled\": true,\n \"video_on_join_enabled\": true,\n \"screenshare_enabled\": true,\n \"participants_list_enabled\": true,\n \"chat_enabled\": true,\n \"private_chat_enabled\": true,\n \"private_group_chat_enabled\": false,\n \"private_group_chat_name\": \"Moderators\",\n \"pin_enabled\": true,\n \"full_screen_enabled\": true,\n \"minimize_own_tile_enabled\": true,\n \"minimize_own_tile_on_join_enabled\": false,\n \"end_session_enabled\": true,\n \"e2ee_enabled\": false,\n \"layout_mode_switch_enabled\": true,\n \"simple_notifications_enabled\": true,\n \"join_screen_enabled\": true,\n \"logo_enabled\": false,\n \"custom_logo\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/fYwFJWsfpfMK2PECyW5JmXapPobecasL2bh3RndH.png\",\n \"application_logo\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/fMwFJWsfpfDc2PECyW5JmXapPobecasL2bh3RndH.png\",\n \"favicon\": \"https:\/\/storage.dev.monza.wbcnf.net\/images\/wgjrUhRrnkaLAEgrrUMvmhMRKzYUvhvc5pbCjdK1.png\",\n \"recordings_enabled\": true,\n \"recording_logo_enabled\": true,\n \"virtual_backgrounds_enabled\": true,\n \"raise_hand_enabled\": true,\n \"participant_names_in_recordings_enabled\": true,\n \"hide_tiles_in_recordings_enabled\": false,\n \"invite_participants_enabled\": true,\n \"whiteboard_enabled\": true,\n \"qa_enabled\": true,\n \"files_panel_enabled\": true,\n \"consent_message_enabled\": true,\n \"recording_consent_message_enabled\": true,\n \"consent_message_type\": \"generic\",\n \"consent_message\": \"By joining, you consent to the processing of your personal data in accordance with our [link https:\/\/www.digitalsamba.com\/redirect\/privacy-policy]Privacy Policy[\/link].\",\n \"checkbox_message\": \"Don\u2019t show this again.\",\n \"recordings_layout_mode\": \"tiled\",\n \"layout_mode_on_join\": \"tiled\",\n \"content_library_enabled\": true,\n \"library_id\": \"15bf7fba-7de2-4dbf-877c-62103cc274c4\", \n \"roles\": [\n {\n \"id\": \"76bb6199-2900-4b8d-b1bf-351dec4a8db4\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"allow_private_group_chat\": false\n }, \n {\n \"id\": \"768db499-8db4-351d-4b8d-351dec4a8db4\",\n \"name\": \"speaker\",\n \"display_name\": \"Speakers\",\n \"allow_private_group_chat\": false\n } \n ],\n \"default_role\": {\n \"id\": \"76bb6199-2900-4b8d-b1bf-351dec4a8db4\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\"\n },\n \"custom_cname\": null,\n \"captions_enabled\": false,\n \"captions_in_recordings_enabled\": false,\n \"captions_language\": \"en\",\n \"max_participants\": 100,\n \"max_sessions\": 5,\n \"session_length\": 90,\n \"html_title\": \"My Title\",\n \"subscription_start\": \"2024-04-17 00:00:00\",\n \"subscription_end\": \"2024-05-16 23:59:59\"\n}", "name": "" } ] } ] }, { "name": "Rooms", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get chat messages.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/chat", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the session.", "disabled": false }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the chat message after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/chat?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&limit=20&offset=0&order=asc&after=", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 3,\n \"data\": [\n {\n \"id\": \"3d8a123d-1a65-4b8b-a1d7-cde0578bf928\",\n \"message\": \"Morning. How are you?\",\n \"participant_id\": \"5e54e7e0-2639-4307-aafa-9eb957e20c2d\",\n \"external_participant_id\": \"#123\",\n \"participant_name\": \"John Smith\",\n \"created_at\": \"2024-02-13T16:45:05.000000Z\"\n },\n {\n \"id\": \"98255fe2-8e3f-4195-9771-8144c484d191\",\n \"message\": \"I am fine, thanks! What about you?\",\n \"participant_id\": \"685dacb3-5943-4661-a37d-d218586b8b6d\",\n \"external_participant_id\": \"#456\",\n \"participant_name\": \"Jane Doe\",\n \"created_at\": \"2024-02-13T16:45:10.000000Z\"\n },\n {\n \"id\": \"3d8a123d-1a65-4b8b-a1d7-cde0578bf928\", \n \"breakout_id\": \"79e54583-3aad-4023-a2fa-968125e6c816\",\n \"message\": \"In breakout #2\",\n \"participant_id\": \"5e54e7e0-2639-4307-aafa-9eb957e20c2d\",\n \"external_participant_id\": \"ABCDEF123\",\n \"participant_name\": \"John Smith\",\n \"created_at\": \"2024-02-13T16:45:20.000000Z\"\n }\n ]\n}", "name": "" } ] }, { "name": "Export chat messages.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/chat\/export", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the Session.", "disabled": false }, { "key": "format", "value": "txt", "description": "Export format (txt, json, csv, or zip \u2014 archive with csv and txt).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/chat\/export?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&format=txt", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"de\",\"lang\":\"en\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "Text file - Chat messages", "name": "" } ] }, { "name": "Send chat message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/chat", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/chat", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"message\":\"Hello!\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=ZLRQ6cZ3U0EiytrRNSvA36RbMcwppgBtRuX1lP3W; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=rAzv99oTrtTKzUWu5jgCieVKq3OGyt0n2fx6Ct8R; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Export questions and answers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/export", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the Session.", "disabled": false }, { "key": "format", "value": "txt", "description": "Export format (txt or json).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/export?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&format=txt", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"it\",\"lang\":\"de\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "Text file - Questions and answers", "name": "" } ] }, { "name": "Get room transcripts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/transcripts", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the session.", "disabled": false }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/transcripts?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&limit=20&offset=0&order=asc", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 3,\n \"data\": [\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"participant_name\": \"John Smith\",\n \"transcript\": \"Morning. How are you?\",\n \"start_time\": \"2024-04-10T12:18:27Z\",\n \"end_time\": \"2024-04-10T12:33:27Z\"\n },\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"participant_name\": \"Jane Doe\",\n \"transcript\": \"I am fine, thanks! What about you?\",\n \"start_time\": \"2024-04-10T12:10:27Z\",\n \"end_time\": \"2024-04-10T12:31:27Z\"\n },\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\", \n \"participant_name\": \"John Doe\",\n \"transcript\": \"Hi all!\",\n \"start_time\": \"2024-04-10T12:06:27Z\",\n \"end_time\": \"2024-04-10T12:33:27Z\"\n }\n ]\n} ", "name": "" } ] }, { "name": "Export room transcripts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/transcripts\/export", "query": [ { "key": "format", "value": "txt", "description": "Export format (txt or json).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/transcripts\/export?format=txt", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"es\",\"lang\":\"de\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "Text file - Transcripts", "name": "" } ] }, { "name": "Create room token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/token", "variable": [ { "id": "room", "key": "room", "value": "w", "description": "The room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ud\":\"EXTID123\",\"u\":\"John\",\"initials\":\"JD\",\"role\":\"moderator\",\"breakoutId\":\"16719c1b-cc82-4dfe-9f6f-40d9093fa695\",\"nbf\":1763723976,\"exp\":1763783000}" }, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1ZCI6IkVYVDEyMzQiLCJ1IjoiTW9oYW1tZWQiLCJyZCI6IjIwYjI3OGJkLTYzNTEtM2IyYy05MWQwLWVhOGRhYzJhZTRiZiIsInRkIjoiZGJiNzgwMmMtYWZmMi00Y2M0LWFmODAtMTcxMTIzZGRmNzU3Iiwicm9sZSI6Im1vZGVyYXRvciIsImluaXRpYWxzIjoiSkQiLCJpYXQiOjE3MzM4MDgxMjR9.IBVB_O1uIJmLzrUUje7pMyfWWFVRsq-NSxkDeXIPNI\",\n \"link\": \"https:\/\/username.digitalsamba.com\/myRoom?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1ZCI6IkVYVDEyMzQiLCJ1IjoiTW9oYW1tZWQiLCJyZCI6IjIwYjI3OGJkLTYzNTEtM2IyYy05MWQwLWVhOGRhYzJhZTRiZiIsInRkIjoiZGJiNzgwMmMtYWZmMi00Y2M0LWFmODAtMTcxMTIzZGRmNzU3Iiwicm9sZSI6Im1vZGVyYXRvciIsImluaXRpYWxzIjoiSkQiLCJpYXQiOjE3MzM4MDgxMjR9.IBVB_O1uIJmLzrUUje7pMyfWWFVRsq-NSxkDeXIPNI\"\n}", "name": "" } ] }, { "name": "Delete chats by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/chat", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/chat", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete Q&A by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete summaries by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/summaries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/summaries", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete transcripts by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/transcripts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/transcripts", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete polls by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete quizzes by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete recordings by room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/recordings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/recordings", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Get all team rooms.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "tag", "value": "tag1%2Ctag2%2Ctag3+or+tag%5B%5D%3Dtag1%26tag%3Dtag2%26tag%5B%5D%3Dtag3", "description": "string|array Filter rooms by tags.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms?limit=20&offset=0&order=asc&after=&tag=tag1%2Ctag2%2Ctag3+or+tag%5B%5D%3Dtag1%26tag%3Dtag2%26tag%5B%5D%3Dtag3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"d0a02e9e-ac08-3d8d-9dad-f66ae43d5286\",\"description\":\"Ut nesciunt aut aut.\",\"topic\":\"Ut nesciunt aut aut.\",\"friendly_url\":\"9aSS4sXd6LNtzyGKWc_XGQhlLB7CO0Hr\",\"privacy\":\"public\",\"max_participants\":100,\"max_broadcasters\":100,\"topbar_enabled\":true,\"pip_enabled\":true,\"auto_pip_enabled\":true,\"room_reactions_enabled\":true,\"toolbar_enabled\":true,\"toolbar_position\":\"bottom\",\"toolbar_color\":\"#000000\",\"primary_color\":\"#3771E0\",\"background_color\":\"#000000\",\"palette_mode\":\"light\",\"language\":\"en\",\"languages\":[\"ar-SA\",\"ca-ES\",\"de-DE\",\"en\",\"es-ES\",\"fr-FR\",\"it-IT\",\"nb-NO\",\"nl-NL\",\"pt-PT\",\"ro-RO\",\"sv-SE\",\"zh-CN\",\"zh-TW\"],\"language_selection_enabled\":true,\"audio_on_join_enabled\":true,\"video_on_join_enabled\":true,\"hd_video_quality\":\"720_1.5\",\"audio_quality\":\"32\",\"audio_autogain_enabled\":true,\"audio_noise_suppression_enabled\":true,\"audio_echo_cancellation_enabled\":true,\"screenshare_enabled\":true,\"participants_list_enabled\":true,\"logo_enabled\":true,\"virtual_backgrounds_enabled\":true,\"raise_hand_enabled\":true,\"chat_enabled\":true,\"private_chat_enabled\":true,\"chat_reactions_enabled\":true,\"pin_enabled\":true,\"full_screen_enabled\":true,\"minimize_own_tile_enabled\":true,\"broadcaster_tile_visibility\":\"all\",\"end_session_enabled\":true,\"leave_session_enabled\":true,\"rejoin_session_enabled\":true,\"connection_message_enabled\":true,\"layout_mode_switch_enabled\":true,\"simple_notifications_enabled\":true,\"join_screen_enabled\":true,\"participant_names_in_recordings_enabled\":true,\"invite_participants_enabled\":true,\"whiteboard_enabled\":true,\"qa_enabled\":true,\"upvote_qa_enabled\":true,\"shared_notes_enabled\":true,\"polls_enabled\":true,\"content_library_enabled\":true,\"default_content_library\":\"room\",\"consent_message_enabled\":true,\"recording_consent_message_enabled\":true,\"consent_message_type\":\"generic\",\"recordings_layout_mode\":\"tiled\",\"layout_mode_on_join\":\"tiled\",\"room_url\":\"https:\\\/\\\/2b54c5caa877b4c0208533b121d0fd7b.digitalsamba.com\\\/9aSS4sXd6LNtzyGKWc_XGQhlLB7CO0Hr\",\"external_id\":\"EXTID2063803455\",\"transcription_auto_start_enabled\":true,\"captions_language\":\"en\",\"created_at\":\"2026-05-08T14:36:56Z\",\"updated_at\":\"2026-05-08T14:36:56Z\"},{\"id\":\"f73ac22f-bb71-3b95-9681-71f5217630c9\",\"description\":\"Voluptas illum.\",\"topic\":\"Voluptas illum.\",\"friendly_url\":\"gYJSWGiLgCQI2bqoz3OxBmg_nkQUj8dr\",\"privacy\":\"public\",\"max_participants\":100,\"max_broadcasters\":100,\"topbar_enabled\":true,\"pip_enabled\":true,\"auto_pip_enabled\":true,\"room_reactions_enabled\":true,\"toolbar_enabled\":true,\"toolbar_position\":\"bottom\",\"toolbar_color\":\"#000000\",\"primary_color\":\"#3771E0\",\"background_color\":\"#000000\",\"palette_mode\":\"light\",\"language\":\"en\",\"languages\":[\"ar-SA\",\"ca-ES\",\"de-DE\",\"en\",\"es-ES\",\"fr-FR\",\"it-IT\",\"nb-NO\",\"nl-NL\",\"pt-PT\",\"ro-RO\",\"sv-SE\",\"zh-CN\",\"zh-TW\"],\"language_selection_enabled\":true,\"audio_on_join_enabled\":true,\"video_on_join_enabled\":true,\"hd_video_quality\":\"720_1.5\",\"audio_quality\":\"32\",\"audio_autogain_enabled\":true,\"audio_noise_suppression_enabled\":true,\"audio_echo_cancellation_enabled\":true,\"screenshare_enabled\":true,\"participants_list_enabled\":true,\"logo_enabled\":true,\"virtual_backgrounds_enabled\":true,\"raise_hand_enabled\":true,\"chat_enabled\":true,\"private_chat_enabled\":true,\"chat_reactions_enabled\":true,\"pin_enabled\":true,\"full_screen_enabled\":true,\"minimize_own_tile_enabled\":true,\"broadcaster_tile_visibility\":\"all\",\"end_session_enabled\":true,\"leave_session_enabled\":true,\"rejoin_session_enabled\":true,\"connection_message_enabled\":true,\"layout_mode_switch_enabled\":true,\"simple_notifications_enabled\":true,\"join_screen_enabled\":true,\"participant_names_in_recordings_enabled\":true,\"invite_participants_enabled\":true,\"whiteboard_enabled\":true,\"qa_enabled\":true,\"upvote_qa_enabled\":true,\"shared_notes_enabled\":true,\"polls_enabled\":true,\"content_library_enabled\":true,\"default_content_library\":\"room\",\"consent_message_enabled\":true,\"recording_consent_message_enabled\":true,\"consent_message_type\":\"generic\",\"recordings_layout_mode\":\"tiled\",\"layout_mode_on_join\":\"tiled\",\"room_url\":\"https:\\\/\\\/503e43b7477703fcd4b2eefbe487ff1f.digitalsamba.com\\\/gYJSWGiLgCQI2bqoz3OxBmg_nkQUj8dr\",\"external_id\":\"EXTID1629256123\",\"transcription_auto_start_enabled\":true,\"captions_language\":\"en\",\"created_at\":\"2026-05-08T14:36:56Z\",\"updated_at\":\"2026-05-08T14:36:56Z\"}],\"total_count\":\"2\"}", "name": "" } ] }, { "name": "Get the specified room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"description\": \"My public room description.\", \n \"friendly_url\": \"MyPublicRoom\",\n \"privacy\": \"public\",\n \"max_participants\": 100,\n \"max_broadcasters\": 10,\n \"is_locked\": false,\n \"topbar_enabled\": true,\n \"toolbar_enabled\": true,\n \"toolbar_position\": \"left\",\n \"toolbar_color\": \"#000000\",\n \"primary_color\": \"#3771E0\",\n \"background_color\": \"#000000\",\n \"palette_mode\": \"light\",\n \"language\": \"en\",\n \"language_selection_enabled\": true,\n \"audio_on_join_enabled\": true,\n \"video_on_join_enabled\": true,\n \"screenshare_enabled\": true,\n \"participants_list_enabled\": true,\n \"recordings_enabled\": true,\n \"logo_enabled\": true,\n \"custom_logo\": null,\n \"recording_logo_enabled\": false,\n \"virtual_backgrounds_enabled\": true,\n \"raise_hand_enabled\": true,\n \"chat_enabled\": true,\n \"private_chat_enabled\": true,\n \"private_group_chat_enabled\": true,\n \"private_group_chat_name\": \"test\",\n \"pin_enabled\": true,\n \"full_screen_enabled\": true,\n \"minimize_own_tile_enabled\": true,\n \"minimize_own_tile_on_join_enabled\": false,\n \"end_session_enabled\": true,\n \"e2ee_enabled\": false,\n \"layout_mode_switch_enabled\": true,\n \"simple_notifications_enabled\": true,\n \"join_screen_enabled\": true,\n \"participant_names_in_recordings_enabled\": false,\n \"hide_tiles_in_recordings_enabled\": false,\n \"invite_participants_enabled\": true,\n \"whiteboard_enabled\": true,\n \"qa_enabled\": true,\n \"files_panel_enabled\": true,\n \"consent_message_enabled\": true,\n \"recording_consent_message_enabled\": true,\n \"consent_message_type\": \"generic\",\n \"consent_message\": \"By joining, you consent to the processing of your personal data in accordance with our [link https:\/\/www.digitalsamba.com\/redirect\/privacy-policy]Privacy Policy[\/link].\",\n \"checkbox_message\": \"Don\u2019t show this again.\",\n \"recordings_layout_mode\": \"tiled\",\n \"content_library_enabled\": true,\n \"library_id\": \"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\n \"layout_mode_on_join\": \"tiled\",\n \"room_url\": \"https:\/\/myteam.digitalsamba.com\/MyPublicRoom\",\n \"external_id\": \"EXTID123\",\n \"default_role\": {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\"\n },\n \"roles\": [\n {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"allow_private_group_chat\": true\n },\n {\n \"id\": \"4fae2627-3d52-4b01-905f-5022b285ee8c\",\n \"name\": \"attendee\",\n \"display_name\": \"Attendees\",\n \"allow_private_group_chat\": false\n }\n ],\n \"files\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"image.png\",\n \"url\": \"https:\/\/www.myimages.com\/image.png\",\n \"thumbnail_url\": \"https:\/\/www.myimages.com\/image-thumbnail.png\"\n }\n ],\n \"webhooks\": [\n \"3d5260b1-741e-4d0d-4a00-e5ad2c1dd74f\", \n \"77ea623b-741e-4d0d-acd9-32d98793e168\"\n ],\n \"breakout_rooms_enabled\": true,\n \"breakouts\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"Breakout Room 1\"\n },\n {\n \"id\": \"77ea623b-f677-4a00-8307-ec19aa022d22\",\n \"name\": \"Breakout Room 2\"\n },\n {\n \"id\": \"6cc45935-f00c-4683-9f14-32d98793e168\",\n \"name\": \"Breakout Room 3\"\n }\n ],\n \"html_title\": \"MyPublicRoom custom HTML title\",\n \"transcription_enabled\": false,\n \"captions_enabled\": true,\n \"captions_in_recordings_enabled\": false,\n \"captions_language\": \"en\",\n \"created_at\": \"2022-05-13T19:09:04Z\",\n \"updated_at\": \"2024-03-28T00:43:42Z\"\n}", "name": "" } ] }, { "name": "Create a new room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"My public room description.\",\"friendly_url\":\"MyPublicRoom\",\"privacy\":\"public\",\"external_id\":\"myExtID123\",\"default_role\":\"moderator\",\"roles\":[\"moderator\"],\"webhooks\":[\"c83c7b87-b9b8-444d-a749-7076fe58fdb8\"],\"tags\":[\"Tag1\",\"Tag2\"],\"is_locked\":false,\"is_audio_only\":false,\"topbar_enabled\":true,\"pip_enabled\":true,\"auto_pip_enabled\":true,\"toolbar_enabled\":true,\"toolbar_position\":\"bottom\",\"toolbar_color\":\"#000000\",\"primary_color\":\"#3771E0\",\"background_color\":\"#000000\",\"palette_mode\":\"light\",\"language\":\"en\",\"languages\":[\"en\",\"es-ES\"],\"language_selection_enabled\":true,\"room_reactions_enabled\":true,\"audio_on_join_enabled\":true,\"video_on_join_enabled\":true,\"hd_video_on_join_enabled\":false,\"hd_video_quality\":\"720_2.5\",\"audio_quality\":\"32\",\"audio_autogain_enabled\":true,\"audio_noise_suppression_enabled\":true,\"audio_echo_cancellation_enabled\":true,\"mute_sound_enabled\":false,\"participants_list_enabled\":true,\"pin_enabled\":true,\"full_screen_enabled\":true,\"minimize_own_tile_enabled\":true,\"minimize_own_tile_on_join_enabled\":false,\"broadcaster_tile_visibility\":\"all\",\"end_session_enabled\":true,\"leave_session_enabled\":true,\"rejoin_session_enabled\":true,\"connection_message_enabled\":true,\"connection_quality_indicator_enabled\":false,\"pin_panels_enabled\":false,\"breakout_rooms_enabled\":false,\"breakouts\":null,\"breakout_free_movement_enabled\":false,\"breakout_return_to_main_room_enabled\":true,\"breakout_timer_enabled\":false,\"breakout_timer_duration\":30,\"breakout_end_on_timer\":true,\"chat_enabled\":true,\"private_chat_enabled\":true,\"private_group_chat_enabled\":false,\"private_group_chat_name\":\"Presenters\",\"chat_persistence_enabled\":false,\"chat_reactions_enabled\":true,\"chat_reactions_extended_enabled\":false,\"private_group_chat_roles\":[\"moderator\"],\"e2ee_enabled\":false,\"e2ee_badge_enabled\":true,\"layout_mode_switch_enabled\":true,\"simple_notifications_enabled\":true,\"join_screen_enabled\":true,\"screenshare_enabled\":true,\"recordings_enabled\":true,\"recordings_layout_mode\":\"tiled\",\"hide_tiles_in_recordings_enabled\":false,\"recording_logo_enabled\":true,\"participant_names_in_recordings_enabled\":true,\"recording_autostart_enabled\":false,\"recording_bookmarks_enabled\":false,\"recording_breakout_autostart_enabled\":false,\"recording_consent_message_enabled\":true,\"captions_in_recordings_enabled\":false,\"restream_enabled\":false,\"restream_type\":\"custom\",\"restream_key\":\"550e8400-e29b-41d4-a716-446655440000\",\"restream_url\":\"rtmps:\\\/\\\/your-rtmp-server.com\\\/live\",\"restream_layout_mode\":\"tiled\",\"hide_tiles_in_restream_enabled\":false,\"restream_logo_enabled\":true,\"restream_autostart_enabled\":false,\"participant_names_in_restream_enabled\":true,\"restream_consent_message_enabled\":true,\"logo_enabled\":true,\"custom_logo\":\"quisquam\",\"application_logo\":\"consequuntur\",\"virtual_backgrounds_enabled\":true,\"virtual_backgrounds_v2_enabled\":false,\"raise_hand_enabled\":true,\"invite_participants_enabled\":true,\"invite_participants_advanced_enabled\":false,\"whiteboard_enabled\":true,\"qa_enabled\":true,\"qa_default_filter\":\"all\",\"upvote_qa_enabled\":true,\"shared_notes_enabled\":true,\"polls_enabled\":true,\"consent_message_enabled\":true,\"consent_message_type\":\"generic\",\"consent_message\":\"By joining, you consent to the processing of your personal data in accordance with our [link https:\\\/\\\/www.digitalsamba.com\\\/redirect\\\/privacy-policy]Privacy Policy[\\\/link].\",\"checkbox_message\":\"Don\u2019t show this again.\",\"layout_mode_on_join\":\"tiled\",\"max_participants\":100,\"max_broadcasters\":100,\"session_length\":90,\"html_title\":\"My room\",\"lobby_message\":\"You are in the session lobby\",\"lobby_sound_enabled\":false,\"content_library_enabled\":true,\"default_content_library\":\"room\",\"library_id\":\"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\"transcription_enabled\":false,\"transcription_auto_start_enabled\":true,\"captions_enabled\":false,\"captions_language\":\"en\",\"whip_enabled\":false,\"telephony_enabled\":false,\"telephony_phone_number\":\"+1 234 567 890.\",\"telephony_pin_dtmf\":\"123W1www2\",\"watermark_enabled\":false,\"watermark_text\":\"Confidential\",\"expires_at\":\"2024-09-05 12:30:00\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"description\": \"My public room description.\", \n \"friendly_url\": \"MyPublicRoom\",\n \"privacy\": \"public\",\n \"max_participants\": 100,\n \"max_broadcasters\": 10,\n \"is_locked\": false,\n \"topbar_enabled\": true,\n \"toolbar_enabled\": true,\n \"toolbar_position\": \"left\",\n \"toolbar_color\": \"#000000\",\n \"primary_color\": \"#3771E0\",\n \"background_color\": \"#000000\",\n \"palette_mode\": \"light\",\n \"language\": \"en\",\n \"language_selection_enabled\": true,\n \"audio_on_join_enabled\": true,\n \"video_on_join_enabled\": true,\n \"screenshare_enabled\": true,\n \"participants_list_enabled\": true,\n \"recordings_enabled\": true,\n \"logo_enabled\": true,\n \"custom_logo\": null,\n \"recording_logo_enabled\": false,\n \"virtual_backgrounds_enabled\": true,\n \"raise_hand_enabled\": true,\n \"chat_enabled\": true,\n \"private_chat_enabled\": true,\n \"private_group_chat_enabled\": true,\n \"private_group_chat_name\": \"test\",\n \"pin_enabled\": true,\n \"full_screen_enabled\": true,\n \"minimize_own_tile_enabled\": true,\n \"minimize_own_tile_on_join_enabled\": false,\n \"end_session_enabled\": true,\n \"e2ee_enabled\": false,\n \"layout_mode_switch_enabled\": true,\n \"simple_notifications_enabled\": true,\n \"join_screen_enabled\": true,\n \"participant_names_in_recordings_enabled\": false,\n \"hide_tiles_in_recordings_enabled\": false,\n \"invite_participants_enabled\": true,\n \"whiteboard_enabled\": true,\n \"qa_enabled\": true,\n \"files_panel_enabled\": true,\n \"consent_message_enabled\": true,\n \"recording_consent_message_enabled\": true,\n \"consent_message_type\": \"generic\",\n \"consent_message\": \"By joining, you consent to the processing of your personal data in accordance with our [link https:\/\/www.digitalsamba.com\/redirect\/privacy-policy]Privacy Policy[\/link].\",\n \"checkbox_message\": \"Don\u2019t show this again.\",\n \"recordings_layout_mode\": \"tiled\",\n \"content_library_enabled\": true,\n \"library_id\": \"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\n \"layout_mode_on_join\": \"tiled\",\n \"room_url\": \"https:\/\/myteam.digitalsamba.com\/MyPublicRoom\",\n \"external_id\": \"EXTID123\",\n \"default_role\": {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\"\n },\n \"roles\": [\n {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"allow_private_group_chat\": true\n },\n {\n \"id\": \"4fae2627-3d52-4b01-905f-5022b285ee8c\",\n \"name\": \"attendee\",\n \"display_name\": \"Attendees\",\n \"allow_private_group_chat\": false\n }\n ],\n \"files\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"image.png\",\n \"url\": \"https:\/\/www.myimages.com\/image.png\",\n \"thumbnail_url\": \"https:\/\/www.myimages.com\/image-thumbnail.png\"\n }\n ],\n \"webhooks\": [\n \"3d5260b1-741e-4d0d-4a00-e5ad2c1dd74f\", \n \"77ea623b-741e-4d0d-acd9-32d98793e168\"\n ],\n \"breakout_rooms_enabled\": true,\n \"breakouts\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"Breakout Room 1\"\n },\n {\n \"id\": \"77ea623b-f677-4a00-8307-ec19aa022d22\",\n \"name\": \"Breakout Room 2\"\n },\n {\n \"id\": \"6cc45935-f00c-4683-9f14-32d98793e168\",\n \"name\": \"Breakout Room 3\"\n }\n ],\n \"html_title\": \"MyPublicRoom custom HTML title\",\n \"transcription_enabled\": false,\n \"captions_enabled\": true,\n \"captions_in_recordings_enabled\": false,\n \"captions_language\": \"en\",\n \"created_at\": \"2022-05-13T19:09:04Z\",\n \"updated_at\": \"2024-03-28T00:43:42Z\"\n}", "name": "" } ] }, { "name": "Update room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"My public room description.\",\"friendly_url\":\"MyPublicRoom\",\"privacy\":\"public\",\"external_id\":\"myExtID123\",\"default_role\":\"moderator\",\"roles\":[\"moderator\"],\"webhooks\":[\"c83c7b87-b9b8-444d-a749-7076fe58fdb8\"],\"is_locked\":false,\"is_audio_only\":false,\"topbar_enabled\":true,\"pip_enabled\":true,\"auto_pip_enabled\":true,\"toolbar_enabled\":true,\"toolbar_position\":\"bottom\",\"toolbar_color\":\"#000000\",\"primary_color\":\"#3771E0\",\"background_color\":\"#000000\",\"palette_mode\":\"light\",\"language\":\"en\",\"language_selection_enabled\":true,\"room_reactions_enabled\":true,\"audio_on_join_enabled\":true,\"video_on_join_enabled\":true,\"hd_video_on_join_enabled\":false,\"hd_video_quality\":\"720_2.5\",\"audio_quality\":\"32\",\"audio_autogain_enabled\":true,\"audio_noise_suppression_enabled\":true,\"audio_echo_cancellation_enabled\":true,\"mute_sound_enabled\":false,\"participants_list_enabled\":true,\"pin_enabled\":true,\"full_screen_enabled\":true,\"minimize_own_tile_enabled\":true,\"minimize_own_tile_on_join_enabled\":false,\"broadcaster_tile_visibility\":\"all\",\"end_session_enabled\":true,\"leave_session_enabled\":true,\"rejoin_session_enabled\":true,\"connection_message_enabled\":true,\"connection_quality_indicator_enabled\":false,\"pin_panels_enabled\":false,\"breakout_rooms_enabled\":false,\"breakouts\":null,\"breakout_free_movement_enabled\":false,\"breakout_return_to_main_room_enabled\":true,\"breakout_timer_enabled\":false,\"breakout_timer_duration\":30,\"breakout_end_on_timer\":true,\"chat_enabled\":true,\"private_chat_enabled\":true,\"private_group_chat_enabled\":false,\"private_group_chat_name\":\"Presenters\",\"chat_persistence_enabled\":false,\"chat_reactions_enabled\":true,\"chat_reactions_extended_enabled\":false,\"private_group_chat_roles\":[\"moderator\"],\"e2ee_enabled\":false,\"e2ee_badge_enabled\":true,\"layout_mode_switch_enabled\":true,\"simple_notifications_enabled\":true,\"join_screen_enabled\":true,\"screenshare_enabled\":true,\"recordings_enabled\":true,\"recordings_layout_mode\":\"tiled\",\"hide_tiles_in_recordings_enabled\":false,\"recording_logo_enabled\":true,\"recording_autostart_enabled\":false,\"participant_names_in_recordings_enabled\":true,\"recording_consent_message_enabled\":true,\"recording_bookmarks_enabled\":false,\"recording_breakout_autostart_enabled\":false,\"captions_in_recordings_enabled\":false,\"restream_enabled\":false,\"restream_type\":\"custom\",\"restream_key\":\"550e8400-e29b-41d4-a716-446655440000\",\"restream_url\":\"rtmps:\\\/\\\/your-rtmp-server.com\\\/live\",\"restream_layout_mode\":\"tiled\",\"hide_tiles_in_restream_enabled\":false,\"restream_logo_enabled\":true,\"restream_autostart_enabled\":false,\"participant_names_in_restream_enabled\":true,\"restream_consent_message_enabled\":true,\"logo_enabled\":true,\"custom_logo\":\"sit\",\"application_logo\":\"quod\",\"virtual_backgrounds_enabled\":true,\"virtual_backgrounds_v2_enabled\":false,\"invite_participants_enabled\":true,\"invite_participants_advanced_enabled\":false,\"raise_hand_enabled\":true,\"whiteboard_enabled\":true,\"qa_enabled\":true,\"qa_default_filter\":\"all\",\"upvote_qa_enabled\":true,\"shared_notes_enabled\":true,\"polls_enabled\":true,\"consent_message_enabled\":true,\"consent_message_type\":\"generic\",\"consent_message\":\"By joining, you consent to the processing of your personal data in accordance with our [link https:\\\/\\\/www.digitalsamba.com\\\/redirect\\\/privacy-policy]Privacy Policy[\\\/link].\",\"checkbox_message\":\"Don\u2019t show this again.\",\"layout_mode_on_join\":\"tiled\",\"max_participants\":100,\"max_broadcasters\":100,\"session_length\":90,\"html_title\":\"My room\",\"lobby_message\":\"You are in the session lobby\",\"lobby_sound_enabled\":false,\"content_library_enabled\":true,\"default_content_library\":\"room\",\"library_id\":\"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\"transcription_enabled\":false,\"transcription_auto_start_enabled\":true,\"captions_enabled\":false,\"captions_language\":\"en\",\"whip_enabled\":false,\"telephony_enabled\":false,\"telephony_phone_number\":\"+1 234 567 890.\",\"telephony_pin_dtmf\":\"123W1www2\",\"watermark_enabled\":false,\"watermark_text\":\"Confidential\",\"expires_at\":\"2024-09-05 12:30:00\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"description\": \"My public room description.\", \n \"friendly_url\": \"MyPublicRoom\",\n \"privacy\": \"public\",\n \"max_participants\": 100,\n \"max_broadcasters\": 10,\n \"is_locked\": false,\n \"topbar_enabled\": true,\n \"toolbar_enabled\": true,\n \"toolbar_position\": \"left\",\n \"toolbar_color\": \"#000000\",\n \"primary_color\": \"#3771E0\",\n \"background_color\": \"#000000\",\n \"palette_mode\": \"light\",\n \"language\": \"en\",\n \"language_selection_enabled\": true,\n \"audio_on_join_enabled\": true,\n \"video_on_join_enabled\": true,\n \"screenshare_enabled\": true,\n \"participants_list_enabled\": true,\n \"recordings_enabled\": true,\n \"logo_enabled\": true,\n \"custom_logo\": null,\n \"recording_logo_enabled\": false,\n \"virtual_backgrounds_enabled\": true,\n \"raise_hand_enabled\": true,\n \"chat_enabled\": true,\n \"private_chat_enabled\": true,\n \"private_group_chat_enabled\": true,\n \"private_group_chat_name\": \"test\",\n \"pin_enabled\": true,\n \"full_screen_enabled\": true,\n \"minimize_own_tile_enabled\": true,\n \"minimize_own_tile_on_join_enabled\": false,\n \"end_session_enabled\": true,\n \"e2ee_enabled\": false,\n \"layout_mode_switch_enabled\": true,\n \"simple_notifications_enabled\": true,\n \"join_screen_enabled\": true,\n \"participant_names_in_recordings_enabled\": false,\n \"hide_tiles_in_recordings_enabled\": false,\n \"invite_participants_enabled\": true,\n \"whiteboard_enabled\": true,\n \"qa_enabled\": true,\n \"files_panel_enabled\": true,\n \"consent_message_enabled\": true,\n \"recording_consent_message_enabled\": true,\n \"consent_message_type\": \"generic\",\n \"consent_message\": \"By joining, you consent to the processing of your personal data in accordance with our [link https:\/\/www.digitalsamba.com\/redirect\/privacy-policy]Privacy Policy[\/link].\",\n \"checkbox_message\": \"Don\u2019t show this again.\",\n \"recordings_layout_mode\": \"tiled\",\n \"content_library_enabled\": true,\n \"library_id\": \"15bf7fba-7de2-4dbf-877c-62103cc274c4\",\n \"layout_mode_on_join\": \"tiled\",\n \"room_url\": \"https:\/\/myteam.digitalsamba.com\/MyPublicRoom\",\n \"external_id\": \"EXTID123\",\n \"default_role\": {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\"\n },\n \"roles\": [\n {\n \"id\": \"47697570-a2e8-4b0c-8f2d-1af1ea2bae67\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"allow_private_group_chat\": true\n },\n {\n \"id\": \"4fae2627-3d52-4b01-905f-5022b285ee8c\",\n \"name\": \"attendee\",\n \"display_name\": \"Attendees\",\n \"allow_private_group_chat\": false\n }\n ],\n \"files\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"image.png\",\n \"url\": \"https:\/\/www.myimages.com\/image.png\",\n \"thumbnail_url\": \"https:\/\/www.myimages.com\/image-thumbnail.png\"\n }\n ],\n \"webhooks\": [\n \"3d5260b1-741e-4d0d-4a00-e5ad2c1dd74f\", \n \"77ea623b-741e-4d0d-acd9-32d98793e168\"\n ],\n \"breakout_rooms_enabled\": true,\n \"breakouts\": [\n {\n \"id\": \"ae137edf-741e-4d0d-acd9-e5ad2c1dd74f\",\n \"name\": \"Breakout Room 1\"\n },\n {\n \"id\": \"77ea623b-f677-4a00-8307-ec19aa022d22\",\n \"name\": \"Breakout Room 2\"\n },\n {\n \"id\": \"6cc45935-f00c-4683-9f14-32d98793e168\",\n \"name\": \"Breakout Room 3\"\n }\n ],\n \"html_title\": \"MyPublicRoom custom HTML title\",\n \"transcription_enabled\": false,\n \"captions_enabled\": true,\n \"captions_in_recordings_enabled\": false,\n \"captions_language\": \"en\",\n \"created_at\": \"2022-05-13T19:09:04Z\",\n \"updated_at\": \"2024-03-28T00:43:42Z\"\n}", "name": "" } ] }, { "name": "Delete rooms by tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"tag1\",\"tag2\"],\"delete_resources\":false,\"delete_history\":false,\"delete_library\":false}" }, "description": "Queues deletion of all rooms that have **any** of the specified tags.\nReturns `202 Accepted` immediately - deletion runs asynchronously in the background.\n\nRooms with an active (live) session are **skipped** and not deleted.\n\nEach matching room is permanently deleted along with its sessions, participants, roles, and permissions.\n\n`delete_resources` - additionally deletes all content generated during sessions for each matched room:\n- Recordings\n- Chat messages\n- Transcripts (captions) and caption summaries\n- Q&A questions\n- Polls and poll results\n- Quizzes and quiz results\n- Restreams\n- Shared files\n- Breakout rooms\n- Banned participants\n\n`delete_history` - additionally anonymises PII (name, email, avatar, etc.)\nfor all archived participants of each matched room.\n\n`delete_library` - additionally deletes the content library for each matched room\n(files, folders, and personal libraries of room participants)." }, "response": [ { "header": [], "code": 202, "body": "{}", "name": "" } ] }, { "name": "Delete room", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"delete_resources\":false,\"delete_history\":false,\"delete_library\":false}" }, "description": "Deletes the room and optionally its associated content. If the room has a live session,\nparticipants are kicked before deletion, but `delete_resources`, `delete_history`, and\n`delete_library` flags are not permitted in that case \u2014 the request will fail if any is `true`.\n\n**Room deletion behaviour:**\n- If the room has any session history, it is soft-deleted (the record is retained for reporting).\n- If the room has no session history, it is permanently deleted along with its breakout rooms and logo files.\n\n**Optional flags:**\n\n`delete_resources` - permanently deletes all content generated across all sessions in this room:\n- Recordings\n- Chat messages\n- Transcripts (captions) and caption summaries\n- Q&A questions\n- Poll results\n- Quiz results\n- Restreams\n- Shared files\n- Breakout rooms\n- Banned participants\n\n`delete_history` - anonymises PII for all archived participants of this room\n(name, email, avatar, etc.) and removes participant logs from MongoDB if available.\n\n`delete_library` - permanently deletes the room's content library (files, folders,\nand personal libraries of room participants)." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Cannot delete resources of a live room.\"}", "name": "Room has a live session and a resource flag was set" } ] }, { "name": "Delete room resources", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/resources", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/resources", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"delete_history\":false,\"delete_library\":false}" }, "description": "Permanently deletes all content generated across all sessions in this room.\nThe room record itself is preserved. Cannot be called while the room has a live session.\n\nThe following resources are permanently deleted:\n- Recordings\n- Chat messages\n- Transcripts (captions) and caption summaries\n- Q&A questions\n- Poll results\n- Quiz results\n- Restreams\n- Shared files\n- Breakout rooms\n- Banned participants\n\n`delete_history` \u2014 additionally anonymises PII for all archived participants of this room\n(name, email, avatar, etc.) and removes participant logs from MongoDB if available.\n\n`delete_library` \u2014 additionally deletes the room's content library (files, folders,\nand personal libraries of room participants)." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Cannot delete resources of a live room.\"}", "name": "Room has a live session" } ] } ] }, { "name": "Sessions", "description": "\nDocumentation<\/a>", "item": [ { "name": "Delete chats by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/chat", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/chat", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete Q&A by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/questions", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete summaries by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/summaries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/summaries", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete transcripts by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/transcripts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/transcripts", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete polls by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/polls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/polls", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes all polls created by participants of the specified session.\nOnly polls belonging to this session's participants are affected \u2014\npolls created in the same room during other sessions are not deleted.\n\nThe following resources are deleted:\n- Polls\n- Poll votes" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete quizzes by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/quizzes", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes all quizzes created by participants of the specified session.\nOnly quizzes belonging to this session's participants are affected \u2014\nquizzes created in the same room during other sessions are not deleted.\n\nThe following resources are deleted:\n- Quizzes\n- Quiz votes" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete recordings by session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/recordings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/recordings", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Delete session resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/resources", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/resources", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"delete_history\":false}" }, "description": "Permanently deletes all content generated during the session. The session record itself is preserved.\nCannot be used on a live (in-progress) session.\n\nThe following resources are permanently deleted:\n- Recordings\n- Chat messages\n- Transcripts (captions) and caption summaries\n- Q&A questions\n- Poll sessions (responses and results)\n- Quiz sessions (responses and results)\n- Restreams\n- Shared files\n- Banned participants\n\nIf `delete_history` is `true`, participant PII (name, email, avatar, etc.) is also anonymised\nfor all archived participants of this session." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Cannot delete resources of a live session.\"}", "name": "Session is live" } ] }, { "name": "Get all room sessions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/sessions", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "live", "value": "", "description": "Flag to filter live or archive sessions.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/sessions?date_start=&date_end=&limit=20&offset=0&order=asc&after=&live=", "variable": [ { "id": "room", "key": "room", "value": "-", "description": "The room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"643be420-4dcc-453c-92d4-432164a4bc52\",\n \"start_time\": \"2024-03-21T05:09:31.000000Z\",\n \"end_time\": \"2024-03-21T05:29:31.000000Z\",\n \"room_id\": \"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\n \"room_external_id\": \"EXT-ID-123\",\n \"description\": \"My room description\",\n \"friendly_url\": \"myRoom\",\n \"room_is_deleted\": false,\n \"participants_live\": 3,\n \"participants_total\": 8,\n \"participants_max\": 5,\n \"live\": true\n },\n {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"start_time\": \"2024-03-21T05:19:31.000000Z\",\n \"end_time\": \"2024-03-21T05:29:31.000000Z\",\n \"room_id\": \"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\n \"room_external_id\": \"EXT-ID-123\",\n \"description\": \"My room description\",\n \"friendly_url\": \"myRoom\",\n \"room_is_deleted\": false,\n \"participants_total\": 10,\n \"participants_max\": 5,\n \"live\": false\n }\n ],\n \"total_count\": \"2\"\n}\n\n", "name": "" } ] }, { "name": "Get all sessions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "live", "value": "", "description": "Flag to filter live or archive sessions.", "disabled": true }, { "key": "room_id", "value": "", "description": "The UUID of the room to filter session by specific room.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/sessions?date_start=&date_end=&limit=20&offset=0&order=asc&after=&live=&room_id=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"643be420-4dcc-453c-92d4-432164a4bc52\",\n \"start_time\": \"2024-03-21T05:09:31.000000Z\",\n \"end_time\": \"2024-03-21T05:29:31.000000Z\",\n \"room_id\": \"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\n \"room_external_id\": \"EXT-ID-123\",\n \"description\": \"My room description\",\n \"friendly_url\": \"myRoom\",\n \"room_is_deleted\": false,\n \"participants_live\": 3,\n \"participants_total\": 8,\n \"participants_max\": 5,\n \"live\": true\n },\n {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"start_time\": \"2024-03-21T05:19:31.000000Z\",\n \"end_time\": \"2024-03-21T05:29:31.000000Z\",\n \"room_id\": \"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\n \"room_external_id\": \"EXT-ID-123\",\n \"description\": \"My room description\",\n \"friendly_url\": \"myRoom\",\n \"room_is_deleted\": false,\n \"participants_total\": 10,\n \"participants_max\": 5,\n \"live\": false\n }\n ],\n \"total_count\": \"2\"\n}\n\n", "name": "" } ] }, { "name": "Get session statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session", "query": [ { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session?metrics=", "variable": [ { "id": "session", "key": "session", "value": "voluptatem", "description": "The session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"room_id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"room_external_id\": \"EXTID123\",\n \"room_description\": \"Some public room\",\n \"room_friendly_url\": \"MyPublicRoom\",\n \"room_privacy\": \"public\",\n \"room_source\": \"api\",\n \"room_max_participants\": 100,\n \"room_is_deleted\": false,\n \"session_id\": \"0c843bf8-d245-450c-94fb-31e8a861bfaf\",\n \"session_duration\": 60,\n \"session_live\": false,\n \"session_start_time\": \"2022-05-09T15:25:21Z\",\n \"session_end_time\": \"2022-05-09T15:57:25Z\",\n \"participation_minutes\": 67,\n \"desktop_participation_minutes\": 50,\n \"mobile_participation_minutes\": 10,\n \"tablet_participation_minutes\": 7,\n \"smarttv_participation_minutes\": 0,\n \"broadcasted_minutes\": 15,\n \"subscribed_minutes\": 0,\n \"screen_broadcasted_minutes\": 0,\n \"screen_subscribed_minutes\": 0,\n \"live_participants\": 0,\n \"active_participants\": 4,\n \"desktop_participants\": 2,\n \"mobile_participants\": 1,\n \"tablet_participants\": 1,\n \"smarttv_participants\": 0,\n \"max_concurrent_participants\": 3,\n \"transcription_minutes\": 20,\n \"e2ee_minutes\": 0,\n \"recorded_minutes\": 90,\n \"stored_recorded_minutes\": 60,\n \"whiteboard_minutes\": 0,\n \"captions_minutes\": 10,\n \"breakout_minutes\": 0,\n \"presentation_minutes\": 0,\n \"active_roles\": 2,\n \"public_chat_posts\": 52,\n \"questions\": 2,\n \"answers\": 3,\n \"polls\": 1\n}", "name": "" } ] }, { "name": "Get session summary.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/summary", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/summary", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"job_id\": \"ebdc6214-33c7-46df-a38d-a77f0a19c4ce\",\n \"status\": \"IN_PROGRESS\",\n \"summary\": \"\"\n}", "name": "When summary is in progress" }, { "header": [], "code": 200, "body": "{\n \"job_id\": \"ebdc6214-33c7-46df-a38d-a77f0a19c4ce\",\n \"status\": \"READY\",\n \"summary\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\"\n}\n", "name": "When summary is ready" } ] }, { "name": "Get session transcripts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/transcripts", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/transcripts?limit=20&offset=0&order=asc", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 3,\n \"data\": [\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"participant_name\": \"John Smith\",\n \"transcript\": \"Morning. How are you?\",\n \"start_time\": \"2024-04-10T12:18:27Z\",\n \"end_time\": \"2024-04-10T12:33:27Z\"\n },\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"participant_name\": \"Jane Doe\",\n \"transcript\": \"I am fine, thanks! What about you?\",\n \"start_time\": \"2024-04-10T12:10:27Z\",\n \"end_time\": \"2024-04-10T12:31:27Z\"\n },\n {\n \"participant_id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\", \n \"participant_name\": \"John Doe\",\n \"transcript\": \"Hi all!\",\n \"start_time\": \"2024-04-10T12:06:27Z\",\n \"end_time\": \"2024-04-10T12:33:27Z\"\n }\n ]\n} ", "name": "" } ] }, { "name": "Export session transcripts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/transcripts\/export", "query": [ { "key": "format", "value": "txt", "description": "Export format (txt or json).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/transcripts\/export?format=txt", "variable": [ { "id": "session", "key": "session", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"es\",\"lang\":\"es\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "Text file - Transcripts", "name": "" } ] }, { "name": "End the specified live session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/end", "query": [], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/end", "variable": [ { "id": "session", "key": "session", "value": "d30e392f-7fa4-4476-a80b-9bf83fd4c012", "description": "The UUID of the session." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] } ] }, { "name": "Participants", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get all participants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/participants", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "live", "value": "", "description": "Flag to filter live or archive sessions.", "disabled": true }, { "key": "room_id", "value": "", "description": "The UUID of the room to filter session by specific room.", "disabled": true }, { "key": "session_id", "value": "", "description": "The UUID of the session to filter participants by specific session.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/participants?date_start=&date_end=&limit=20&offset=0&order=asc&after=&live=&room_id=&session_id=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "\n{\n \"data\": [\n {\n \"id\": \"17c75935-387e-499e-ab6f-8025e9bc0691\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Ms. Cara Ferry Jr.\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n },\n {\n \"id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Madisyn Howe\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n }\n ],\n \"total_count\": \"2\"\n}\n\n ", "name": "" } ] }, { "name": "Get participant statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/participants\/:participant", "query": [], "raw": "{{baseUrl}}\/api\/v1\/participants\/:participant", "variable": [ { "id": "participant", "key": "participant", "value": "qui", "description": "The participant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{ \n \"room_id\": \"9af9933c-5b43-3279-a7bb-7e7809210e9e\",\n \"room_external_id\": \"308bf674-8610-35cb-a378-e2c54f2fc976\",\n \"room_friendly_url\": \"UoZhS97JdgTqxj4qVgPWyD_F8eBdW5Si\",\n \"room_privacy\": \"public\",\n \"room_is_deleted\": false,\n \"session_id\": \"fc355508-8064-4367-96c2-21ef571beee5\",\n \"live\": false,\n \"participant_name\": \"Madisyn Howe\",\n \"role\": \"moderator\",\n \"join_time\": \"2024-03-31T15:27:43Z\",\n \"leave_time\": \"2024-03-31T15:36:43Z\",\n \"device\": \"desktop\",\n \"system\": \"Mac OS X 10\",\n \"browser\": \"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_6_3 rv:6.0) Gecko\/20190126 Firefox\/35.0\",\n \"e2ee\": false,\n \"participation_minutes\": 9,\n \"public_chat_posts\": 2,\n \"questions\": 3,\n \"answers\": 2\n} ", "name": "" } ] }, { "name": "Get all room participants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/participants", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "live", "value": "", "description": "Flag to filter live or archive sessions.", "disabled": true }, { "key": "session_id", "value": "", "description": "The UUID of the session to filter participants by specific session.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/participants?date_start=&date_end=&limit=20&offset=0&order=asc&after=&live=&session_id=", "variable": [ { "id": "room", "key": "room", "value": "www", "description": "The room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "\n{\n \"data\": [\n {\n \"id\": \"17c75935-387e-499e-ab6f-8025e9bc0691\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Ms. Cara Ferry Jr.\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n },\n {\n \"id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Madisyn Howe\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n }\n ],\n \"total_count\": \"2\"\n}\n\n ", "name": "" } ] }, { "name": "Raise hand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/participants\/:participant\/raise-hand", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/participants\/:participant\/raise-hand", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "participant", "key": "participant", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The UUID of the participant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Raises the hand of the room participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Lower hand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/participants\/:participant\/lower-hand", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/participants\/:participant\/lower-hand", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "participant", "key": "participant", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The UUID of the participant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lowers the hand of the room participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Get all session participants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/participants", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true }, { "key": "live", "value": "", "description": "Flag to filter live or archive sessions.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/participants?date_start=&date_end=&limit=20&offset=0&order=asc&after=&live=", "variable": [ { "id": "session", "key": "session", "value": "minima", "description": "The session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date_start\":\"2026-05-08\",\"date_end\":\"2026-05-08\"}" }, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "\n{\n \"data\": [\n {\n \"id\": \"17c75935-387e-499e-ab6f-8025e9bc0691\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Ms. Cara Ferry Jr.\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n },\n {\n \"id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"external_id\": \"EXTID1625629384\",\n \"session_id\": \"9c725f12-705c-40e5-be1f-10dea6fa0a1f\",\n \"room_id\": \"1a3c3ace-e3ec-3363-b3cd-308c02381268\",\n \"room_external_id\": \"EXTID1375085920\",\n \"room_is_deleted\": false,\n \"name\": \"Madisyn Howe\",\n \"role\": \"moderator\",\n \"friendly_url\": \"iagVi1oidf0k9hQhHypYLefFqpbHulUN\",\n \"join_time\": \"2024-03-03 08:01:01\",\n \"leave_time\": \"2024-03-03 09:01:01\",\n \"live\": false\n }\n ],\n \"total_count\": \"2\"\n}\n\n ", "name": "" } ] } ] }, { "name": "Phone participants", "description": "", "item": [ { "name": "Phone participants joined.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/joined", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/joined", "variable": [ { "id": "room", "key": "room", "value": "w", "description": "The room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[{\"call_id\":\"53858671-c5e0-441a-9e33-e5d7f7f1861e\",\"name\":\"John Smith\",\"caller_number\":\"+1234567890\",\"external_id\":\"EXT_CALLID_123\",\"muted\":true}]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Phone participants left.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/left", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/left", "variable": [ { "id": "room", "key": "room", "value": "-", "description": "The room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[\"53858671-c5e0-441a-9e33-e5d7f7f1861e\",\"074f23f1-6a8e-4856-8779-5cc888456d5c\",\"86712385-8779-a41a-9e33-7f2f88466d5c\"]" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Raise hand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/:callId\/raise-hand", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/:callId\/raise-hand", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "callId", "key": "callId", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The call ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Raises the hand of the phone participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Lower hand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/:callId\/lower-hand", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/:callId\/lower-hand", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "callId", "key": "callId", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The call ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lowers the hand of the phone participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Mute", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/:callId\/mute", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/:callId\/mute", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "callId", "key": "callId", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The call ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mute phone participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Unmute", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone-participants\/:callId\/unmute", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone-participants\/:callId\/unmute", "variable": [ { "id": "room", "key": "room", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the room." }, { "id": "callId", "key": "callId", "value": "074f23f1-6a8e-4856-8779-5cc888456d5c", "description": "The call ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unmute phone participant" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Connect to the phone bridge (SIP)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone\/connect", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone\/connect", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Disconnect from the phone bridge (SIP)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/phone\/disconnect", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/phone\/disconnect", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] } ] }, { "name": "Recordings", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get all team recordings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings", "query": [ { "key": "room_id", "value": "d4dfe280-01e7-42f0-ba57-a2f3e449e775", "description": "The UUID of the room.", "disabled": false }, { "key": "session_id", "value": "ce4bba81-d332-426c-8e59-846d9c15d492", "description": "The UUID of the session.", "disabled": false }, { "key": "status", "value": "READY", "description": "Status of the recording (IN_PROGRESS, PENDING_CONVERSION, READY).", "disabled": false }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the recording after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/recordings?room_id=d4dfe280-01e7-42f0-ba57-a2f3e449e775&session_id=ce4bba81-d332-426c-8e59-846d9c15d492&status=READY&limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"afe64e8b-e52f-337a-9048-a683551d021c\",\"name\":\"Consequatur alias.\",\"status\":\"AWAITING_START\",\"room_id\":\"157aa8ba-c41a-3267-9349-673b8121cf36\",\"external_room_id\":\"EXTID1549415467\",\"friendly_url\":\"-L-ld36LhaP-YlHM9osUWH087K339fc0\",\"privacy\":\"public\",\"participant_id\":\"867a3eec-eb2d-43d9-9d1a-31ef3804fa24\",\"participant_name\":\"rowan.ohara\",\"participant_external_id\":\"EXTID37\",\"created_at\":\"2026-05-08T14:36:57Z\",\"updated_at\":\"2026-05-08T14:36:57Z\"},{\"id\":\"53199ed6-c46a-36cc-aabb-6fadbe3f4b63\",\"name\":\"Sint sit itaque.\",\"status\":\"AWAITING_START\",\"room_id\":\"b2a619c8-d37a-316c-a128-9c10c53b7fe3\",\"external_room_id\":\"EXTID122112083\",\"friendly_url\":\"TykZZ4v2KmdcU3uIUaP4NtqL2aDRiNKQ\",\"privacy\":\"public\",\"participant_id\":\"9f4814db-10bd-43ff-92c5-5e5c61697988\",\"participant_name\":\"kirsten.larson\",\"participant_external_id\":\"EXTID71\",\"created_at\":\"2026-05-08T14:36:57Z\",\"updated_at\":\"2026-05-08T14:36:57Z\"}],\"total_count\":\"2\"}", "name": "" } ] }, { "name": "Get archived team recordings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/archived", "query": [ { "key": "room_id", "value": "d4dfe280-01e7-42f0-ba57-a2f3e449e775", "description": "The UUID of the room.", "disabled": false }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the recording after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/recordings\/archived?room_id=d4dfe280-01e7-42f0-ba57-a2f3e449e775&limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"62a2345f-579f-3a4c-88a9-83094dc9fb01\",\"name\":\"Blanditiis quaerat.\",\"status\":\"AWAITING_START\",\"room_id\":\"e9523bbc-a3d4-3449-8022-3b5f386c9bdf\",\"external_room_id\":\"EXTID1707991022\",\"friendly_url\":\"RwQkXjWlrL8rA17MOK2uyU38_pUFBhmo\",\"privacy\":\"public\",\"participant_id\":\"04d328e2-666d-40d3-a9c7-2d612a5980c9\",\"participant_name\":\"arielle.mann\",\"participant_external_id\":\"EXTID49\",\"created_at\":\"2026-05-08T14:36:58Z\",\"updated_at\":\"2026-05-08T14:36:58Z\"},{\"id\":\"e27debe4-2cde-3a9c-a552-4352e656837e\",\"name\":\"Magni qui nostrum.\",\"status\":\"AWAITING_START\",\"room_id\":\"66163cab-6853-37b6-a7a4-2219af1cb948\",\"external_room_id\":\"EXTID547076114\",\"friendly_url\":\"Z4eFG_PNwusu2P_RI2px8eLYLhwh2UuA\",\"privacy\":\"public\",\"participant_id\":\"7849c4a1-5b6f-4f1f-9b10-d374cb29fa58\",\"participant_name\":\"rcarroll\",\"participant_external_id\":\"EXTID85\",\"created_at\":\"2026-05-08T14:36:58Z\",\"updated_at\":\"2026-05-08T14:36:58Z\"}],\"total_count\":\"2\"}", "name": "" } ] }, { "name": "Get the specified recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"df5580d3-eff0-32b4-ab1a-b4fd22da9782\",\"name\":\"Eveniet excepturi.\",\"duration\":0,\"status\":\"AWAITING_START\",\"room_id\":\"41f31792-fceb-39de-a10b-596e2820d00f\",\"external_room_id\":\"EXTID875418810\",\"friendly_url\":\"bjr7ovqeGEPcxgGcNcP8I9TF8pbMhKks\",\"room_is_deleted\":false,\"privacy\":\"public\",\"session_id\":null,\"participant_id\":\"eb817876-dd58-4503-861e-3f5682efd762\",\"participant_name\":\"cyril05\",\"participant_external_id\":\"EXTID75\",\"created_at\":\"2026-05-08T14:36:58Z\",\"updated_at\":\"2026-05-08T14:36:58Z\"}", "name": "" } ] }, { "name": "Download the specified recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording\/download", "query": [ { "key": "valid_for_minutes", "value": "60", "description": "Link expiration time in minutes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording\/download?valid_for_minutes=60", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"link\":\"https:\\\/\\\/storage.server.net\\\/8c59a25f-7ffa-43cb-a5b8-5814b3923906.mp4?h=rtiHKNPuXilF6NOWpiXbCw&expires=1668238783\",\n \"valid_until\":\"2022-11-12T07:39:43Z\"\n}", "name": "" } ] }, { "name": "Get bookmarks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording\/bookmarks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording\/bookmarks", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": \"f576c287-cad2-4377-a8c9-4f3129c6fa2d\",\n \"bookmark\": \"First bookmark.\",\n \"time\": 717074,\n \"session_id\": \"4aa9a5a4-6105-43f3-9513-2afdf35c99ac\",\n \"participant_id\": \"7b0761e2-77aa-4659-80d8-6792b07c730e\",\n \"created_at\": \"2025-11-26T12:01:32Z\"\n }, {\n \"id\": \"98cb23a5-bd86-4206-819f-50d62930ba60\",\n \"bookmark\": \"Second bookmark.\",\n \"time\": 657142,\n \"session_id\": \"4aa9a5a4-6105-43f3-9513-2afdf35c99ac\",\n \"participant_id\": \"7b0761e2-77aa-4659-80d8-6792b07c730e\",\n \"created_at\": \"2025-11-26T12:01:32Z\"\n }, {\n \"id\": \"a462a760-591e-4e3d-a8da-17877a0e2921\",\n \"bookmark\": \"Third bookmark.\",\n \"time\": 176579,\n \"session_id\": \"4aa9a5a4-6105-43f3-9513-2afdf35c99ac\",\n \"participant_id\": \"7b0761e2-77aa-4659-80d8-6792b07c730e\",\n \"created_at\": \"2025-11-26T12:01:32Z\"\n }\n]", "name": "" } ] }, { "name": "Archive recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording\/archive", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording\/archive", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Unarchive recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording\/unarchive", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording\/unarchive", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Delete recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/recordings\/:recording", "query": [], "raw": "{{baseUrl}}\/api\/v1\/recordings\/:recording", "variable": [ { "id": "recording", "key": "recording", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the recording." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Start recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/recordings\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/recordings\/start", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Stop recording.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/recordings\/stop", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/recordings\/stop", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] } ] }, { "name": "Restreamers", "description": "", "item": [ { "name": "Start restreamer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/restreamers\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/restreamers\/start", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"vimeo\",\"stream_key\":\"53858671-c5e0-441a-9e33-e5d7f7f1861e\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Stop restreamer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/restreamers\/stop", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/restreamers\/stop", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] } ] }, { "name": "Roles", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get available roles for the team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/roles?limit=20&offset=0&order=asc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 3,\n \"data\": [{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"name\": \"attendee\",\n \"display_name\": \"Attendees\",\n \"description\": \"The Digital Samba Embedded Attendee preset is conceived as the role with the lowest rank. An Attendee preset may essentially see and hear the Speaker and Moderator presets' audio, video and screenshare streams.\",\n \"default\": false,\n \"created_at\": \"2023-01-31T12:45:51Z\",\n \"updated_at\": \"2023-03-27T13:46:22Z\"\n }, {\n \"id\": \"76bb6199-2900-4b8d-b1bf-351dec4a8db4\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"description\": \"The Digital Samba Embedded Moderator preset is conceived to have all permissions, encompassing speaker\\u2019s rights to broadcast, screenshare and present, and also management rights such as granting or removing permissions, removing participants, starting \\\/ ending a session or recording it.\",\n \"default\": true,\n \"created_at\": \"2023-01-31T12:45:51Z\",\n \"updated_at\": \"2023-03-27T13:46:22Z\"\n }, {\n \"id\": \"e5bad6b9-48bd-46a0-9482-af78a834c28c\",\n \"name\": \"speaker\",\n \"display_name\": \"Speakers\",\n \"description\": \"The Digital Samba Embedded Speaker preset is conceived to have all broadcast, screensharing and presentation permissions, but none of the Moderator\\u2019s management rights, such as as granting or removing permissions, removing participants, starting \\\/ ending a session or recording it.\",\n \"default\": false,\n \"created_at\": \"2023-01-31T12:45:51Z\",\n \"updated_at\": \"2023-03-27T13:46:22Z\"\n }]\n}", "name": "" } ] }, { "name": "Get the specified role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role", "variable": [ { "id": "role", "key": "role", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the role or role name." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"description\": \"The Digital Samba Embedded Moderator preset is conceived to have all permissions, encompassing speaker\\u2019s rights to broadcast, screenshare and present, and also management rights such as granting or removing permissions, removing participants, starting \\\/ ending a session or recording it.\",\n \"default\": true,\n \"created_at\": \"2023-01-31T12:45:53Z\",\n \"updated_at\": \"2023-02-15T03:22:24Z\",\n \"permissions\": {\n \"answer_qa\": true,\n \"answer_privately_qa\": false,\n \"ask_remote_unmute\": true,\n \"ask_question_qa\": true,\n \"ask_question_anonymously_qa\": false,\n \"access_qa\": true,\n \"broadcast\": true,\n \"start_session\": false,\n \"end_session\": true,\n \"see_participants_panel\": true,\n \"see_roles_in_participants_panel\": true,\n \"general_chat\": true,\n \"manage_broadcast\": true,\n \"manage_edit_whiteboard\": true,\n \"manage_private_whiteboard\": true,\n \"manage_breakout\": true,\n \"manage_roles\": [\"moderator\", \"speaker\", \"attendee\"],\n \"manage_screenshare\": false,\n \"manage_polls\": true,\n \"manage_poll_templates\": true,\n \"moderate_qa\": true,\n \"download_qa\": true,\n \"private_chat\": true,\n \"remove_chat\": true,\n \"export_chat\": true,\n \"clear_chat\": true,\n \"delete_others_chat_messages\": true,\n \"present_content_library\": true,\n \"manage_content_library\":true,\n \"manage_personal_content_library\": true,\n \"manage_phone_users\": false,\n \"push_content\": true,\n \"lock_content\": true,\n \"raise_hand\": true,\n \"recording\": true,\n \"restreaming\": true,\n \"transcribe_session\": true,\n \"remote_muting\": false,\n \"invite_participant\": true,\n \"pin_panels\": false,\n \"control_room_entry\": true,\n \"control_room_components\": false,\n \"remove_participant\": false,\n \"edit_whiteboard\": true,\n \"screenshare\": false,\n \"upvote_qa\": false,\n \"collaborate_in_notes\": true,\n \"see_notes\": true,\n \"see_all_questions\": true,\n \"see_questions_author\": true,\n \"ban_participants\": true,\n \"clear_content\": true,\n \"rename_participants\": false,\n \"self_rename\": false,\n \"room_reactions\": true,\n \"chat_reactions\": true\n }\n}", "name": "" } ] }, { "name": "Create a new role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"participant\",\"display_name\":\"Basic Participant\",\"description\":\"Participant with basic permissions\",\"permissions\":{\"ask_remote_unmute\":true,\"broadcast\":true,\"end_session\":true,\"general_chat\":true,\"manage_broadcast\":true,\"manage_roles\":[\"moderator\",\"speaker\",\"attendee\"]}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"description\": \"The Digital Samba Embedded Moderator preset is conceived to have all permissions, encompassing speaker\\u2019s rights to broadcast, screenshare and present, and also management rights such as granting or removing permissions, removing participants, starting \\\/ ending a session or recording it.\",\n \"default\": true,\n \"created_at\": \"2023-01-31T12:45:53Z\",\n \"updated_at\": \"2023-02-15T03:22:24Z\",\n \"permissions\": {\n \"answer_qa\": true,\n \"answer_privately_qa\": false,\n \"ask_remote_unmute\": true,\n \"ask_question_qa\": true,\n \"ask_question_anonymously_qa\": false,\n \"access_qa\": true,\n \"broadcast\": true,\n \"start_session\": false,\n \"end_session\": true,\n \"see_participants_panel\": true,\n \"see_roles_in_participants_panel\": true,\n \"general_chat\": true,\n \"manage_broadcast\": true,\n \"manage_edit_whiteboard\": true,\n \"manage_private_whiteboard\": true,\n \"manage_breakout\": true,\n \"manage_roles\": [\"moderator\", \"speaker\", \"attendee\"],\n \"manage_screenshare\": false,\n \"manage_polls\": true,\n \"manage_poll_templates\": true,\n \"moderate_qa\": true,\n \"download_qa\": true,\n \"private_chat\": true,\n \"remove_chat\": true,\n \"export_chat\": true,\n \"clear_chat\": true,\n \"delete_others_chat_messages\": true,\n \"present_content_library\": true,\n \"manage_content_library\":true,\n \"manage_personal_content_library\": true,\n \"manage_phone_users\": false,\n \"push_content\": true,\n \"lock_content\": true,\n \"raise_hand\": true,\n \"recording\": true,\n \"restreaming\": true,\n \"transcribe_session\": true,\n \"remote_muting\": false,\n \"invite_participant\": true,\n \"pin_panels\": false,\n \"control_room_entry\": true,\n \"control_room_components\": false,\n \"remove_participant\": false,\n \"edit_whiteboard\": true,\n \"screenshare\": false,\n \"upvote_qa\": false,\n \"collaborate_in_notes\": true,\n \"see_notes\": true,\n \"see_all_questions\": true,\n \"see_questions_author\": true,\n \"ban_participants\": true,\n \"clear_content\": true,\n \"rename_participants\": false,\n \"self_rename\": false,\n \"room_reactions\": true,\n \"chat_reactions\": true\n }\n}", "name": "" } ] }, { "name": "Update the specified role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role", "variable": [ { "id": "role", "key": "role", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the role or role name." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"participant\",\"display_name\":\"Basic Participant\",\"description\":\"Participant with basic permissions\",\"permissions\":{\"ask_remote_unmute\":true,\"broadcast\":true,\"end_session\":true,\"general_chat\":true,\"manage_broadcast\":true,\"manage_roles\":[\"moderator\",\"speaker\",\"attendee\"]}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"name\": \"moderator\",\n \"display_name\": \"Moderators\",\n \"description\": \"The Digital Samba Embedded Moderator preset is conceived to have all permissions, encompassing speaker\\u2019s rights to broadcast, screenshare and present, and also management rights such as granting or removing permissions, removing participants, starting \\\/ ending a session or recording it.\",\n \"default\": true,\n \"created_at\": \"2023-01-31T12:45:53Z\",\n \"updated_at\": \"2023-02-15T03:22:24Z\",\n \"permissions\": {\n \"answer_qa\": true,\n \"answer_privately_qa\": false,\n \"ask_remote_unmute\": true,\n \"ask_question_qa\": true,\n \"ask_question_anonymously_qa\": false,\n \"access_qa\": true,\n \"broadcast\": true,\n \"start_session\": false,\n \"end_session\": true,\n \"see_participants_panel\": true,\n \"see_roles_in_participants_panel\": true,\n \"general_chat\": true,\n \"manage_broadcast\": true,\n \"manage_edit_whiteboard\": true,\n \"manage_private_whiteboard\": true,\n \"manage_breakout\": true,\n \"manage_roles\": [\"moderator\", \"speaker\", \"attendee\"],\n \"manage_screenshare\": false,\n \"manage_polls\": true,\n \"manage_poll_templates\": true,\n \"moderate_qa\": true,\n \"download_qa\": true,\n \"private_chat\": true,\n \"remove_chat\": true,\n \"export_chat\": true,\n \"clear_chat\": true,\n \"delete_others_chat_messages\": true,\n \"present_content_library\": true,\n \"manage_content_library\":true,\n \"manage_personal_content_library\": true,\n \"manage_phone_users\": false,\n \"push_content\": true,\n \"lock_content\": true,\n \"raise_hand\": true,\n \"recording\": true,\n \"restreaming\": true,\n \"transcribe_session\": true,\n \"remote_muting\": false,\n \"invite_participant\": true,\n \"pin_panels\": false,\n \"control_room_entry\": true,\n \"control_room_components\": false,\n \"remove_participant\": false,\n \"edit_whiteboard\": true,\n \"screenshare\": false,\n \"upvote_qa\": false,\n \"collaborate_in_notes\": true,\n \"see_notes\": true,\n \"see_all_questions\": true,\n \"see_questions_author\": true,\n \"ban_participants\": true,\n \"clear_content\": true,\n \"rename_participants\": false,\n \"self_rename\": false,\n \"room_reactions\": true,\n \"chat_reactions\": true\n }\n}", "name": "" } ] }, { "name": "Delete the specified role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role", "variable": [ { "id": "role", "key": "role", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the role or role name." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Permissions", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get available permissions for roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/permissions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n \"answer_qa\",\n \"answer_privately_qa\",\n \"ask_remote_unmute\",\n \"ask_question_qa\",\n \"ask_question_anonymously_qa\",\n \"access_qa\",\n \"broadcast\",\n \"start_session\",\n \"end_session\",\n \"see_participants_panel\",\n \"see_roles_in_participants_panel\",\n \"general_chat\",\n \"manage_broadcast\",\n \"manage_edit_whiteboard\",\n \"manage_private_whiteboard\",\n \"manage_roles\",\n \"manage_screenshare\",\n \"manage_breakout\",\n \"manage_polls\",\n \"manage_poll_templates\",\n \"moderate_qa\",\n \"download_qa\",\n \"private_chat\",\n \"remove_chat\",\n \"export_chat\",\n \"clear_chat\",\n \"delete_others_chat_messages\",\n \"present_content_library\",\n \"manage_content_library\",\n \"manage_personal_content_library\",\n \"manage_phone_users\",\n \"push_content\",\n \"lock_content\",\n \"raise_hand\",\n \"recording\",\n \"restreaming\",\n \"transcribe_session\",\n \"remote_muting\",\n \"invite_participant\",\n \"remove_participant\",\n \"pin_panels\",\n \"control_room_entry\",\n \"control_room_components\",\n \"edit_whiteboard\",\n \"screenshare\",\n \"upvote_qa\",\n \"collaborate_in_notes\",\n \"see_notes\",\n \"see_all_questions\",\n \"see_questions_author\",\n \"ban_participants\",\n \"clear_content\",\n \"rename_participants\",\n \"self_rename\",\n \"room_reactions\",\n \"chat_reactions\",\n \"avatar_upload\"\n]", "name": "" } ] } ] }, { "name": "Libraries", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get available libraries for the team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the library after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/libraries?limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 2,\n \"data\": [{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"name\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n }, {\n \"id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"external_id\": \"EXTLIB002\",\n \"name\": \"My documents\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n }]\n}", "name": "" } ] }, { "name": "Get the specified library.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"name\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Get the specified library hierarchy.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/hierarchy", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/hierarchy", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"name\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Create a new library.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My photos\",\"external_id\":\"EXTID123\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"name\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Update the specified library.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My photos\",\"external_id\":\"EXTID123\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"name\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Delete the specified library.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Get available library folders.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/folders", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the folder after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/folders?limit=20&offset=0&order=asc&after=", "variable": [ { "id": "library", "key": "library", "value": "earum", "description": "The library." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 2,\n \"data\": [{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"description\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n }, {\n \"id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"external_id\": \"EXTLIB002\",\n \"description\": \"My documents\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n }]\n}", "name": "" } ] }, { "name": "Get the specified folder.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/folders\/:libraryFolder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/folders\/:libraryFolder", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFolder", "key": "libraryFolder", "value": "dignissimos", "description": "" }, { "id": "folder", "key": "folder", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library folder." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"description\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Create a new library folder.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/folders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/folders", "variable": [ { "id": "library", "key": "library", "value": "quo", "description": "The library." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My photos\",\"parent_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"description\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Update the specified folder.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/folders\/:libraryFolder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/folders\/:libraryFolder", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFolder", "key": "libraryFolder", "value": "voluptas", "description": "" }, { "id": "folder", "key": "folder", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library folder." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My photos\",\"parent_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"8cae6c49-c40a-4965-a32b-6cf20de36755\",\n \"external_id\": \"EXTLIB001\",\n \"description\": \"My photos\", \n \"created_at\": \"2023-01-31T12:45:51Z\" \n}", "name": "" } ] }, { "name": "Delete the specified folder.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/folders\/:libraryFolder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/folders\/:libraryFolder", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFolder", "key": "libraryFolder", "value": "deserunt", "description": "" }, { "id": "folder", "key": "folder", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library folder." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Get available library files.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the file after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files?limit=20&offset=0&order=asc&after=", "variable": [ { "id": "library", "key": "library", "value": "aspernatur", "description": "The library." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": \"e10bbf8f-4d27-4fcd-9ed6-28ab116f0d86\",\n \"folder_id\": \"7360ccd3-11a0-47d2-ad92-e9eaccc4ca57\",\n \"name\": \"photo.png\",\n \"type\": \"image\", \n \"size\": 6950,\n \"created_at\": \"2024-07-17T09:46:59Z\"\n },\n {\n \"id\": \"580d7470-c9ad-4b27-ba79-ebd7cecbf6d9\",\n \"folder_id\": \"f696e700-d5b5-4b9c-a725-823fe69f8ca2\",\n \"name\": \"image.png\",\n \"type\": \"image\", \n \"size\": 68095,\n \"created_at\": \"2024-07-17T09:48:35Z\"\n } \n]", "name": "" } ] }, { "name": "Get the specified file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files\/:libraryFile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files\/:libraryFile", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFile", "key": "libraryFile", "value": "reprehenderit", "description": "" }, { "id": "file", "key": "file", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library file." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"e10bbf8f-4d27-4fcd-9ed6-28ab116f0d86\",\n \"folder_id\": \"7360ccd3-11a0-47d2-ad92-e9eaccc4ca57\",\n \"name\": \"photo.png\",\n \"type\": \"image\",\n \"size\": 6950,\n \"status\": \"completed\",\n \"created_at\": \"2024-07-17T09:46:59Z\"\n}", "name": "" } ] }, { "name": "Get file links", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files\/:libraryFile\/links", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files\/:libraryFile\/links", "variable": [ { "id": "library", "key": "library", "value": "animi", "description": "The library." }, { "id": "libraryFile", "key": "libraryFile", "value": "fugit", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"pages\": [\n {\n \"url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/original.0.png?h=2AH1Q_V9lpukScTCAGeHuA&expires=1728117493\",\n \"thumbnail_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/t_original.0.png?h=qD41qd9ny8fj-7ec1vx2-g&expires=1728117493\"\n },\n {\n \"url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/original.1.png?h=La4wf3g2Quh6NzuDUHas4Q&expires=1728117493\",\n \"thumbnail_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/t_original.1.png?h=dgXjEkx-WVxQ1D9ACbWLxw&expires=1728117493\"\n },\n {\n \"url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/original.2.png?h=eUH0OvzSqBpoR75VW2HUzQ&expires=1728117493\",\n \"thumbnail_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/t_original.2.png?h=IOoDlckDkzrJHraa_YUxxw&expires=1728117493\"\n },\n {\n \"url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/original.3.png?h=D9Gp4kRyobd6UOuFbhrSYQ&expires=1728117493\",\n \"thumbnail_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/t_original.3.png?h=WVs9j8NavQw1Ndf7su0xZA&expires=1728117493\"\n },\n {\n \"url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/original.4.png?h=cgxQ4C35KGwu-KkEQGXM-w&expires=1728117493\",\n \"thumbnail_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61\/t_original.4.png?h=-qqSmv181ppVcS9QxWVj7g&expires=1728117493\"\n }\n ]\n}", "name": "" } ] }, { "name": "Create a new library file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files", "variable": [ { "id": "library", "key": "library", "value": "quae", "description": "The library." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"photo.png\",\"folder_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\",\"initiator_id\":\"697022b3-47a4-3de8-906b-ce305d915824\",\"file_size\":3122434}" }, "description": "Get upload URL and access token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"file_id\": \"149d9ad5-56ab-44ac-8072-eca92cbfcb4e\",\n \"file_name\": \"iuST5tNOfum3bl8O4MrGAsgxcd3Eo5jvTOIyrqWY.png\",\n \"external_storage_url\": \"storage-server.net\",\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiaXVTVDV0Tk9mdW0zYmw4TzRNckdBc2d4Y2QzRW81anZUT0l5cnFXWS5wbmciLCJhY3Rpb24iOiJ1cGxvYWQiLCJ0eXBlIjoibGlicmFyeSIsImxpYnJhcnlfaWQiOiI5Y2I4Y2ExMy1kNWMwLTQ2MzAtODIxZS1hYWFlMjcyNWMzNGYiLCJmaWxlX2lkIjoiMTQ5ZDlhZDUtNTZhYi00NGFjLTgwNzItZWNhOTJjYmZjYjRlIiwiaXNzIjoibGFyYXZlbCIsImlhdCI6MTcyNzkyODQ0OSwiZXhwIjoxNzI3OTI5MzQ5fQ.7mlwaPIrNYTfEmuOjKVN-qaY-oeifC8RZlmz68tkqAM\",\n \"expiration_timestamp\": 1727929349 \n}", "name": "" } ] }, { "name": "Create a new webapp file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/webapps", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/webapps", "variable": [ { "id": "library", "key": "library", "value": "quisquam", "description": "The library." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/www.youtube.com\\\/embed\\\/sGV83rWzsdT\",\"name\":\"My YouTube video\",\"folder_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\",\"initiator_id\":\"25249c09-3eb4-32bb-8209-e7c9a7470b02\"}" }, "description": "Add embed content from various platforms. Link to apps like YouTube, Vimeo, Miro, Google Docs, and more." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"e10bbf8f-4d27-4fcd-9ed6-28ab116f0d86\",\n \"folder_id\": \"5ce6fda5-d42b-4110-8796-177e571a7407\",\n \"name\": \"My YouTube video\",\n \"type\": \"youtube\",\n \"url\": \"https:\/\/www.youtube.com\/embed\/sGV83rWzsdT\",\n \"status\": \"completed\",\n \"created_at\": \"2024-07-17T09:46:59Z\"\n}", "name": "" } ] }, { "name": "Create a new whiteboard file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/whiteboards", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/whiteboards", "variable": [ { "id": "library", "key": "library", "value": "distinctio", "description": "The library." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"private\":true,\"folder_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"e10bbf8f-4d27-4fcd-9ed6-28ab116f0d86\",\n \"folder_id\": \"7360ccd3-11a0-47d2-ad92-e9eaccc4ca57\",\n \"name\": \"Whiteboard 1\",\n \"type\": \"whiteboard\",\n \"size\": 6950,\n \"storage_file_name\": \"39cf7b81-769c-3c5c-acb7-1ae932a16d61.wb\",\n \"storage_url\": \"https:\/\/storage-server.net\/library-files\/9700fbae-dc27-4d12-8530-1a513c166cb4\/39cf7b81-769c-3c5c-acb7-1ae932a16d61.wb?h=2AH1Q_V9lpukScTCAGeHuA&expires=1728117493\",\n \"status\": \"completed\",\n \"created_at\": \"2024-07-17T09:46:59Z\"\n}", "name": "" } ] }, { "name": "Update the specified file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files\/:libraryFile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files\/:libraryFile", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFile", "key": "libraryFile", "value": "mollitia", "description": "" }, { "id": "file", "key": "file", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library file." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"photo.png\",\"folder_id\":\"5ce6fda5-d42b-4110-8796-177e571a7407\",\"initiator_id\":\"6ab961a2-2fab-3ec3-afc6-13cd9faf7058\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"e10bbf8f-4d27-4fcd-9ed6-28ab116f0d86\",\n \"folder_id\": \"7360ccd3-11a0-47d2-ad92-e9eaccc4ca57\",\n \"name\": \"photo.png\",\n \"type\": \"image\",\n \"size\": 6950,\n \"status\": \"completed\",\n \"created_at\": \"2024-07-17T09:46:59Z\"\n}", "name": "" } ] }, { "name": "Delete the specified file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/libraries\/:library\/files\/:libraryFile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/libraries\/:library\/files\/:libraryFile", "variable": [ { "id": "library", "key": "library", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the library." }, { "id": "libraryFile", "key": "libraryFile", "value": "at", "description": "" }, { "id": "file", "key": "file", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the library file." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Polls", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get polls.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the poll after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls?limit=20&offset=0&order=asc&after=", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get available polls for the room.\n\nPaginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 1,\n \"data\": [\n {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"question\": \"When will I go on holiday?\",\n \"status\": \"started\",\n \"multiple\": false,\n \"anonymous\": false,\n \"created_at\": \"2022-07-28T20:36:04Z\"\n }\n ]\n}", "name": "" } ] }, { "name": "Export polls.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls\/export", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the Session.", "disabled": false }, { "key": "format", "value": "txt", "description": "Export format (txt or json).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls\/export?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&format=txt", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"es\",\"lang\":\"de\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "Text file - Polls", "name": "" } ] }, { "name": "Get poll.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls\/:poll", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls\/:poll", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "poll", "key": "poll", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the poll." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the specified poll." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"question\": \"When will I go on holiday?\",\n \"status\": \"started\",\n \"multiple\": false,\n \"anonymous\": false,\n \"options\": [\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next week\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next month\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next year\"\n }\n ],\n \"created_at\": \"2022-07-28T20:36:04Z\"\n}\n", "name": "" } ] }, { "name": "Poll results.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls\/:poll\/results", "query": [ { "key": "session_id", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "UUID of the Session.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls\/:poll\/results?session_id=5ce6fda5-d42b-4110-8796-177e571a7407", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "poll", "key": "poll", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the poll." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": \"bd58f41d-924b-48ef-b025-719117c0488c\",\n \"session_id\": \"bc838074-a723-436f-964c-6e7b4327fcdc\",\n \"question\": \"When will I go on holiday?\",\n \"status\": \"eded\",\n \"started\": \"1989-11-16T10:33:33Z\",\n \"ended\": \"2020-04-13T03:15:31Z\",\n \"votes\": 3,\n \"options\": [\n {\n \"id\": \"208f8c8f-06db-4f0a-9765-b10be47cad5c\",\n \"text\": \"Next week\",\n \"voted\": 2,\n \"voters\": [\n {\n \"id\": \"c80f5fb8-d25c-4a3d-895e-4b3778d25a4c\",\n \"name\": \"korbin.connelly\"\n }, \n {\n \"id\": \"bf226af6-0c3c-439b-bb2f-bbbd72b02286\",\n \"name\": \"gutmann.claire\"\n }\n ]\n },\n {\n \"id\": \"f20823cf-bc32-48aa-b728-96e5aeb5f328\",\n \"text\": \"Next month\",\n \"voted\": 1,\n \"voters\": [\n {\n \"id\": \"cada0614-ba03-4264-9078-df7f9689bb2c\",\n \"name\": \"veda.graham\"\n }\n ]\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next year\",\n \"voted\": 0\n }\n ]\n }\n] ", "name": "" } ] }, { "name": "Create poll.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"question\":\"When will I go on holiday?\",\"anonymous\":false,\"type\":\"single\",\"options\":[{\"text\":\"Next week\",\"id\":\"498dfcc2-698e-31ac-b711-64065f650a26\"},{\"text\":\"Next month\"},{\"text\":\"Next year\"}],\"multiple\":true}" }, "description": "Create a new poll." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"question\": \"When will I go on holiday?\",\n \"status\": \"started\",\n \"multiple\": false,\n \"anonymous\": false,\n \"options\": [\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next week\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next month\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next year\"\n }\n ],\n \"created_at\": \"2022-07-28T20:36:04Z\"\n}\n", "name": "" } ] }, { "name": "Update poll.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls\/:poll", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls\/:poll", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "poll", "key": "poll", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the poll." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"question\":\"When will I go on holiday?\",\"anonymous\":false,\"type\":\"single\",\"options\":[{\"id\":\"16719c1b-cc82-4dfe-9f6f-40d9093fa695\",\"text\":\"Next week\"}],\"multiple\":false}" }, "description": "Update the specified poll." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"question\": \"When will I go on holiday?\",\n \"status\": \"started\",\n \"multiple\": false,\n \"anonymous\": false,\n \"options\": [\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next week\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next month\"\n },\n {\n \"id\": \"f06e6600-9424-4dc0-8e7d-a968df2c983d\",\n \"text\": \"Next year\"\n }\n ],\n \"created_at\": \"2022-07-28T20:36:04Z\"\n}\n", "name": "" } ] }, { "name": "Delete poll.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/polls\/:poll", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/polls\/:poll", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "poll", "key": "poll", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the poll." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the specified poll." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Quizzes", "description": "", "item": [ { "name": "Get quizzes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the quiz after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes?limit=20&offset=0&order=asc&after=", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get available quizzes for the room.\n\nPaginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 1,\n \"data\": [\n {\n \"id\": \"3cd39349-0ac0-480b-8919-810f36a7c469\",\n \"title\": \"My quiz.\",\n \"time_limit_minutes\": 45,\n \"status\": \"created\",\n \"created_at\": \"2025-12-19T05:33:54Z\"\n }\n ]\n}", "name": "" } ] }, { "name": "Import quizzes from CSV.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/import", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/import", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=o8P5eq7SQvHSuQWMh2e1KZSPqD4UI5CODRLXeD8e; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=9BRdr66S3fcm6RVFWaF2XRLypET4Oeurz9GhUyHh; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Download quiz CSV template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/template", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/template", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=ZnrIjieQqqNTwp7ROLuYVPmVn86FlNGBRsAA3Ro1; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=EGj8xssCMGtZKwmdUsoQdCOhHlZ9skoAkEaibYhy; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Export.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/export", "query": [ { "key": "format", "value": "txt", "description": "Export format (csv, txt, json or zip).", "disabled": false }, { "key": "locale", "value": "it", "description": "Export language (en, es, de, it).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/export?format=txt&locale=it", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"en\",\"lang\":\"es\"}" }, "description": "Export quiz results." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=4efhgaUlCY7bgsy2j4Mo2VEaCw6uCHRSaFTfWINP; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=4k5jYGA9AyX3lEbyOHMjb4t2wLr83EOgp9EIMAEa; expires=Fri, 08 May 2026 16:36:56 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Get quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/:quiz", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/:quiz", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "quiz", "key": "quiz", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the quiz." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the specified quiz." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"d84a4ad8-b051-4af5-b885-08663e9e401a\",\n \"title\": \"My quiz\",\n \"time_limit_minutes\": 90,\n \"status\": \"created\",\n \"questions\": [\n {\n \"id\": \"b4de7c9c-b4fb-4f2c-87f6-ee9395d79198\",\n \"text\": \"Question #1\",\n \"multiple\": false,\n \"choices\": [\n {\n \"id\": \"b89aec8f-8c1c-46b1-b5e8-8245940041ac\",\n \"text\": \"Correct answer\",\n \"correct\": true\n }, {\n \"id\": \"4db512ce-46f2-48e6-a90b-b67499b15092\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }\n ]\n }, {\n \"id\": \"56ae59e7-2c9b-4a01-ae66-f26309f9c672\",\n \"text\": \"Question #2\",\n \"multiple\": true,\n \"choices\": [\n {\n \"id\": \"9196ddcc-400b-49d8-a57a-25ad7b652071\",\n \"text\": \"Correct answer #1\",\n \"correct\": true\n }, {\n \"id\": \"6eccae14-c478-43d8-b3d5-c4e484d5a148\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }, {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"text\": \"Correct answer #2\",\n \"correct\": true\n }\n ]\n }\n ],\n \"created_at\": \"2025-12-19T05:38:51Z\"\n}", "name": "" } ] }, { "name": "Quiz results.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/:quiz\/results", "query": [ { "key": "session_id", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "UUID of the Session.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/:quiz\/results?session_id=5ce6fda5-d42b-4110-8796-177e571a7407", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "quiz", "key": "quiz", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the quiz." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": \"0cf11706-a024-4b38-a1f6-deed0d8fb4ff\",\n \"session_id\": \"7c3275f2-8e67-4913-939a-11d059a6436c\",\n \"title\": \"My quiz.\",\n \"status\": \"launched\",\n \"started\": \"2025-12-19T07:29:52Z\",\n \"ended\": \"2025-12-19T07:29:52Z\",\n \"questions\": [\n {\n \"id\": \"51040216-6c62-4dfe-a2ff-79e35d776c68\",\n \"question\": \"Question #1\",\n \"voted\": 4,\n \"votes\": [\n {\n \"id\": \"e0f06dd1-4e9a-4414-b114-e8aace9c1d16\",\n \"text\": \"Answer #1\",\n \"voted\": 3,\n \"voters\": [\n {\n \"id\": \"079b6d2f-96ce-4139-95b5-692d70b07568\",\n \"name\": \"xdickinson\"\n },\n {\n \"id\": \"30cc29e3-c872-4a3a-92c4-0bfce96293a2\",\n \"name\": \"trey64\"\n },\n {\n \"id\": \"14e70654-e38b-42a4-857a-fb6dc137cd42\",\n \"name\": \"keshawn25\"\n }\n ]\n }, {\n \"id\": \"c75b8a57-581d-4e08-9974-d73899c92641\",\n \"text\": \"Answer #2\",\n \"voted\": 0\n }, {\n \"id\": \"aebaa80b-a04f-4f9c-9879-e55dddb8c450\",\n \"text\": \"Answer #3\",\n \"voted\": 1,\n \"voters\": [\n {\n \"id\": \"30cc29e3-c872-4a3a-92c4-0bfce96293a2\",\n \"name\": \"trey64\"\n }\n ]\n }\n ]\n }, {\n \"id\": \"a3abb77f-289f-475f-afe5-d79b000be363\",\n \"question\": \"Question #2\",\n \"voted\": 1,\n \"votes\": [\n {\n \"id\": \"c5e67619-3979-4dce-a070-a7564f03663a\",\n \"text\": \"Answer #1\",\n \"voted\": 0\n }, {\n \"id\": \"f999d0f5-1b7f-4365-8420-d837d54823f4\",\n \"text\": \"Answer #2.\",\n \"voted\": 1,\n \"voters\": [\n {\n \"id\": \"30cc29e3-c872-4a3a-92c4-0bfce96293a2\",\n \"name\": \"trey64\"\n }\n ]\n }\n ]\n }\n ]\n }\n]", "name": "" } ] }, { "name": "Create quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"My quiz.\",\"timing_mode\":\"quiz\",\"time_limit_seconds\":1,\"passing_score\":22,\"questions\":{\"0\":{\"text\":\"svujmhuzypfpeceznsgd\",\"multiple\":true,\"choices\":[{\"text\":\"xefpnodgritgw\",\"correct\":true}]},\"text\":\"My question\",\"multiple\":true,\"choices\":{\"text\":\"My answer\",\"correct\":true}},\"time_limit_minutes\":60}" }, "description": "Create a new quiz." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"d84a4ad8-b051-4af5-b885-08663e9e401a\",\n \"title\": \"My quiz\",\n \"time_limit_minutes\": 90,\n \"status\": \"created\",\n \"questions\": [\n {\n \"id\": \"b4de7c9c-b4fb-4f2c-87f6-ee9395d79198\",\n \"text\": \"Question #1\",\n \"multiple\": false,\n \"choices\": [\n {\n \"id\": \"b89aec8f-8c1c-46b1-b5e8-8245940041ac\",\n \"text\": \"Correct answer\",\n \"correct\": true\n }, {\n \"id\": \"4db512ce-46f2-48e6-a90b-b67499b15092\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }\n ]\n }, {\n \"id\": \"56ae59e7-2c9b-4a01-ae66-f26309f9c672\",\n \"text\": \"Question #2\",\n \"multiple\": true,\n \"choices\": [\n {\n \"id\": \"9196ddcc-400b-49d8-a57a-25ad7b652071\",\n \"text\": \"Correct answer #1\",\n \"correct\": true\n }, {\n \"id\": \"6eccae14-c478-43d8-b3d5-c4e484d5a148\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }, {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"text\": \"Correct answer #2\",\n \"correct\": true\n }\n ]\n }\n ],\n \"created_at\": \"2025-12-19T05:38:51Z\"\n}", "name": "" } ] }, { "name": "Update quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/:quiz", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/:quiz", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "quiz", "key": "quiz", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the quiz." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"My quiz.\",\"timing_mode\":\"quiz\",\"time_limit_seconds\":65,\"passing_score\":20,\"questions\":{\"0\":{\"text\":\"cbcmxgmgkkzej\",\"multiple\":false,\"choices\":[{\"text\":\"jtfvzacw\",\"correct\":true,\"id\":\"4fc63106-2f0a-3079-9097-db9c6367701d\"}],\"id\":\"4901d1d9-b0b6-3169-8b91-5c2b8e967bac\"},\"id\":\"0eb58aa7-a956-483d-a333-90cefb7748b3\",\"text\":\"My question\",\"multiple\":false,\"choices\":{\"id\":\"fae5eda8-611e-4d65-82f0-8653a0106f76\",\"text\":\"My answer\",\"correct\":true}},\"time_limit_minutes\":60}" }, "description": "Update the specified quiz." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"d84a4ad8-b051-4af5-b885-08663e9e401a\",\n \"title\": \"My quiz\",\n \"time_limit_minutes\": 90,\n \"status\": \"created\",\n \"questions\": [\n {\n \"id\": \"b4de7c9c-b4fb-4f2c-87f6-ee9395d79198\",\n \"text\": \"Question #1\",\n \"multiple\": false,\n \"choices\": [\n {\n \"id\": \"b89aec8f-8c1c-46b1-b5e8-8245940041ac\",\n \"text\": \"Correct answer\",\n \"correct\": true\n }, {\n \"id\": \"4db512ce-46f2-48e6-a90b-b67499b15092\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }\n ]\n }, {\n \"id\": \"56ae59e7-2c9b-4a01-ae66-f26309f9c672\",\n \"text\": \"Question #2\",\n \"multiple\": true,\n \"choices\": [\n {\n \"id\": \"9196ddcc-400b-49d8-a57a-25ad7b652071\",\n \"text\": \"Correct answer #1\",\n \"correct\": true\n }, {\n \"id\": \"6eccae14-c478-43d8-b3d5-c4e484d5a148\",\n \"text\": \"Wrong answer\",\n \"correct\": false\n }, {\n \"id\": \"cbe49091-3b4d-4c1b-9ea6-bdf6594e799d\",\n \"text\": \"Correct answer #2\",\n \"correct\": true\n }\n ]\n }\n ],\n \"created_at\": \"2025-12-19T05:38:51Z\"\n}", "name": "" } ] }, { "name": "Delete quiz.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/quizzes\/:quiz", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/quizzes\/:quiz", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room." }, { "id": "quiz", "key": "quiz", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the quiz." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the specified quiz." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Live", "description": "", "item": [ { "name": "Get rooms with live participants count.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/live", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/live?limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 3,\n \"data\": [{\n \"id\": \"ecd0fa17-b1c6-3f35-99c3-ce6cd81afca8\",\n \"external_id\": \"EXTID824955915\",\n \"start_time\": \"2022-05-13T12:31:19.000000Z\",\n \"session_duration\": 11408,\n \"live_participants\": 27\n }, {\n \"id\": \"554265e0-9fd7-3408-ace4-249e00b024f1\",\n \"external_id\": \"EXTID1504059250\",\n \"start_time\": \"2022-05-13T10:22:42.000000Z\",\n \"session_duration\": 2726,\n \"live_participants\": 3\n }, {\n \"id\": \"abb8cc46-6b87-3aae-80b0-82e8943ed0d4\",\n \"external_id\": \"EXTID69285216\",\n \"start_time\": \"2022-05-13T11:13:29.000000Z\",\n \"session_duration\": 1183,\n \"live_participants\": 55\n }]\n}\n", "name": "" } ] }, { "name": "Get rooms with live participants data.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/live\/participants", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the room or room friendly URL after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/live\/participants?limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 5,\n \"data\": [{\n \"id\": \"b31155d3-19ad-3d4d-bde6-c5ec9172d9b7\",\n \"external_id\": \"EXTID1251839424\",\n \"start_time\": \"2022-05-16T12:51:54.000000Z\",\n \"session_duration\": 2580,\n \"live_participants\": [{\n \"id\": \"4354aa20-9906-45ed-9b02-799525e1dbc3\",\n \"external_id\": \"EXTID1916626560\",\n \"name\": \"Gwendolyn Hayes\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"898964d2-9951-4734-8eea-77fa72fd137d\",\n \"external_id\": \"EXTID657371078\",\n \"name\": \"Mrs. Mya Schroeder PhD\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"73c8f78f-0b80-4a76-8fa3-1d11705a5fa3\",\n \"external_id\": \"EXTID229839886\",\n \"name\": \"Gregg Runte\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"2fdc809a-e981-46a2-bc67-84c15ca7efd5\",\n \"external_id\": \"EXTID1261882350\",\n \"name\": \"Angelina Treutel I\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"19650289-6171-4c45-a7a2-0e66fb5c29a0\",\n \"external_id\": \"EXTID2009248764\",\n \"name\": \"Verdie Jacobs\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }]\n }, {\n \"id\": \"b623bc65-4cd8-316e-905b-213af2ed362d\",\n \"external_id\": \"EXTID2082633660\",\n \"start_time\": \"2022-05-16T12:51:54.000000Z\",\n \"session_duration\": 2580,\n \"live_participants\": [{\n \"id\": \"59852f2b-b25a-43c6-927c-7a3c2634deef\",\n \"external_id\": \"EXTID1005303666\",\n \"name\": \"Stacey McLaughlin\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"3765c44f-b629-4bb3-8304-805c71b01fe5\",\n \"external_id\": \"EXTID310825640\",\n \"name\": \"Stewart Roob\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"c596f874-bf88-4865-a77b-44f9e3285f5b\",\n \"external_id\": \"EXTID1492362491\",\n \"name\": \"Miss Samantha Mayert\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"4930aee0-f4ab-4203-9054-b3932e94b015\",\n \"external_id\": \"EXTID462108878\",\n \"name\": \"Earl Buckridge\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"3f6dca1f-92b0-4147-81ee-754754cb00d1\",\n \"external_id\": \"EXTID1790509806\",\n \"name\": \"Colin Dickens\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }]\n }, {\n \"id\": \"2473e7b1-406c-3e05-93cb-57c6a6ba6e60\",\n \"external_id\": \"EXTID209019793\",\n \"start_time\": \"2022-05-16T12:51:54.000000Z\",\n \"session_duration\": 2580,\n \"live_participants\": [{\n \"id\": \"c6a73ece-77b3-47f6-b614-7b949cddd2fe\",\n \"external_id\": \"EXTID617498776\",\n \"name\": \"Prof. Forrest Ritchie V\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"e4d23870-ed35-4901-9cfd-47bddb6a035a\",\n \"external_id\": \"EXTID1665145569\",\n \"name\": \"Shany Torphy\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"e9c6a70d-6528-404e-88ea-4994578b56e1\",\n \"external_id\": \"EXTID401347102\",\n \"name\": \"Lera Zboncak DVM\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"0ef1fd7f-acda-4b0a-94f5-ee411d16cd86\",\n \"external_id\": \"EXTID597760933\",\n \"name\": \"Leon Daugherty I\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"c76a28e9-b0d4-4d08-aa24-c869289ccc39\",\n \"external_id\": \"EXTID2020171092\",\n \"name\": \"Oswald Hickle\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }]\n }, {\n \"id\": \"6328914f-19a0-397a-99dc-4cd49570cffc\",\n \"external_id\": \"EXTID1928952811\",\n \"start_time\": \"2022-05-16T12:51:34.000000Z\",\n \"session_duration\": 2600,\n \"live_participants\": [{\n \"id\": \"03a82571-3327-439d-ba57-8515302f0ee6\",\n \"external_id\": \"EXTID2098450034\",\n \"name\": \"Mrs. Icie Funk\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"22fde4ce-6fea-4c1b-85e9-14ae60c7b452\",\n \"external_id\": \"EXTID2077221187\",\n \"name\": \"Sonia Kulas\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"5ea800db-8c88-4f99-a6d2-a292016bfa9b\",\n \"external_id\": \"EXTID1543982160\",\n \"name\": \"Lisette Gerhold\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"a360431a-1e2e-45c2-8b74-67ce84585532\",\n \"external_id\": \"EXTID222171890\",\n \"name\": \"Vita Mann\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"bafa6f48-1992-45aa-bd72-6d10b08bb576\",\n \"external_id\": \"EXTID1015346028\",\n \"name\": \"Darien Powlowski\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }]\n }, {\n \"id\": \"f9716453-8e9f-39a4-b2f2-c1d00228411e\",\n \"external_id\": \"EXTID632729761\",\n \"start_time\": \"2022-05-16T12:51:00.000000Z\",\n \"session_duration\": 2634,\n \"live_participants\": [{\n \"id\": \"aed005c5-69db-40f7-9785-395c545fed64\",\n \"external_id\": \"EXTID2128980420\",\n \"name\": \"Devante Stamm DVM\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"b8f2422e-a524-4ced-8cb2-9219bcdd5ec7\",\n \"external_id\": \"EXTID1153236013\",\n \"name\": \"Magnolia D'Amore\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"e58b84d4-b370-4389-9710-8935ac9d71ef\",\n \"external_id\": \"EXTID1466108903\",\n \"name\": \"Dr. Chauncey Franecki\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"3a7c8ad3-8082-4d2e-86f9-ffbddaff6a7b\",\n \"external_id\": \"EXTID778875197\",\n \"name\": \"Deborah Vandervort III\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }, {\n \"id\": \"35a65ef1-06f1-4ee1-a8cf-6e032fac227a\",\n \"external_id\": \"EXTID206934569\",\n \"name\": \"Callie DuBuque\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:51:54.000000Z\"\n }]\n }]\n}\n", "name": "" } ] }, { "name": "Get single room with live participants count.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/live", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/live", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"c2d64b46-cc89-3830-890b-f81ccb2f882c\",\n \"external_id\": \"EXTID1688929106\",\n \"start_time\": \"2022-05-16T12:12:54.000000Z\",\n \"session_duration\": 1408,\n \"live_participants\": 17\n}\n", "name": "" } ] }, { "name": "Get single room with live participants' data.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/live\/participants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/live\/participants", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"4e68be68-f505-3827-81f7-72fa76f42de9\",\n \"external_id\": \"EXTID852602699\",\n \"start_time\": \"2022-05-16T12:48:18.000000Z\",\n \"session_duration\": 1408,\n \"live_participants\": [{\n \"id\": \"928f1a06-921b-446f-9d23-b78e96523563\",\n \"external_id\": \"EXTID2113427821\",\n \"name\": \"Unique Reynolds\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:48:18.000000Z\"\n }, {\n \"id\": \"d9f72e6f-61e7-4722-919f-d850f315d49c\",\n \"external_id\": \"EXTID524240932\",\n \"name\": \"Susie Luettgen\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:50:22.000000Z\"\n }, {\n \"id\": \"598f9761-4fa3-4b47-bde7-0cc05228ff36\",\n \"external_id\": \"EXTID766750985\",\n \"name\": \"Prof. Juliet Kunde I\",\n \"role\": \"participant\",\n \"join_time\": \"2022-05-16T12:19:31.000000Z\"\n }]\n}\n", "name": "" } ] } ] }, { "name": "Statistics", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get team global statistics by period.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statistics", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/statistics?date_start=&date_end=&metrics=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{ \n \"participation_minutes\": 3500,\n \"desktop_participation_minutes\": 1500,\n \"mobile_participation_minutes\": 1000,\n \"tablet_participation_minutes\": 900,\n \"smarttv_participation_minutes\": 100,\n \"broadcasted_minutes\": 2500,\n \"subscribed_minutes\": 1000,\n \"screen_broadcasted_minutes\": 1000,\n \"screen_subscribed_minutes\": 100,\n \"active_participants\": 35,\n \"max_concurrent_participants\": 10,\n \"desktop_participants\": 15,\n \"mobile_participants\": 10,\n \"tablet_participants\": 10,\n \"smarttv_participants\": 5,\n \"sessions\": 10,\n \"rooms\": 5,\n \"max_concurrent_sessions\": 3,\n \"max_concurrent_participants_per_session\": 10,\n \"live_participants\": 10,\n \"recorded_minutes\": 590,\n \"max_active_recorders\": 3,\n \"transcription_minutes\": 520,\n \"e2ee_minutes\": 850,\n \"stored_recorded_minutes\": 960,\n \"whiteboard_minutes\": 59,\n \"captions_minutes\": 65,\n \"active_roles\": 2,\n \"custom_roles\": 3,\n \"breakout_minutes\": 860,\n \"presentation_minutes\": 52,\n \"public_chat_posts\": 125,\n \"questions\": 5,\n \"answers\": 10,\n \"polls\": 5,\n \"summaries\": 7,\n \"date_start\": \"2024-03-07\",\n \"date_end\": \"2024-04-07\"\n} ", "name": "" } ] }, { "name": "Get team global statistics by current period.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statistics\/team\/current", "query": [ { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/statistics\/team\/current?metrics=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{ \n \"participation_minutes\": 3500,\n \"desktop_participation_minutes\": 1500,\n \"mobile_participation_minutes\": 1000,\n \"tablet_participation_minutes\": 900,\n \"smarttv_participation_minutes\": 100,\n \"broadcasted_minutes\": 2500,\n \"subscribed_minutes\": 1000,\n \"screen_broadcasted_minutes\": 1000,\n \"screen_subscribed_minutes\": 100,\n \"active_participants\": 35,\n \"max_concurrent_participants\": 10,\n \"desktop_participants\": 15,\n \"mobile_participants\": 10,\n \"tablet_participants\": 10,\n \"smarttv_participants\": 5,\n \"sessions\": 10,\n \"rooms\": 5,\n \"max_concurrent_sessions\": 3,\n \"max_concurrent_participants_per_session\": 10,\n \"live_participants\": 10,\n \"recorded_minutes\": 590,\n \"max_active_recorders\": 3,\n \"transcription_minutes\": 520,\n \"e2ee_minutes\": 850,\n \"stored_recorded_minutes\": 960,\n \"whiteboard_minutes\": 59,\n \"captions_minutes\": 65,\n \"active_roles\": 2,\n \"custom_roles\": 3,\n \"breakout_minutes\": 860,\n \"presentation_minutes\": 52,\n \"public_chat_posts\": 125,\n \"questions\": 5,\n \"answers\": 10,\n \"polls\": 5,\n \"summaries\": 7,\n \"date_start\": \"2024-03-07\",\n \"date_end\": \"2024-04-07\"\n} ", "name": "" } ] }, { "name": "Get team statistics for current period.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statistics\/current", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statistics\/current" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"participation_minutes\": 2968,\n \"live_sessions\": 5,\n \"live_participants\": 25,\n \"active_recorders\": 2,\n \"recorded_minutes\": 181,\n \"transcription_minutes\": 289,\n \"stored_recorded_minutes\": 15,\n \"max_concurrent_participants\": 30,\n \"max_concurrent_sessions\": 10,\n \"date_start\": \"2024-02-22\",\n \"date_end\": \"2024-03-22\"\n} ", "name": "" } ] }, { "name": "Get team global statistics by tags.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statistics\/totals", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statistics\/totals" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"tag\": \"common\",\n \"rooms\": 10,\n \"participants\": 55,\n \"participation_minutes\": 324\n },\n {\n \"tag\": \"my-tag\",\n \"rooms\": 5,\n \"participants\": 14,\n \"participation_minutes\": 95\n }\n]", "name": "" } ] }, { "name": "Get started sessions by participant UUIDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statistics\/participants\/started-sessions", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/statistics\/participants\/started-sessions?date_start=&date_end=&limit=20&offset=0" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 5,\n \"data\": [\n {\n \"browser_id\": \"d0788660-feab-3034-9589-cabaa5cbf31d\",\n \"sessions_started\": 12\n },\n {\n \"browser_id\": \"253c01f6-5df5-3494-b291-3bee1350cb3d\",\n \"sessions_started\": 9\n },\n {\n \"browser_id\": \"e8631bc6-7e73-3cb0-b801-5e1739b85fdf\",\n \"sessions_started\": 5\n },\n {\n \"browser_id\": \"43844ab6-de1c-3f2c-b2db-2df25449d688\",\n \"sessions_started\": 2\n },\n {\n \"browser_id\": \"f90365b0-fdf6-36ac-89ab-fd096495e95e\",\n \"sessions_started\": 1\n }\n ]\n}", "name": "" } ] }, { "name": "Get room statistics by period.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/statistics", "query": [ { "key": "date_start", "value": "", "description": "Period start date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "date_end", "value": "", "description": "Period end date. Must be a valid date in the format Y-m-d.", "disabled": true }, { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/statistics?date_start=&date_end=&metrics=", "variable": [ { "id": "room", "key": "room", "value": "--w-----", "description": "The room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"room_id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"room_external_id\": \"EXTID123\",\n \"room_description\": \"Some public room\",\n \"room_friendly_url\": \"MyPublicRoom\",\n \"room_privacy\": \"public\",\n \"room_source\": \"api\",\n \"room_max_participants\": 100,\n \"room_is_deleted\": false,\n \"participation_minutes\": 422,\n \"desktop_participation_minutes\": 222,\n \"mobile_participation_minutes\": 100,\n \"tablet_participation_minutes\": 75,\n \"smarttv_participation_minutes\": 25,\n \"broadcasted_minutes\": 10,\n \"subscribed_minutes\": 10,\n \"screen_broadcasted_minutes\": 5,\n \"screen_subscribed_minutes\": 5,\n \"live_participants\": 0,\n \"active_participants\": 10,\n \"desktop_participants\": 5,\n \"mobile_participants\": 2,\n \"tablet_participants\": 2,\n \"smarttv_participants\": 1,\n \"sessions\": 11,\n \"max_concurrent_participants\": 5,\n \"transcription_minutes\": 52,\n \"e2ee_minutes\": 30,\n \"recorded_minutes\": 40,\n \"stored_recorded_minutes\": 748,\n \"whiteboard_minutes\": 4,\n \"captions_minutes\": 10,\n \"active_roles\": 2,\n \"breakout_minutes\": 4,\n \"presentation_minutes\": 0,\n \"public_chat_posts\": 2,\n \"questions\": 12,\n \"answers\": 10,\n \"polls\": 2,\n \"summaries\": 5,\n \"date_start\": \"2024-02-27\",\n \"date_end\": \"2024-03-27\"\n}", "name": "" } ] }, { "name": "Get room statistics by current period.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/statistics\/current", "query": [ { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/statistics\/current?metrics=", "variable": [ { "id": "room", "key": "room", "value": "ww--", "description": "The room." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"room_id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"room_external_id\": \"EXTID123\",\n \"room_description\": \"Some public room\",\n \"room_friendly_url\": \"MyPublicRoom\",\n \"room_privacy\": \"public\",\n \"room_source\": \"api\",\n \"room_max_participants\": 100,\n \"room_is_deleted\": false,\n \"participation_minutes\": 422,\n \"desktop_participation_minutes\": 222,\n \"mobile_participation_minutes\": 100,\n \"tablet_participation_minutes\": 75,\n \"smarttv_participation_minutes\": 25,\n \"broadcasted_minutes\": 10,\n \"subscribed_minutes\": 10,\n \"screen_broadcasted_minutes\": 5,\n \"screen_subscribed_minutes\": 5,\n \"live_participants\": 0,\n \"active_participants\": 10,\n \"desktop_participants\": 5,\n \"mobile_participants\": 2,\n \"tablet_participants\": 2,\n \"smarttv_participants\": 1,\n \"sessions\": 11,\n \"max_concurrent_participants\": 5,\n \"transcription_minutes\": 52,\n \"e2ee_minutes\": 30,\n \"recorded_minutes\": 40,\n \"stored_recorded_minutes\": 748,\n \"whiteboard_minutes\": 4,\n \"captions_minutes\": 10,\n \"active_roles\": 2,\n \"breakout_minutes\": 4,\n \"presentation_minutes\": 0,\n \"public_chat_posts\": 2,\n \"questions\": 12,\n \"answers\": 10,\n \"polls\": 2,\n \"summaries\": 5,\n \"date_start\": \"2024-02-27\",\n \"date_end\": \"2024-03-27\"\n}", "name": "" } ] }, { "name": "Get session statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/sessions\/:session\/statistics", "query": [ { "key": "metrics", "value": "", "description": "Metrics in the result dataset, set field names under comma (Ex: participation_minutes,broadcasted_minutes,subscribed_minutes).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/sessions\/:session\/statistics?metrics=", "variable": [ { "id": "session", "key": "session", "value": "consequatur", "description": "The session." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"room_id\": \"13a5aa53-f4da-470b-bfd0-63dd9e5dd81d\",\n \"room_external_id\": \"EXTID123\",\n \"room_description\": \"Some public room\",\n \"room_friendly_url\": \"MyPublicRoom\",\n \"room_privacy\": \"public\",\n \"room_source\": \"api\",\n \"room_max_participants\": 100,\n \"room_is_deleted\": false,\n \"session_id\": \"0c843bf8-d245-450c-94fb-31e8a861bfaf\",\n \"session_duration\": 60,\n \"session_live\": false,\n \"session_start_time\": \"2022-05-09T15:25:21Z\",\n \"session_end_time\": \"2022-05-09T15:57:25Z\",\n \"participation_minutes\": 67,\n \"desktop_participation_minutes\": 50,\n \"mobile_participation_minutes\": 10,\n \"tablet_participation_minutes\": 7,\n \"smarttv_participation_minutes\": 0,\n \"broadcasted_minutes\": 15,\n \"subscribed_minutes\": 0,\n \"screen_broadcasted_minutes\": 0,\n \"screen_subscribed_minutes\": 0,\n \"live_participants\": 0,\n \"active_participants\": 4,\n \"desktop_participants\": 2,\n \"mobile_participants\": 1,\n \"tablet_participants\": 1,\n \"smarttv_participants\": 0,\n \"max_concurrent_participants\": 3,\n \"transcription_minutes\": 20,\n \"e2ee_minutes\": 0,\n \"recorded_minutes\": 90,\n \"stored_recorded_minutes\": 60,\n \"whiteboard_minutes\": 0,\n \"captions_minutes\": 10,\n \"breakout_minutes\": 0,\n \"presentation_minutes\": 0,\n \"active_roles\": 2,\n \"public_chat_posts\": 52,\n \"questions\": 2,\n \"answers\": 3,\n \"polls\": 1\n}", "name": "" } ] }, { "name": "Get participant statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/participants\/:participant\/statistics", "query": [], "raw": "{{baseUrl}}\/api\/v1\/participants\/:participant\/statistics", "variable": [ { "id": "participant", "key": "participant", "value": "provident", "description": "The participant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{ \n \"room_id\": \"9af9933c-5b43-3279-a7bb-7e7809210e9e\",\n \"room_external_id\": \"308bf674-8610-35cb-a378-e2c54f2fc976\",\n \"room_friendly_url\": \"UoZhS97JdgTqxj4qVgPWyD_F8eBdW5Si\",\n \"room_privacy\": \"public\",\n \"room_is_deleted\": false,\n \"session_id\": \"fc355508-8064-4367-96c2-21ef571beee5\",\n \"live\": false,\n \"participant_name\": \"Madisyn Howe\",\n \"role\": \"moderator\",\n \"join_time\": \"2024-03-31T15:27:43Z\",\n \"leave_time\": \"2024-03-31T15:36:43Z\",\n \"device\": \"desktop\",\n \"system\": \"Mac OS X 10\",\n \"browser\": \"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_6_3 rv:6.0) Gecko\/20190126 Firefox\/35.0\",\n \"e2ee\": false,\n \"participation_minutes\": 9,\n \"public_chat_posts\": 2,\n \"questions\": 3,\n \"answers\": 2\n} ", "name": "" } ] } ] }, { "name": "Transcripts", "description": "\nDocumentation<\/a>", "item": [ { "name": "Start transcription.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/transcription\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/transcription\/start", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] }, { "name": "Stop transcription.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/transcription\/stop", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/transcription\/stop", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "HTTP\/1.1 200 OK", "name": "" } ] } ] }, { "name": "Webhooks", "description": "\nDocumentation<\/a>", "item": [ { "name": "Get webhooks events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/events", "query": [], "raw": "{{baseUrl}}\/api\/v1\/events" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get available events used for triggering webhooks" }, "response": [ { "header": [], "code": 200, "body": "[\n \"participant_joined\",\n \"participant_left\"\n]", "name": "" } ] }, { "name": "Get webhooks for the team.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [ { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the webhook after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/webhooks?limit=20&offset=0&order=asc&after=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"edaa3a8f-4fe9-477f-8d2a-55900ec08b3c\",\"endpoint\":\"http:\\\/\\\/jacobi.com\\\/aut-officia-repellendus-harum-magnam-dolores-sint-unde\",\"authorization_header\":\"94d4efa97944bd9f8f863cd2ad2a8482\",\"name\":\"My webhook 7\",\"created_at\":\"2026-05-08T14:36:58Z\",\"updated_at\":\"2026-05-08T14:36:58Z\"},{\"id\":\"9223a880-1317-473c-bfb3-848c646674bc\",\"endpoint\":\"http:\\\/\\\/www.breitenberg.com\\\/ex-odit-consequatur-facere-et\",\"authorization_header\":\"a2c30d316c541de1b519a55bd6689959\",\"name\":\"My webhook 7\",\"created_at\":\"2026-05-08T14:36:58Z\",\"updated_at\":\"2026-05-08T14:36:58Z\"}],\"total_count\":\"2\"}", "name": "" } ] }, { "name": "Get the specified webhook.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the webhook." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"f4b9c58a-3612-46ac-9331-7dabd80b8d0b\",\"endpoint\":\"https:\\\/\\\/www.miller.net\\\/ut-deleniti-repellendus-quasi-aut-consequatur-iure\",\"authorization_header\":\"07ba4e02ad549511949342b18de5a0af\",\"name\":\"My webhook 9\",\"events\":[\"participant_occaecati\"],\"created_at\":\"2026-05-08T14:36:59Z\",\"updated_at\":\"2026-05-08T14:36:59Z\"}", "name": "" } ] }, { "name": "Create a new webhook.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"endpoint\":\"https:\\\/\\\/example.com\\\/webhook-for-join\",\"name\":\"Join Webhook\",\"authorization_header\":\"2BULvsea4JtiGRiSDSJSI%3DEUifiRBkKG5E2XzMDjRfl76ZC9Ub0wnz4XsNiRVBChTYbJcE3F\",\"events\":[\"participant_joined\",\"participant_left\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"fd3df7b9-e8b7-472e-9b8e-e219ae7e0180\",\"endpoint\":\"http:\\\/\\\/www.schimmel.com\\\/voluptates-ut-impedit-omnis-est-possimus-incidunt\",\"authorization_header\":\"0bf252489fd28ff73ef188add5310657\",\"name\":\"My webhook 8\",\"events\":[\"participant_sapiente\"],\"created_at\":\"2026-05-08T14:36:59Z\",\"updated_at\":\"2026-05-08T14:36:59Z\"}", "name": "" } ] }, { "name": "Update the specified webhook.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the webhook." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"endpoint\":\"https:\\\/\\\/example.com\\\/webhook-for-join\",\"name\":\"Join Webhook\",\"authorization_header\":\"2BULvsea4JtiGRiSDSJSI%3DEUifiRBkKG5E2XzMDjRfl76ZC9Ub0wnz4XsNiRVBChTYbJcE3F\",\"events\":[\"participant_joined\",\"participant_left\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"41773682-6d3c-40d6-b6e5-026a4af26a11\",\"endpoint\":\"http:\\\/\\\/marquardt.com\\\/dolorem-perferendis-sunt-necessitatibus-pariatur-ea\",\"authorization_header\":\"786dc05b9caeb8334f55b784c340bdab\",\"name\":\"My webhook 9\",\"events\":[\"participant_labore\"],\"created_at\":\"2026-05-08T14:36:59Z\",\"updated_at\":\"2026-05-08T14:36:59Z\"}", "name": "" } ] }, { "name": "Delete the specified webhook.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the webhook." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Q&A", "description": "", "item": [ { "name": "Get questions and answers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions", "query": [ { "key": "session_id", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "UUID of the session.", "disabled": false }, { "key": "limit", "value": "20", "description": "Limit the number of returned records. Used for pagination. Maximum and default is 100", "disabled": false }, { "key": "offset", "value": "0", "description": "The offset of the first item returned in the records collection. Used for pagination.", "disabled": true }, { "key": "order", "value": "asc", "description": "Order of returned records. Default is desc.", "disabled": false }, { "key": "after", "value": "", "description": "The UUID of the question after which records will be returned.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions?session_id=16719c1b-cc82-4dfe-9f6f-40d9093fa695&limit=20&offset=0&order=asc&after=", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated<\/small>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_count\": 1,\n \"data\": [\n {\n \"id\": \"3d8a123d-1a65-4b8b-a1d7-cde0578bf928\",\n \"question\": \"How tall is the Statue of Liberty?\",\n \"participant_id\": \"5e54e7e0-2639-4307-aafa-9eb957e20c2d\",\n \"external_participant_id\": \"#123\",\n \"participant_name\": \"John Smith\",\n \"created_at\": \"2024-02-13T16:45:05.000000Z\",\n \"answers\": [\n {\n \"id\": \"856e86e5-5d97-4a48-978a-6b8afe65f749\",\n \"answer\": \"It is 46 metres high.\",\n \"participant_id\": \"685dacb3-5943-4661-a37d-d218586b8b6d\",\n \"external_participant_id\": \"#456\",\n \"participant_name\": \"John Doe\",\n \"created_at\": \"2024-02-13T16:45:30.000000Z\"\n },\n {\n \"id\": \"29817328-b632-4741-8ba2-09d393bd2fb0\",\n \"answer\": \"Yep, about 46 metres high.\",\n \"participant_id\": \"d0f509a4-7aee-496a-a331-d44c0df6bdd7\",\n \"external_participant_id\": \"#789\",\n \"participant_name\": \"Jane Doe\",\n \"created_at\": \"2024-02-13T16:45:35.000000Z\"\n }\n ]\n }\n ]\n}", "name": "" } ] }, { "name": "Create a question in the room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"},\"question\":\"My question?\",\"anonymous\":true,\"breakout_id\":\"a853d608-e6cf-48eb-a3c9-7d089bbc09b0\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Update question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"},\"question\":\"My question?\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Delete question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Dismiss question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/dismiss", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/dismiss", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Reopen question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/reopen", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/reopen", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Upvote question.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/vote", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/vote", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Remove question vote.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/vote", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/vote", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Answer question in the room.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/answers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/answers", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"},\"answer\":\"My answer\",\"private\":true}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=eNlQ5FzKbtjiGWIc52gRepQ69BhVixYdvCB599i7; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=9vEW4BUvOGV1aoBrTWsoYSdQlri2synvPWUiMs3w; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Update answer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/answers\/:answer", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/answers\/:answer", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." }, { "id": "answer", "key": "answer", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the answer." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"},\"answer\":\"My answer\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=R38weCevRgNSu7F6RFaMhEGpcI81QZG35QtR6IIK; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "set-cookie", "value": "digital_samba_embedded_session=ARTVPdxIacn3mukGbKOBIkRrMb9VAH8Mz9Dgu53N; expires=Fri, 08 May 2026 16:36:55 GMT; Max-Age=7200; path=\/; httponly; samesite=strict" } ], "code": 404, "body": "{\"message\":\"Not Found\",\"error\":\"not-found\"}", "name": "" } ] }, { "name": "Delete answer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/answers\/:answer", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/answers\/:answer", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." }, { "id": "answer", "key": "answer", "value": "5ce6fda5-d42b-4110-8796-177e571a7407", "description": "The UUID of the answer." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Start a live answer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/start", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Stop a live answer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/stop", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/stop", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] }, { "name": "Cancel a live answer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/rooms\/:room\/questions\/:question\/live-answers\/cancel", "variable": [ { "id": "room", "key": "room", "value": "a853d608-e6cf-48eb-a3c9-7d089bbc09b0", "description": "The UUID of the room or room friendly URL." }, { "id": "question", "key": "question", "value": "16719c1b-cc82-4dfe-9f6f-40d9093fa695", "description": "The UUID of the question." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant\":{\"id\":\"5b9ca00e-656e-43cc-ba2c-7dcaae63daa9\",\"name\":\"John Doe\",\"external_id\":\"ABCDEF123\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "bearer", "type": "string" } ] } }