Use of this sample app is subject to our Terms of Use.
This is a sample Chatbot app using the Zoom Chatbot CLI NPM Package.
To run the completed Chatbot code locally, continue reading below.
To run the completed Chatbot locally, follow these steps,
-
In terminal:
$ git clone https://github.com/zoom/catbot.git$ cd catbot$ npm install$ ngrok http 3000 -
If you haven't already, head over to https://marketplace.zoom.us/develop/create and create a Chatbot named catbot.
-
Add your https Ngrok URL and slash command to your Chatbot app in the Zoom App Marketplace:
Input Description Example Value Development Redirect URL for OAuth It can be found in marketplace under App Credentials. https://{{subdomain}}.ngrok.io/auth Whitelist URL It can be found in marketplace under App Credentials. https://{{subdomain}}.ngrok.io Deauth Endpoint URL It can be found in marketplace under Information. https://{{subdomain}}.ngrok.io/deauth Development and Production Bot Endpoint URL It can be found in marketplace under Features. https://{{subdomain}}.ngrok.io/command Slash Command How you address your Chatbot. Currently slash commands need to be globally unique, so you won't be able to use the word catbot. It can be found in marketplace under Features.catbot123 NOTE: Make sure to click "Save" after entering the Development and Production Bot Endpoint URL and the Slash Command.
-
Open the
.development.envfile and fill in the following values:Key Description Example Value zoomClientIdDevelopment Client ID of your Chatbot. It can be found in marketplace under App Credentials. UD20wEqgQMyNmiR5IhinXAzoomClientSecretDevelopment Client Secret of your Chatbot. It can be found in marketplace under App Credentials. zlqppuDRGzQzW9j2eBpbUmyREPSbuTSUzoomVerifyCodeVerification Token of your Chatbot. It can be found in marketplace under Features. uaJs0IZvTIC0aP_Vs6d6IQzoomBotJidDevelopment Bot JID of your Chatbot. It can be found in marketplace under Features. v1wjk1u1acrraq_mhwf2gclg@xmpp.zoom.uszoomRedirect_uriYour ngrok URL with the authpath appended to the end.https://{{subdomain}}.ngrok.io/authcatApiKeyGet your Cat API Key here. 71c45d-530d-4280-96f8-6ec16f2315Save and close the
.development.envfile. -
In terminal:
$ npm run start -
On your App Marketplace Dashboard, go to the Local Test page and click Install. After you click the Authorize button, you should be taken to your redirect url.
-
Now that your Chatbot is installed on your Zoom account, go to a Zoom Chat channel and type,
/catbot pictureYou should see a picture of a cat!
If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.