From b2b74a136aadc1f583b18262c7ebb3227bd0c4fc Mon Sep 17 00:00:00 2001 From: David Zafrani Date: Wed, 19 Apr 2017 10:57:46 -0700 Subject: [PATCH 1/2] Create voice.apib --- v2/voice.apib | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 v2/voice.apib diff --git a/v2/voice.apib b/v2/voice.apib new file mode 100644 index 0000000..7bc9e06 --- /dev/null +++ b/v2/voice.apib @@ -0,0 +1,42 @@ +FORMAT: 1A + +# Voice [/v2/voice] + +API for voice related end points. + + +## Commands [GET /v2/voice/commands] + +Fetch a list of voice commands available for Sense with Voice. + ++ Response 200 (application/json) + +{ + "voice_command_topics": [ + { + "title": "Alarm and Sleep Sounds", + "description": "Before each command, say \"Okay Sense\" to set an alarm or begin playing Sleep Sounds.", + "subtopics": [ + { + "command_title": "Alarms", + "commands": [ + "Wake me up at 10 AM.", + "Set alarm for tomorrow morning at 8." + ] + }, + { + "command_title": "Sleep Sounds", + "commands": [ + "Play a Sleep Sound.", + "Play White Noise." + ] + } + ], + "icon_urls": { + "phone_1x": "https://s3.amazonaws.com/hello-dev/images/voice/icon_alarms@1x.png", + "phone_2x": "https://s3.amazonaws.com/hello-dev/images/voice/icon_alarms@2x.png", + "phone_3x": "https://s3.amazonaws.com/hello-dev/images/voice/icon_alarms@3x.png" + } + }, ... + ] +} From 24759f5518df78408aecc2d1ece71b05482834c7 Mon Sep 17 00:00:00 2001 From: David Zafrani Date: Wed, 19 Apr 2017 10:59:41 -0700 Subject: [PATCH 2/2] Update voice.apib --- v2/voice.apib | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/v2/voice.apib b/v2/voice.apib index 7bc9e06..866a84a 100644 --- a/v2/voice.apib +++ b/v2/voice.apib @@ -10,6 +10,7 @@ API for voice related end points. Fetch a list of voice commands available for Sense with Voice. + Response 200 (application/json) + (note icon_urls only returns one image. It is the larger of the two we use. If we can't easily shrink it down I will upload the smaller as well) { "voice_command_topics": [ @@ -40,3 +41,6 @@ Fetch a list of voice commands available for Sense with Voice. }, ... ] } + + +