2016.06.27 Cisco Spark / Tropo API

Transcript

2. What’s an API (And why do I care?)
3. The New Collaboration Landscape
 Powered by APIs that are simple, open, and pay as you go 3 Embed a 
 collaboration service 
 into your offering Accelerate 
 time to market Generate better business outcomes Improve employee satisfaction Access your 
 favorite tools 
 wherever you work Build customized 
 solutions 
 for verticals - - Integrate with 
 your existing 
 IT management tools Results
5. 5 List items GET /items Create an item POST /items Get an item GET /items/{id} Update an item PUT /items/{id} Delete an item DELETE /items/{id}
7. What is Tropo?
9. 9 Old-style Communication Development
12. 12 + ✓Ask ✓Call ✓Conference ✓Hangup ✓Record ✓Reject ✓Say ✓Transfer
13. 13 ask “Thanks for calling. For sales say sales or press 1. For support say support or press 2.”, { :choices => “1 (sales, 1) , 2 (support, 2)”, :onChoice => { if result.value == 1 then say “Your money is important to us” elsif result.value == 2 say “Your call will be ignored in the order it was received.” end } }
14. 14 ✓ Globally available ✓ Global Outgoing Calls & Messages ✓ Numbers in 42 countries ✓ 80 speech languages
15. What is Spark for Developers?
17. Cisco Spark Platform APIs Make it easy for users to integrate Cisco Spark 
 with the apps they love and give developers tools 
 to transform collaboration experiences. Teams unify workstreams 
 in a click Native 
 Integrations Power-users 
 create their own apps 
 in minutes App Integration 
 Services Developers accelerate the value of Spark in their environments Platform APIs / SDKs Cisco Spark Platform APIs
18. 18 /people /memberships /rooms /messages /webhooks
19. The Solution Cisco Cloud Collaboration Platforms 19 Complete collaboration solution Modular building blocks Integrate, extend, and customize Spark experiences Cisco Spark Platform Embed voice and SMS services to enhance business processes Tropo Platform Cisco Spark for Developers was built by Spark and Tropo architects. Those of you already familiar with Tropo will recognize the world-class ease of use, docs and 24/7 support on Cisco Spark for Developers.
22. About Spark
23. Use Cases
24. Inbound Capabilities: 
 User Calls or Texts App 24 • Surveys / Voting • Voice Search • Seasonal Spikes • Audio Conferencing • Information Lookup • Basic Auto Attendent
25. Outbound Capabilities: 
 App Calls or Texts User 25 • Voice Broadcast • Conditional Alerts • Click-to-Call • Appointment Reminders • Two Factor Authentication • Confirmation SMS
