Chatbots 101: design, code, deploy - Cisco Live Orlando 2018 - DEVNET-2896
Download as PPTX, PDF0 likes620 views
The document outlines an agenda for a Cisco DevNet session on chatbots, covering topics such as Webex Teams architecture, REST API usage, bot account creation, and the use of various SDKs. It includes practical examples, resources, and links to demos and starter kits to help developers integrate and create chatbots within the Webex Teams environment. Key features of the Webex Teams REST API, authentication methods, and bot deployment strategies are also discussed.
Chatbots 101: design, code, deploy - Cisco Live Orlando 2018 - DEVNET-2896
- 1. #CLUS Stève Sfartz, API Evangelist DEVNET-2896 Chatbots 101 Design, Code, Deploy
- 2. Agenda © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS • DoingChatOps forWebexTeams • Webex ChatBots Architecture • Conversational Bots with Botkit • Bot Deployment • Embedding Chat inWeb apps DEVNET-2896 2
- 3. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS /Cisco/DevNet/SteveSfartz • API Evangelist @CiscoDevNet • API Design,Architecture and Operations • WebexTeams & Devices/xAPI developer • hosted @CiscoROI: Paris Innovation Center • Node.js mainly, a bit of #golang • Europe and all over the world • github: //ObjectIsAdvantag “vision without execution is hallucination” -- Thomas Edison mailto: [email protected] twitter: @SteveSfartz DEVNET-2896 3
- 4. Webex for Developers QuickTour of the REST API
- 5. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams Secure & Open Complete & Simple Webex for Developers User Integrations, APIs/SDKs, etc. Webex Hybrid Services Cloud + Prem Partner Services Interconnect Message Meeting Call 1:1 and team messaging in virtual spaces A Cloud-based phone systemAudio, video, and web meetings DEVNET-2896 6
- 6. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS ‘Your App’ now with Cisco Cloud Collab! WebexTeams APIs extend Cisco Collaboration Cloud GET POST DELETE PUT /Rooms /Memberships /Messages /Teams /People /Webhooks DEVNET-2896 7
- 7. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Terminology of a REST API query GET /../repos?page=1 HTTP/1.1 accept: application/json HTTP 200 OK browser api.github.com:443 method path protocol status code https://api.github.com/users/CiscoDevNet/repos?page=1&per_page=2 headers URL: response body HTTP request HTTP response api endpoint JSON payload parameters DEVNET-2896 8
- 8. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams REST API v1 /People /Rooms /Membership /Messages /Teams /Webhooks List People List Rooms List Memberships List Messages List Teams List Webhooks Create a Room Create a Membership Create a Message Create a Team Create a Webhook Get Person Details Get Room details Get Membership details Get Message details Get Team details Get Webhook details Update a Room Update a Membership Update a Team Update a Webhook Delete a Room Delete a Membership Delete a Message Delete a Team Delete a Webhook GET POST DELETE PUT DELETE DELETE DELETE PUT PUT POST POST POST GET GET GET GET GET GET GET GETGET DELETE PUT POST GET GET DEVNET-2896 10
- 9. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Developer Portal InteractiveAPI documentation Client SDKs developer.webex.com 24/7 Dev Support DEVNET-2896 11
- 10. Demo: creating a space from an API request
- 11. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams REST API v1 /People /Rooms /Membership /Messages /Teams /Webhooks List People List Rooms List Memberships List Messages List Teams List Webhooks Create a Room Create a Membership Create a Message Create a Team Create a Webhook Get Person Details Get Room details Get Membership details Get Message details Get Team details Get Webhook details Update a Room Update a Membership Update a Team Update a Webhook Delete a Room Delete a Membership Delete a Message Delete a Team Delete a Webhook GET POST DELETE PUT DELETE DELETE DELETE PUT PUT POST POST POST GET GET GET GET GET GET GET GETGET DELETE PUT POST GET GET DEVNET-2896 13
- 12. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS DEVNET-2896 14
- 13. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS HTTP Response : Status Codes • 1xx - Information • 100 Continue • 2xx - Success • 200 OK, 201 Created, 204 No Content • 3xx - Redirection • 301 Moved permanently, 304 Not modified • 4xx - Client error • 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found • 5xx - Server error • 500 Internal Error, 501 Not Implemented, 503 Service Unavailable • Interactive map at www.restapitutorial.com/httpstatuscodes.html DEVNET-2896 15
- 14. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS JSON syntax • square brackets for lists • curly braces for objects • name/value pairs for properties, separated by commas • pick an online editor • http://codebeautify.org/jsonviewer http://www.jsoneditoronline.org DEVNET-2896 16
- 15. Doing ChatOps
- 16. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams REST API v1 /People /Rooms /Membership /Messages /Teams /Webhooks List People List Rooms List Memberships List Messages List Teams List Webhooks Create a Room Create a Membership Create a Message Create a Team Create a Webhook Get Person Details Get Room details Get Membership details Get Message details Get Team details Get Webhook details Update a Room Update a Membership Update a Team Update a Webhook Delete a Room Delete a Membership Delete a Message Delete a Team Delete a Webhook GET POST DELETE PUT DELETE DELETE DELETE PUT PUT POST POST POST GET GET GET GET GET GET GET GETGET DELETE PUT POST GET GET DEVNET-2896 18
- 17. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Create a Bot account https://developer.webex.com/apps.html DEVNET-2896 19
- 18. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Fill in your Bot account details https://developer.webex.com/add-bot.html Choose a meaningful nickname for your bot. Used to mention your bot in a space. Pick a unique username for your bot. Used to invite your bot it to a space. Select an icon as your bot’s avatar, or push a custom image. DEVNET-2896 20
- 19. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Fetch your bot’s access token • Don’t forget to add a description, and click « Create Bot » • Paste your bot’s token in a safe place: • Your bot’s access token lets your code interact withWebexTeams under the bot identity • You can generate a new token at any time by reaching to your Bot’s details page. DEVNET-2896 21
- 22. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Import the postman colllection forWebex https://github.com/CiscoDevNet/postman-webex http://bit.ly/postman-webex DEVNET-2896 24
- 23. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Generate code with Postman 1. Start from a REST call 2. Use environment variables for your secrets 3. Select your favorite language 4. Run your code DEVNET-2896 25
- 24. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS or leverage a SDK for javascript, python, ruby, php… • Official «WebexTeams » SDKs • Community SDKs listed as awesome-webex • node-sparky, node-spark-client • python ciscosparkapi • … https://github.com/flint-bot/sparky https://github.com/CiscoDevNet/ciscosparkapi DEVNET-2896 26
- 25. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Creating a space and messages from code https://github.com/CiscoDevNet/node-sparky-samples DEVNET-2896 27
- 26. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Resources • Client SDKs on awesome-webex • https://github.com/CiscoDevNet/awesome-webex#client-sdks • Python SDKs • https://github.com/CiscoDevNet/ciscosparkapi • Node.js SDKs • https://github.com/webex/spark-js-sdk • https://github.com/flint-bot/sparky • Node.js sparky samples • https://github.com/CiscoDevNet/node-sparky-samples DEVNET-2896 28
- 27. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams REST API v1 (user) /People /Rooms /Membership /Messages /Teams /Webhooks List People List Rooms List Memberships List Messages List Teams List Webhooks Create a Room Create a Membership Create a Message Create a Team Create a Webhook Get Person Details Get Room details Get Membership details Get Message details Get Team details Get Webhook details Update a Room Update a Membership Update a Team Update a Webhook Delete a Room Delete a Membership Delete a Message Delete a Team Delete a Webhook GET POST DELETE PUT DELETE DELETE DELETE PUT PUT POST POST POST GET GET GET GET GET GET GET GETGET DELETE PUT POST GET GET DEVNET-2896 29
- 29. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Meet the roomId bot • Add [email protected] to an existing space • The bot enters the space • Sniffs the room identifier, • Posts the identifier back in a 1-1 space, • And finally leaves the space you originally invited it to join • Check the code • https://github.com/CiscoDevNet/node-sparkbot-samples DEVNET-2896 31
- 30. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams Bot Architecture Register webhook events • Messages / created Memberships / created As events happen in spaces, receive notifications from Webex Security tips Select spaces to fire from via a webhook filter Check on user’s email domain in your code Check webhook payload signature via a shared secret DEVNET-2896 32 Webex cloud platform 1. interacts in spaces via a Teams client Webex Teams User Your bot code running on-premises or on in the cloud 2. posts notifications to registered Webhooks 3. posts back messages as notifications fly in Publicly accessible bot endpoint
- 31. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS What is takes to code a bot? https://github.com/CiscoDevNet/botkit-template DEVNET-2896 33
- 32. Demo: your first conversational bot with glitch
- 33. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Community bot frameworks forWebexTeams Flint Earliest bot framework for Webex Teams Highly tuned for the REST API (webhooks events, moderation…) Basic Key/Value data store Limited middleware support (storage) Coding best practices (ES6, exception handling, logs, retries, rate limitation) BotKit Largest community bot framework Cross platform support with code reuse (no magic convert button: events name, message formatting) Advanced Key/Value data store (at the user / space level) Set of middleware (storage, rasa NLU, wit.ai, bcrm…) Powerful conversational paradigm https://github.com/flint-bot/flint https://github.com/howdyai/botkit DEVNET-2896 35
- 34. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Bot Architecture: on-premises DEVNET-2896 36 Webex cloud platform DMZ Reverse Proxy 2. posts notifications to registered Webhooks publicly accessible 3. posts back messages as notifications fly in Your bot code running on-premises enterprise secured 2b. forwards notifications 1. interacts in spaces via a Teams client Webex Teams User
- 35. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Bot Architecture: development environment DEVNET-2896 37 Webex cloud platform Tunneling infrastructure Your bot code running on your local machine 2. posts notifications to registered Webhooks dev environmentpublicly accessible 2b. forwards notifications 1. interacts in spaces via a Teams client Webex Teams User ngrok, localtunnel… 3. posts back messages as notifications fly in
- 36. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Learning Labs https://learninglabs.cisco.com/tracks/collab-cloud DEVNET-2896 38
- 38. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Ability to host Bots and Integrations in the customers choice of Cloud, allowing transparency of any associated data flows Enterprise Bots: Deployment Checklist Ability to heavily customize Bots and Integrations to work with the customers heavily customized business applications Any data storage to be on a compliant and trusted storage platform to which only the customer has access DEVNET-2896 40
- 39. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public A set of community driven Starter Kits • Primarily based on Botkit, the most popular Open Source Bot framework. • Open Source MIT License, meaning you can use, modify, deploy and sell the code without restriction. • Provided as a Reference implementation containing the core functionality and services that apply to most deployments. • Easy to extend and customize using the skills capability of Botkit, making it easy to add new functionality and function with customized versions of popular SaaS applications. • Each project comes with a pre-composed Dockerfile and a Deploy to Heroku button, allowing deployments in your chosen Cloud within minutes. • New features over time thanks to the Webex for Developers community. Reference Implementation Deploy securely in your preferredCloud in minutes Open Source and Highly Customizable Ambassadors Starter Kits © 2017 Cisco and/or its affiliates. All rights reserved. Cisco Confidential DEVNET-2896 41
- 40. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams Bots Horizontal Use Cases https://ciscowebexteamsambassadors.github.io/StarterKits/ Incident Management HR Onboarding Task Management Sales Pipeline Finance Operations Polling Scheduling Content Management Network Operations DEVNET-2896 42
- 42. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams APIs and SDKs developer oauth bot token /people /rooms /messages /webhooks… REST API DEVNET-2896 44
- 43. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams APIs and SDKs developer oauth bot token REST API SDKs Teams applications (browsers, iOS, android…) all features /people /rooms /messages /webhooks… DEVNET-2896 45
- 44. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Space Widget https://developer.webex.com/widgets.html • 1:1 & Group Persistent Chat • Create, delete, flag messages, read receipts, @Mentions, Markdown • File sharing • Add participants (Roaster list) • 1:1 & Group Calling • Dial byWebex email & SIP address • Chrome & Firefox latest • Opensource React component DEVNET-2896 46
- 45. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Experiment theWebexTeamsWidgets https://github.com/CiscoDevNet/widget-samples DEVNET-2896 47
- 46. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams APIs and SDKs developer oauth bot guest token REST API SDKs Teams applications (browsers, iOS, android…) all features /people /rooms /messages /webhooks… DEVNET-2896 48
- 47. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Resources • Widget samples • https://github.com/CiscoDevNet/widget-samples • ‘guestissuer’ CLI • https://github.com/ObjectIsAdvantag/guestissuer DEVNET-2896 49
- 48. Jabber Bots
- 49. Wrapup
- 50. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS WebexTeams Ambassadors • Get Started with integration possibilities Direct access to our developer evangelists & product teams Brainstorm ideas & use cases that your customer needs Showcase your integrations to Cisco for exposure https://ambassador.webex.com/ Sign up today! DEVNET-2896 52
- 51. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Resources • Webex for Developers • https://developer.webex.com • DevNet Community Developer Resources • https://developer.cisco.com/site/spark • https://github.com/CiscoDevNet/awesome-webex • DevNet Learning Labs • https://learninglabs.cisco.com/tracks/collab-cloud • Opensource Bots Starter Kits • https://webexteamsambassadors.github.io/StarterKits/ DEVNET-2896 53
- 52. Complete your online session evaluation © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Give us your feedback to be entered into a Daily Survey Drawing. Complete your session surveys through the Cisco Live mobile app or on www.CiscoLive.com/us. Don’t forget: Cisco Live sessions will be available for viewing on demand after the event at www.CiscoLive.com/Online. DEVNET-2896 54
- 53. © 2018 Cisco and/or its affiliates. All rights reserved. Cisco Public#CLUS Demos in the Cisco campus Walk-in self-paced labs Meet the engineer 1:1 meetings Related sessions Continue your education DEVNET-2896 55
- 54. Q&A
- 55. Thank you #CLUS
- 56. #CLUS
Editor's Notes
- #5: If you have not installed Postman, this is the last call. Go to getpostman.com, Click Chrome App for the purpose of this training
- #47: TO BE UPDATED Super Easy Integration Responsive UI built with HTML5 and React.js New features automatically gets pushed via public CDN Open source libraries WebRTC A/V Calling & Messaging