In-client app features

View as Markdown

The information in the in_client_feature section of the manifest JSON represents the values on the Surface > In-client app features page of the app build flow.

Manifest JSON

{
    "features": {
        // ......
        "in_client_feature": {
            "zoom_app_api": {
                "enable": true,
                "zoom_app_apis": [
                    "getSupportedJsApis",
                    "onShareApp"
                ]
            },
            "guest_mode": {
                "enable": true,
                "enable_test_guest_mode": true
            },
            "in_client_oauth": {
                "enable": true
            },
            "collaborate_mode": {
                "enable": true,
                "enable_screen_sharing": true,
                "enable_play_together": true,
                "enable_start_immediately": true,
                "enable_join_immediately": true
            },
            "team_chat_tab": {
                "enable_home_tab": false,
                "enable_channel_tab": false
            }
        },
        // ......
    }
}

Field Description

FieldDescriptionRequired
zoom_app_api.enableEnable to use APIs and events in the Zoom client.

User Level is for Meetings, Webinars, Chat, Contact Center, Phone, Rooms.

Account Level is for Chat, Rooms.
No
zoom_app_api.zoom_app_apisSelect the APIs and events that you want to use in the Zoom client app.No
guest_mode.enableEnable participants to join meetings without requiring authentication.
Learn more

This feature is only available for User-managed apps.

User Level is for Meetings, Webinars.
No
guest_mode.enable_test_guest_modeTest the Guest Mode feature before publishing your app.No
in_client_oauth.enableUsers can complete the authorization in Zoom client without opening the system browser. Learn more

User Level works in Meetings, Webinars, Chat, Contact Center, Phone, Rooms.

Account Level works in Rooms.
No
collaborate_mode.enableCollaborate mode enables Zoom App users to instantly collaborate with other meeting participants.
This feature is only available for user-managed apps.

User Level works in Meetings, Webinars.
No
collaborate_mode.enable_screen_sharingEnable screen sharing of the app canvas from the user who initiated collaborate mode.No
collaborate_mode.enable_play_togetherEnable this to change the calls to action in the interface from "Collaborate" to "Play Together".No
collaborate_mode.enable_start_immediatelyEnable to start collaborate mode immediately after clicking the Collaborate button.No
collaborate_mode.enable_join_immediatelyEnable to join collaborate mode immediately after clicking the Join button in the invitation.No
team_chat_tab.enable_home_tabAllow users to access your app from a Home tab.No
team_chat_tab.enable_channel_tabAllow users to access your app from a tab within Chat channels.No