26. 26 Phone Number Masking
27. 27 Self Service IVR
28. 28 Two Factor Authentication
29. 29 Notifications
30. 30 http://usecases.tropo.com
31. 31 Customer Loyalty In store IVR Notifications Satisfaction Surveys “Press 1 if you were satisfied Status of gift cards, extra coupons, promotions Confirmation receipts of delivery, order pickups In store Paging and Notification - “Press for help in electronics” Branch site flexibility Appointment Reminders Use Cases Retail Click to Call for Web Leads (auto conference) Delivery/Operations In store Delivery optimization
32. 32 Hospital, Pharmacy Home Healthcare Operations Patient appointment Reminders Prescription Re-fill and pickup reminders Medical lab results outbound IVR Time of Day Dietary and Exercise Reminders Daily check-ins “today’s pain level =“, Mental illness check-in Nurse site visit verifications Use Cases Billing record verifications and payments Health Care + Masked Number Medical Consult
33. 33 Customer Loyalty Customer Interaction Workforce Optimization Theme park notifications Deals, promotions marketing campaigns Appointment Reminders “ Your Massage is scheduled” Reservation and Delivery confirmations “Your Table is ready” Basic Interactive Voice Response – Press 1 for concierge Use Cases Hospitality Maintenance services to validate job status Branch Site flexibility - persistent updates
34. 34 Banking Insurance 2 Factor Authentication Appointment Reminders, Kiosk integrations Basic account balance IVR and self service Proactive notifications – low balance, fraud, account activity Proactive Notifications – New offers, loan rates, stocks Extreme Weather Notification Services Branch Location Flexibility for IVR Verification of identify for account access Use Cases Payment Reminders Financial Services
35. 35 IOT Sensor Alerting Customer Loyalty Escalation of thresholds to sms/voice Plant status Emergency notifications « plant down, line halt » Smart Grid power consumption management Gas tank and gauge thresholds Use Cases Proactive outreach of utility spending, surges, planned downtime Manufacturing & Energy Notifications Payment Reminders Remote device status alerts (inbound or outbound)
36. 36 911 Alerting Notifications Reminders City appointment reminders / take a ticket Intruder and emergency alerts via Text and Calling to Mobile Extreme Weather notifications Use Cases City – Roadwork, closures, emergencies Education, Government Location tracking and alerts for student locations Transportation – City Bus Systems Parent/student information - grades, tardy Schedule changes school closed, late start days
37. Why Tropo? 37 Cloud Modular Services (Calling, Texting, Branch etc.) Embeddable Web Developer Friendly APIs Easily and rapidly scalable Zero upfront costs and usage based fees Tropo handles all telco provisioning Pre-integrated speech technologies Tropo Premise (moving to cloud) Full Application (IVR, UC, etc.) Integratabtle Complex and/or Proprietary Fixed costs and lead-times hinder scalability Upfront capital expenditure Customer responsible for phone #s, trunk lines, etc. Speech is an add-on Traditional Communication Solutions
39. 39 • Local Numbers • Toll Free • 25+ countries • SIP Addresses Numbers • Inbound • Outbound • Trunking included Voice • Inbound • Outbound • Two-way Texting
40. 40 • Transfer • Conference • Headers Call Control • Speech Recognition • Text to Speech • Audio playback • Recording Rich Media • Redundant data centers • Auto-scaling • Usage- based Cloud
41. Account Types 41 • Free for testing • Low-volume • Restricted use • No production usage Developer • Pre-paid • Credit Card • Self-service signup • Shared Cloud • one minute billing increments Production • Post-paid invoices • Contract • SLA • Account Manager • Shorter billing increments • Training Enterprise
42. 42 24x7 support All features Monitored, Managed Cloud Developer Production Enterprise
43. Developer Portal Interactive Docs SDKs Cisco Spark for Developers ‘Preview’ 43 24/7 Dev Support
44. Spark APIs execute as the user they are running as, using their license grants and permissions.
45. Personal Access Token Invoke Spark API’s as yourself Spark needs to identify you when you are making your API calls Every Spark user has an Authorization header Where can you find it? Logon to developer.ciscospark.com, and click on your avatar, it’s right there! 45
46. The APIs
47. People, Places, and Things ✓ People ✓ Rooms ✓ Memberships ✓ Messages 47
48. /people
49. /rooms
50. /memberships
51. /messages
52. /webhooks
53. 53 /People /Rooms /Membership /Messages /Webhooks GET - List People GET - List Rooms GET - List Membership GET - List Messages GET - List Webhooks GET - Get Person Details POST - Create a Room POST - Create a Membership POST - Create a Message POST - Create a Webhook GET - Get My Details GET - Get Room Details GET - Get Membership Details GET - Get Message Details GET - Get Webhook Details PUT - Update a Room PUT - Update a Membership PUT - Update a Webhook DELETE - Delete a Room DELETE - Delete a Membership DELETE - Delete a Message DELETE - Delete a Webhook
54. Apps and OAuth 54 Have your app invoke Spark API’s on behalf of someone else A personal access token will make calls on your behalf, but a lot of the time you will need your app to post on behalf of others. Applications are how you can securely request permissions to invoke Spark API’s on behalf of other users To do this in a secure way, Spark supports OAuth2. To achieve this: 1.Register an app with Spark 2.Request permission using OAuth grant flow 3.Exchange the resulting Authorization code for an Access Token 4.Use this Access Token to make your API calls
55. Register Your App with Spark 55 Register your app, include: •App Name •Description •Contact Email •Icon URL •Redirect URL •Scopes •Keywords
56. oAuth Flow 56 ‘Authorize URL’ ‘Accept’ ‘Base64 code’ ‘Access-Token Request’ ‘Access-Token’ ‘Subsequent Spark Calls’ w/ Access Token and “refresh” token’ Each request shown in full on next slide Access-token is valid for 14 days. Refresh token is valid for 90 days
57. Request Parameters 57 Access-Token Request: https://api.ciscospark.com/v1/access_token •Grant-type •Client_id •Client_Secret •Code •Redirect-url Authorize URL: https://api.ciscospark.com/v1/authorize •Respose_type •Client_id •Redirect_uri •Scope •State Base64 code returned upon successful request: http://your-server.com/auth?code=<Some-base64-code>
58. /people/me GET 58 // Check if user is valid jQuery.ajax({ url: "https://api.ciscospark.com/v1/people? email="+userEmail, type: "GET", headers: { "Authorization": "Bearer <YOUR-TOKEN>", "Content-Type": "application/json", } })
59. /Membership POST 59 // Add user to main topic discussion room, based on the area that they clicked on. jQuery.ajax({ url: "https://api.ciscospark.com/v1/memberships", type: "POST", headers: { "Authorization": "Bearer <YOUR-TOKEN>", "Content-Type": "application/json", }, contentType: "application/json", data: JSON.stringify({ "personEmail": userEmail, "roomId": areaRoom }) })
60. /Membership POST 60 // Post message and content to room jQuery.ajax({ url: "https://api.ciscospark.com/v1/messages", type: "POST", headers: { "Authorization": "Bearer <YOUR-TOKEN>", "Content-Type": "application/json”, }, contentType: "application/json", data: JSON.stringify({ “text": “https://youtu.be/YA7yG-LIYxU", "roomId": newRoomId }) })
61. Spark API Deep Dive
62. Tropo APIs
63. 63 PHP <?php
 answer();
 say("Hello World");
 hangup();
 ?> Javascript answer();
 say("Hello World");
 hangup(); Ruby answer
 say "Hello World"
 hangup Python answer()
 say("Hello World")
 hangup() Groovy answer()
 say("Hello World")
 hangup() JSON {"tropo":[{
 "say": "Hello World"
 }]}
