Skip to content

Create voice.apib #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zafrani wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create voice.apib #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b74a1
Create voice.apib
zafrani Apr 19, 2017
24759f5
Update voice.apib
zafrani Apr 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions v2/voice.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
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)
(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": [
{
"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"
}
}, ...
]
}