Zoom Mate - Detailed Onboarding Instructions

To fully leverage Zoom Mate's capabilities and extract comprehensive call information, you’ll need to enable specific Webhook Events and API scopes. These permissions are essential for Zoom Mate to function seamlessly and provide you with real-time data and insights.

Note: All the API scopes that Zoom Mate operates with are strictly 'Read' scopes. This means that while Zoom Mate can access and retrieve essential data, it does not have the ability to modify or interact with the content of your Calls or SMS within your Zoom Phone subscription. Your call and SMS content remain entirely private and secure.

1. Login

   • Login to https://marketplace.zoom.us/ with Zoom Admin/Owner Credentials

   • Click on Develop > Build App

   • Select Server to Server OAuth App & Click Create

   • Put 'Zoom Mate' in App Name & Click Create
     
     

2. App Credentials

   • From Zoom App, Copy Account ID > Zoom Account ID in the form

   • From Zoom App, Copy Client ID > Zoom Client ID in the form

   • From Zoom App, Copy Client Secret > Zoom Client Secret in the form

   • Click Continue
     
     

3. Information

   • Short Description > Zoom Mate provides real-time agent presence, call queue status monitoring, and detailed performance reporting, all in one intuitive platform.

   • Company Name > Zoom Mate

   • Name > Zoom Mate

   • Email: info@zoommate.io

   • Click Continue
     
     

4. Feature

   • From Zoom App, Secret Token > Zoom Secret Token in the form

   • Submit the ZoomMate Onboarding form now, and wait for the Welcome Email.

   
   

5. Welcome Email

   • Copy the Zoom Webhook Endpoint URL from the Email, we will use this in the following steps.

   • Go back in the Zoom Marketplace App, Enable Event Subscriptions > Add Event Subscription

   • Subscription Name > Zoom Mate

   • Paste copied Zoom Webhook Endpoint URL > Event notification endpoint URL

   • Click Validate > It should get validated. [Contact info@zoommate.io if validation fails]

   • Click on Add Events > Select the Events mentioned in the Webhook Events

   • Click on Done > Save

   • Click Continue
     
     

6. Scope

   • Click on Add Scopes > Search for scopes mentioned in the Scopes section & Add them one by one.

   • Click Done

   • Click Continue
     
     

7. Activate

   • Click Activate Your App
     
     

8. We are All Set

   • Now go back to Welcome Email, and Click on Zoom Mate Interface link.

   • Press the Refresh button on the top right corner of the screen.You should see the User Status, and any live calls status popping up in moments.
     

Webhook Events and Scopes

Webhook Events (11 Events)

• User Activity

  • User’s presence status has been updated.
    

• Zoom Phone

  • Callee missed a phone call

  • Callee rejected a phone call

  • Callee ended a phone call

  • Caller ended a phone call

  • Caller hears a ringback tone

  • Caller is connected to the callee

  • Callee phone is ringing

  • Callee answered a phone call

  • Caller call log is completed

  • Callee call log is completed
    

Scopes (9 Scopes)

• Auto Added:

  • user:read:presence_status:admin

  • phone:read:call:admin

  • phone:read:call_log:admin
    

• To be Added:

  • phone:read:list_call_logs:admin

  • phone:read:list_numbers:admin

  • phone:read:list_users:admin

  • phone:read:call_queue:admin

  • phone:read:list_call_queues:admin

  • phone:read:user:admin