64. Creating your
    first application 64
65. Create an account 65 • Register at www.Tropo.com
66. Incoming Calls 66 say("Welcome to Tropo!");
67. Incoming Calls 67 answer(); say("Welcome to Tropo!"); hangup();
68. Try It! 68 • Create a Script
72. 72 say("hello world");
77. Call It! 77
79. Playing Audio 79 say("http://www.phono.com/audio/ troporocks.mp3")
80. Playing Audio 80 say("http://www.phono.com/audio/ troporocks.mp3 http://www.phono.com/audio/ holdmusic.mp3")
81. Try It! 81 • Replace “hello world” with the URL to an audio file • What happens if you use both “hello world AND an audio file?
82. Asking Questions 82 var result = ask("What's your favorite color? Choose from red, blue or green.", {
 choices:"red, blue, green"
 });
 say("You said " + result.value);
 log("They said " + result.value);
83. Try It! 83 var result = ask("color?", {
 choices:"red, green"
 });
 say("You said " + result.value);
84. Languages 84 say("hola.", { voice:'Juan' } ); ask("color favorito", { choices:'rojo,azul', voice:'Juan', recognizer:'es-us' } );
85. Try It! 85 say("hola.", { voice:'Paulina' } ); ask("color favorito", { choices:'rojo,azul', voice:'Paulina', recognizer:'es-us' } );
86. Outgoing Calls 86 call("+14155550100");
 say("Tag, you’re it!");
87. Outgoing Calls 87 call("sip:alice@example.com");
 say("Tag, you’re it!");
88. Outgoing Calls 88 call("+14155550100"); call("14155550100"); call("4155550100"); call("+1 415 555-0100");
89. Outgoing Calls 89 call( [ "+14075550100", "sip:alice@example.com" ] );
 say("Tag, you're it!");
