Zoom Scopes for Chat
When adding our live chat application to Zoom, we request certain scopes in order to properly run the application. This article will cover when we use these scopes.
1.0 Oauth and First Time Provisioning Flow
Scope required: View All User Information
We use your email and name to create an account in Social Intents when you add the Live Chat app to Zoom the first time.
Start by clicking Add to Zoom here or from our Zoom Live Chat Landing Page.
Once you trigger the oauth flow, we will look up the your info and create a trial account in Social Intents for this email address if it does not yet exist.
Upon successful provisioning, you’ll will see the first onboarding page:
Click I’m Done to move on.
At this point, the new Social Intents trial account has been created by looking up the user info for the person who added the application to Zoom.
1.1 Listing Zoom Channels on the website
Scopes required: View and Manage all users chat channels
Next we will go to the Live Chat settings and verify that the channel selected in Zoom is the one you want to send live chats to. By default we create a channel called Live Chat Inbound. That's why this scope is required.
Click on the Edit Settings button to go into the Live Chat settings. If you see the Live Chat Inbound channel list or other items in this list, then the channels API has been called using the Access token generated in Oauth.
Next we will go to the Zoom Client itself to verify functionality.
1.2 Welcome Message sent to Zoom
Scope required: Enable Chat Bot within Zoom Chat Client
We send a Welcome message and relay all live chat requests from your website to Zoom using this Scope.
After adding live chat to Zoom you should see a Welcome message in the Inbound Live Chat channel that we created. We also send a direct message as the Live Chat bot to the user who added the Live Chat application.
1.3 Test a Live Chat for the User who added the Live Chat app
Scope required: View all users chat messages, Enable Chatbot within Zoom Chat Client
Click on the ‘Test your live chat’ link in the Welcome message to test a chat. If you prefer to deploy to a local website you can use the code snippet from the welcome message to deploy the chat widget to your website.
Enter the pre-sales information in the live chat preview mode to send a test chat to Zoom.
You will see a new live chat request into the Inbound Live Chat channel:
Click the ‘Join Chat’ button the join the chat as an agent.
Once you do this, you will receive a confirmation message and see a link to a dedicated live chat channel is created. We create a channel for each chat in order to handle multiple simultaneous website chats.
Now go to the newly created dedicated channel and respond to the chat here.
1.4 Test a Live Chat for additional agents
Scope required: View all users chat messages, Enable Chatbot within Zoom Chat Client, View All User Information
We use these scopes to create channels and invite additional account users to chat requests when they click Join Chat. This is in order to support multiple agents within our Live Chat application. We’ll run through this case where an additional team member in a channel answers a chat. First, choose to Add a Member to the Live Chat inbound channel where the live chats are directed.
Now login as this new user, and start another chat.
As the new user, click Join Chat on the live chat inbound that was requested.
Then click over to the newly created channel and respond to the chat.
You should see the chat replies in the preview page.
Now you’ve executed each scope in Live Chat