90. 90 call('+' + numberToDial);
 say("Hey, "+ customerName +": "+ msg); POST /1.0/sessions {
 "token": "abcdef123456",
 "customerName": "Troposaurus",
 "numberToDial": "14075551212",
 "msg": "the sky is falling."
 }

91. 91 call('+' + numberToDial);
 say("Hey, "+ customerName +": "+ msg); POST /1.0/sessions {
 "token": "abcdef123456",
 "customerName": "Troposaurus",
 "numberToDial": "14075551212",
 "msg": "the sky is falling."
 }

92. 92 call('+' + numberToDial);
 say("Hey, "+ customerName +": "+ msg); POST /1.0/sessions {
 "token": "abcdef123456",
 "customerName": "Troposaurus",
 "numberToDial": "14075551212",
 "msg": "the sky is falling."
 }

93. 93 call('+' + numberToDial);
 POST /1.0/sessions {
 "whatever": "14075551212"
 }

94. 94 call('+' + numberToDial);
 POST /1.0/sessions {
 "whatever": "14075551212"
 }

95. 95 call('+' + numberToDial);
 POST /1.0/sessions {
 "whatever": "14075551212"
 }

96. 96 call('+' + );
 POST /1.0/sessions {
 "whatever": "14075551212"
 }
 whatever
97. 97 call('+14155550100', {
 timeout:120,
 onAnswer: function() {
 say("Tag, you are it!");
 log("Obnoxious call complete");
 },
 onTimeout: function() {
 log("Call timed out");
 },
 onCallFailure: function() {
 log("Call could not be completed as dialed");
 }
 });
98. Controlling a Call 98 transfer("+14075550100"); transfer([ "+14075550100", "+16505559876" ]);
99. 99 transfer(["+14075550100","sip: 12345678912@221.122.54.86"], {
 playvalue: "http://example.com/ holdmusic.mp3",
 terminator: "*",
 onTimeout: function(event) {
 say("nobody answered");
 }
 });
100. Conferencing 100 conference("1138"); 
 conference("2600hz");
101. 101 conference("Four score and seven", {
 terminator: "*",
 playTones: true,
 onChoice: function(event) {
 say("Disconnecting");
 }
 });
102. 102 result=ask("What is your conference ID?", 
 {choices:"[4 DIGITS]"}
 );
 conference(result.value);
103. 103 conference("12345", {
 joinPrompt: "Someone joined",
 leavePrompt: "Someone left",
 });
104. Try It! 104 • Call your neighbor’s number and join their conference. conference("1138");
105. Incoming SMS 105 say("Welcome to Tropo!");
106. Message Shortcut 106 message("Here's what you asked for.", 
 {
 to: "+16505551212", 
 network: "SMS"}
 );
107. 107 message(msg, { to: '+' + to, network:"SMS" }); POST /1.0/sessions {
 "token": "abcd12345",
 "to": "14075551212",
 "msg": "the sky is falling."
 }

108. Message Shortcut 108 say("Thanks for your call. We'll text you the information.");
 
 message("Here's what you asked for.", 
 {
 to: currentCall.callerID, 
 network: "SMS"}
 );
 
 say("This goes to the voice call.");
109. Call Properties 109 •calledID •calledName •callerID •callerName
 •channel •network •id •sessionId •isActive function
110. Reading Caller ID 110 if (currentCall.callerID == "4075550100") {
 say("Sending you to Adam.");
 transfer("+19166002497");
 }
111. Setting Caller ID 111 call("+19165550101", {
 callerID:"+14075550100"
 }); transfer("+19165550100", {
 callerID: "14075550100"
 });
112. Integration Award 112 • Build an application using Spark or Tropo (or both!) that connects to a third party service to do something useful. • Create a screencast, minimum length four minutes, demonstrating your application and walking through how it was built. • Post your screencast as a public YouTube video. • First 40 published screencasts receive a Cisco SX-10. • Program ends July 31, 2016. You must turn in your screencast by 11:59 UTC on July 31 to be eligible. • You are responsible for any taxes, duties, or reporting
113. Labs 113 http://cs.co/APJDevLab • Labs for developers and non-developers • Complete at least two labs