Categories:
Actions in channelData v3
List of the actions returned by Aura with channelData model v3
Introduction
Actions are the way of translating the Aura’s answer into a direct operation from the channel, i.e., Aura informs the channel how to act depending on the user’s intention and the result provided by aura-bot.
The following sections show the details of the response custom data depending on the domain of the user’s intention. The columns of the tables describe the action name, channel reaction and description.
The value N/A is included in case of “not apply” (no action sent or no content attached).
Cross actions
These actions can be added to any use case. The specific values will depend on the use case being resolved. The expectation in these cases is that the channel understands these actions with their possible values so that, regardless of which use case the user has requested, if the channel receives an action (for example, MAKE_SOUND) it will be able to trigger it.
This means that, although in the following tables an N/A (Not Apply) appears in the “Actions” column, the channel could always receive one of the cross actions.
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Make a sound | The use case result should be shown to the user with a positive sound | N/A | N/A | N/A | MAKE_SOUND | channel | {} | {sound} |
| Click a key remotely | Click a key remotely. The specific values of the keyCodes are defined above in each use case | N/A | N/A | N/A | SEND_KEY | stb | {} | {keyCode, deviceId, levels} |
| Redirect | Redirect command must send a message to the bot with the auraCommand sent in the action |
REDIRECT.COMMAND | redirect | AuraCommand | N/A | channel | N/A | N/A |
Examples are included in Cross action examples.
Small talk (a.k.a. common domain)
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| No reaction for Common. The channel shows what comes from Aura | Greet the user | COMMON.GREETINGS | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction for Common. The channel shows what comes from Aura | Say goodbye to the user | COMMON.GOODBYES | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction for Common. The channel shows what comes from Aura | Thank the user | COMMON.THANKYOUS | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction for Common. The channel shows what comes from Aura | The user is angry with Aura | COMMON.SWEARWORDS | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction for Common. The channel shows what comes from Aura | Initialize tv use cases | COMMON.INIT | N/A | N/A | N/A | N/A | N/A | N/A |
| The Help App is started | The user is asking for help | COMMON.HELP | N/A | N/A | N/A | N/A | N/A | N/A |
Generic questions
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| No reaction for Generic. The channel shows what comes from Aura | The question of the user needs to be disambiguated | DISAMBIGUATION | N/A | The disambiguation information will be included in the corresponding attachment with the array of options to be shown to the user | N/A | N/A | N/A | N/A |
Examples are included in Generic questions examples.
None
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| No reaction. The channel shows what comes from Aura | When handling an unsupported intent by the current channel | NONE | N/A | N/A | N/A | N/A | N/A | N/A |
Video
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| No reaction. The channel shows what comes from Aura (only text and suggestions) | No content found. User wants to watch a channel on TV or a VOD content but it does not exist on catalog. | MEDIA.SEARCH | N/A | N/A | N/A | N/A | N/A | N/A |
| Show content details | User wants to watch content on TV. Content search with one result found. | MEDIA.SEARCH | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Content list | User wants to watch content on TV. Content search with several results found. | MEDIA.SEARCH | content_list | Array of object Kernel result | N/A | N/A | N/A | N/A |
| Content list | User wants to search content in a third party platform (for example Netflix) | MEDIA.SEARCH | content_list | Array of object Kernel result | N/A | N/A | N/A | N/A |
| No reaction, the channel shows what comes from Aura. (Only text and suggestions) | Recommendation content to content with no contents found | MEDIA.RECOMMENDATION_C2C | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction. The channel shows what comes from Aura | Recommendation content to content with one content found | MEDIA.RECOMMENDATION_C2C | details | Object Kernel result | N/A | N/A | N/A | N/A |
| No reaction. The channel shows what comes from Aura | Recommendation content to content with contents found | MEDIA.RECOMMENDATION_C2C | content_list | Array of object Kernel result | N/A | N/A | N/A | N/A |
| No reaction. The channel shows what comes from Aura | Personalized recommendation with no content | MEDIA.RECOMMENDATION_C2P | N/A | N/A | N/A | N/A | N/A | N/A |
| No reaction. The channel shows what comes from Aura | Personalized recommendation with one content result | MEDIA.RECOMMENDATION_C2P | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Content list | Content recommendation with results found. Similar to previous one but using the JSON coming from Kernel Recommendations API | MEDIA.RECOMMENDATION_C2P | content_list | Array of object Kernel result | N/A | N/A | N/A | N/A |
| Show content details | Get more details about the content displayed on the second device | MEDIA.SHEET_SECOND_SCREEN | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Show content details | Get more details about the content displayed on TV | MEDIA.SHEET_TV | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Show content details | User wants to play content, but it is not included in user’s subscription | CONTENT.PLAY | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Show content details | User wants to watch a channel, but it is not included in user’s subscription | CHANNEL.PLAY | details | Object Kernel result | N/A | N/A | N/A | N/A |
| Play content | User wants to play a specific content | CONTENT.PLAY | details | Object Kernel result | REMOTEON.PLAYTO | stb | {} | {deviceId, contentId, catalogType} |
| Play the content on focus | Watch this VOD content | CONTENT.PLAY | details | Object Kernel result | REMOTEON.PLAYTO | stb | {} | {deviceId, contentId, liveProgramId,catalogType, resumeTime} |
| Tune to channel | User wants to tune a specific channel | CHANNEL.PLAY | details | Object Kernel result | REMOTEON.ZAPTO | stb | {} | {deviceId, channeId, channelNumber} |
| Play the channel on focus | Watch this channel | CHANNEL.PLAY | details | Object Kernel result | REMOTEON.ZAPTO | stb | {} | {deviceId, channeId, channelNumber} |
| React to received Key | Watch from the beginning | FROM_BEGINNING | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| React to received Key | Record content | REC | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| React to received Key | User wants to play a third-party content | PLAY | details | Object Kernel result | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Change play parameter | Turn English audio and turn English subtitles on / Play in original version for a VOD content | CONTENT.CONFIG_AUDIO_SUBTITLES | N/A | N/A | REMOTEON.PLAYPARAMS | stb | {} | {deviceId, contentId, liveProgramId,catalogType, audio, subtitles} |
| Change play parameter | Turn English audio and turn English subtitles on / Play in original version for a channel | CHANNEL.CONFIG_AUDIO_SUBTITLES | N/A | N/A | REMOTEON.LIVEPARAMS | stb | {} | {deviceId, channeId, channelNumber, audio, subtitles} |
| Change play parameter | Turn English audio on / Play in original version for a VOD content | CONTENT.CONFIG_AUDIO | N/A | N/A | REMOTEON.PLAYPARAMS | stb | {} | {deviceId, contentId, liveProgramId,catalogType, audio} |
| Change play parameter | Turn English audio on / Play in original version for a channel | CHANNEL.CONFIG_AUDIO | N/A | N/A | REMOTEON.LIVEPARAMS | stb | {} | {deviceId, channeId, channelNumber, audio} |
| Change play parameter | Turn English subtitles on / Play in original version for a VOD content | CONTENT.CONFIG_SUBTITLES | N/A | N/A | REMOTEON.PLAYPARAMS | stb | {} | {deviceId, contentId, liveProgramId,catalogType, subtitles} |
| Change play parameter | Turn english subtitles on / Play in original version for a channel | CHANNEL.CONFIG_SUBTITLES | N/A | N/A | REMOTEON.LIVEPARAMS | stb | {} | {deviceId, channeId, channelNumber, subtitles} |
| Change play parameter | Turn off subtitles for a VOD content | CONTENT.DEACTIVATE_SUBTITLES | N/A | N/A | REMOTEON.PLAYPARAMS | stb | {} | {deviceId, contentId, liveProgramId,catalogType, subtitles} |
| Change play parameter | Turn off subtitles for a channel | CHANNEL.DEACTIVATE_SUBTITLES | N/A | N/A | REMOTEON.LIVEPARAMS | stb | {} | {deviceId, channeId, channelNumber, subtitles} |
| Move channels down | Move channels down | CHANNEL_DOWN | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Move channels up | Move channels up | CHANNEL_UP | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Mute TV | Mute TV | MUTE | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Unmute TV | Unmute TV | UNMUTE | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Switch TV off | Switch TV off | SWITCH_OFF | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Switch TV on | Switch TV on | SWITCH_ON | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Pause TV | Pause the current program being played | PAUSE | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Resume TV | Resume TV | RESUME | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Stop TV | Stop TV | STOP | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Volume up TV | Volume up | VOLUME_UP | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Volume down TV | Volume down | VOLUME_DOWN | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Move forward | Move forward | MOVE_FORWARD | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Move back | Move back | MOVE_BACK | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId, levels} |
| Disable subtitles | Disable subtitles | REMOTEON_AUDIO_SUBTITLES | N/A | N/A | REMOTEON.AUDIO_SUBTITLES | stb | {} | {keycode, deviceId, subtitles} |
| Change language | Change language | REMOTEON_AUDIO_SUBTITLES | N/A | N/A | REMOTEON.AUDIO_SUBTITLES | stb | {} | {keycode, deviceId} |
| Go to app | Navigate/open a section from a third party | GOTOAPP | N/A | N/A | GOTOAPP | stb | {} | {name, id, deviceId} |
Examples are included in Video examples and can be easily accessed following the hyperlink defined in Actions Name column.
Communications
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Call to the number the user sends afterwards | Make a phone call | COMMUNICATIONS.CALL | N/A | N/A | COMMUNICATIONS.CALL | channel | {} | {} |
| Call to the number sent by the user | Make a phone call to the given phone number | COMMUNICATIONS.CALL_NUMBER | N/A | N/A | COMMUNICATIONS.CALL_NUMBER | channel | {} | {items:[]} |
| Call to the contact name sent by the user | Make a phone call to the given contact name | COMMUNICATIONS.CALL_NAME | N/A | N/A | COMMUNICATIONS.CALL_NAME | channel | {} | {items: []} |
| Sent a voice mail | Sent a voice mail to the given contact | COMMUNICATIONS.VOICE_MAIL_CALL | N/A | N/A | COMMUNICATIONS.VOICE_MAIL_CALL | channel | {} | {} |
| Check incoming and outgoing calls | Check calls | COMMUNICATIONS.CHECK_ALL_CALLS | N/A | N/A | COMMUNICATIONS.CHECK_ALL_CALLS | channel | {} | {} |
| Ignore incoming call | Mute the incoming call | COMMUNICATIONS.IGNORE_INCOMING_CALL | N/A | N/A | COMMUNICATIONS.IGNORE_INCOMING_CALL | channel | {} | {} |
| Pick up incoming call | Pick up incoming call | COMMUNICATIONS.PICKUP | N/A | N/A | COMMUNICATIONS.PICKUP | channel | {} | {} |
| Redial last outgoing number | Redial a number | COMMUNICATIONS.REDIAL | N/A | N/A | COMMUNICATIONS.REDIAL | channel | {} | {} or 0 |
| Add contact to address book | Add contact to address book | CONFIG.ADD_CONTACT | N/A | N/A | CONFIG.ADD_CONTACT | channel | {} | {} |
| Disable silent mode | Unmute the device | CONFIG.SILENT_MODE_OFF | N/A | N/A | CONFIG.SILENT_MODE_OFF | channel | {} | {} |
| Enable silent mode | Mute the device | CONFIG.SILENT_MODE_ON | N/A | N/A | CONFIG.SILENT_MODE_ON | channel | {} | {} |
Examples are included in Communication actions examples.
Domotics
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Switch off the lights | Switch off the lights | DOMOTICS.LIGHT_OFF | N/A | N/A | DOMOTICS.LIGHT_OFF | channel | {} | {actionCode, deviceId, levels} |
| Switch on the lights | Switch on the lights | DOMOTICS.LIGHT_ON | N/A | N/A | DOMOTICS.LIGHT_ON | channel | {} | {actionCode, deviceId, levels} |
Examples for each action are included in Domotics actions examples.
e-commerce
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Add item to wish list | Add item to wish list | ECOMMERCE.ADD_TO_WISH_LIST | N/A | N/A | ECOMMERCE.ADD_TO_WISH_LIST | channel | {} | {} |
Miscellaneous
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Turn the radio off | Turn the radio off | RADIO.OFF | N/A | N/A | RADIO.OFF | channel | {} | {} |
| Listen to the radio | Turn the radio on with a specific station | RADIO.LISTEN | N/A | N/A | RADIO.LISTEN | channel | {} | {stationId, stationName, stationText} |
| Listen to a podcast | Listen to a podcast | PODCAST.LISTEN | N/A | N/A | PODCAST.LISTEN | channel | {} | {podcastName} |
| Check time | What time is it | MISCELLANEOUS.TIME_CHECK | N/A | N/A | MISCELLANEOUS.TIME_CHECK | channel | {} | {} |
| Provide weather forecast | Weather forecast | MISCELLANEOUS.WEATHER | N/A | N/A | MISCELLANEOUS.WEATHER | channel | {} | {} |
| Start playing news | Listen to news | MISCELLANEOUS.NEWS_LISTEN | N/A | N/A | MISCELLANEOUS.NEWS_LISTEN | channel | {} | {} |
| Show wifi connection data | Retrieve wifi connection data | WIFI.GET_ACCESS | wifi_info | {status, ssid, password, bssid, channel, authentication} | N/A | N/A | N/A | N/A |
Examples are included in Miscellaneous actions examples.
Navigation
| Channel reaction | Description | Intent result name | Content type | Content data | Actions name | Actions target | Actions postback | Actions params |
|---|---|---|---|---|---|---|---|---|
| Go to the selected section | Show the selected section | NAVIGATION.SECTION_SHOW | N/A | N/A | NAVIGATION.SECTION_SHOW | stb | {} | {name, id, deviceId} |
| Like the back button was pressed by the user | Go to previous page | NAVIGATION.BACK | N/A | N/A | SEND_KEY | stb | {} | {keycode, deviceId} |
| Go to next item in the given carousel or list | Go to next item in carousel | MEDIA.CAROUSEL_NEXT | N/A | N/A | MEDIA.CAROUSEL_NEXT | channel | {} | {} |
| Go to previous item in the given carousel or list | Go to previous item in carousel | MEDIA.CAROUSEL_PREVIOUS | N/A | N/A | MEDIA.CAROUSEL_PREVIOUS | channel | {} | {} |
Examples are included in Navigation actions examples.
Actions examples
Cross action examples
Make sound
"channelData": {
"intentResult": {
"name": "COMMON.GREETINGS"
},
"actions": [{
"name": "MAKE_SOUND",
"target": "channel",
"params": {
"sound": "positive"
}
}],
}
Send remote key
"channelData": {
"intentResult":{
"name": "NAVIGATION.BACK"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "BACK",
"devideId": "Mi-29283"
}
}],
Redirect command
"customData": {
"type": 'redirect',
"action": 'REDIRECT.COMMAND',
"data": {
"auraCommand": {
"type": "suggestion",
"value": {
"intent": "intent.common.greetings"
}
}
}
}
In this example, if aura-bridge receives this message, it must send an auraCommand with the intent intent.common.greetings to the bot.
Generic questions examples
"content": {
"data": {
"question": "¿Dónde puedo comprar un móvil?"
}
}
Video examples
Search content in a third-party platform
Access here to comprehensive information regarding Kernel definitions
"channelData": {
"intentResult": {
"name": "MEDIA.SEARCH",
"entities": []
},
"actions": []
}
"attachments": [
{
"content": {
"type": "content_list",
"data": [
{<JSON response from the **Kernel** search API>
}
],
"thirdParties ": [
{
"name": "netflix",
"data": {<headers response from the **Kernel** search API (To be defined by **Kernel** team)>
}
}
]
}
}
]
Play content
"channelData": {
"intentResult":{
"name": "CONTENT.PLAY"
},
"actions": [
{
"name": "REMOTEON.PLAYTO",
"target": "stb",
"params": {
"catalogType": "vod",
"contentId": "12345",
"deviceId": "Mi-29283"
}
}
]}
Play content on focus
"channelData": {
"intentResult":{
"name": "CONTENT.PLAY"
},
"actions": [
{
"name": "REMOTEON.PLAYTO",
"target": "stb",
"params": {
"catalogType": "l7d",
"contentId": "12345",
"liveProgramId": "54321",
"resumeTime": 24,
"deviceId": "Mi-29283"
}
}
]}
Play channel
"channelData": {
"intentResult":{
"name": "CHANNEL.PLAY"
},
"actions": [
{
"name": "REMOTEON.ZAPTO",
"target": "stb",
"params": {
"channelNumber": 1,
"channelId ": "123",
"deviceId": "Mi-29283"
}
}
From beginning
"channelData": {
"intentResult":{
"name": "FROM_BEGINNING"
},
"actions": [
{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "REDO",
"deviceId": "Mi-29283"
}
}
Recording
"channelData": {
"intentResult":{
"name": "REC"
},
"actions": [
{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "REC",
"deviceId": "Mi-29283"
}
}
Play a third-party content of focus
"channelData": {
"intentResult":{
"name": "PLAY"
},
"actions": [
{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "PLAY",
"deviceId": "Mi-29283"
}
}
Change audio and subtitles parameter for VOD content
"channelData": {
"intentResult":{
"name": "CONTENT.CONFIG_AUDIO_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.PLAYPARAMS",
"target": "stb",
"params": {
"catalogType": "l7d",
"contentId": "12345",
"liveProgramId": "54321",
"deviceId": "Mi-29283",
"audio": "eng",
"subtitles": "eng"
}
}
Change audio and subtitles for a channel
"channelData": {
"intentResult":{
"name": "CHANNEL.CONFIG_AUDIO_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.LIVEPARAMS",
"target": "stb",
"params": {
"channelNumber": 1,
"channelId ": "123",
"deviceId": "Mi-29283",
"audio": "eng",
"subtitles": "eng"
}
}
Change audio parameter for VOD content
"channelData": {
"intentResult":{
"name": "CONTENT.CONFIG_AUDIO"
},
"actions": [
{
"name": "REMOTEON.PLAYPARAMS",
"target": "stb",
"params": {
"catalogType": "l7d",
"contentId": "12345",
"liveProgramId": "54321",
"deviceId": "Mi-29283",
"audio": "eng"
}
Change audio parameter for channel
"channelData": {
"intentResult":{
"name": "CHANNEL.CONFIG_AUDIO"
},
"actions": [
{
"name": "REMOTEON.LIVEPARAMS",
"target": "stb",
"params": {
"channelNumber": 1,
"channelId ": "123",
"deviceId": "Mi-29283",
"audio": "eng"
}
}
Change subtitles parameter for VOD content
"channelData": {
"intentResult":{
"name": "CONTENT.CONFIG_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.PLAYPARAMS",
"target": "stb",
"params": {
"catalogType": "l7d",
"contentId": "12345",
"liveProgramId": "54321",
"deviceId": "Mi-29283",
"subtitles": "eng"
}
}
Change subtitles parameter for channel
"channelData": {
"intentResult":{
"name": "CHANNEL.CONFIG_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.LIVEPARAMS",
"target": "stb",
"params": {
"channelNumber": 1,
"channelId ": "123",
"deviceId": "Mi-29283",
"subtitles": "eng"
}
}
Deactivate subtitles parameter for VOD content
"channelData": {
"intentResult":{
"name": "CONTENT.DEACTIVATE_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.PLAYPARAMS",
"target": "stb",
"params": {
"catalogType": "l7d",
"contentId": "12345",
"liveProgramId": "54321",
"deviceId": "Mi-29283",
"subtitles": "void"
}
}
Deactivate subtitles parameter for channel
"channelData": {
"intentResult":{
"name": "CHANNEL.DEACTIVATE_SUBTITLES"
},
"actions": [
{
"name": "REMOTEON.LIVEPARAMS",
"target": "stb",
"params": {
"channelNumber": 1,
"channelId ": "123",
"deviceId": "Mi-29283",
"subtitles": "void"
}
}
Move channels down
"channelData": {
"intentResult": {
"name": "CHANNEL_DOWN"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "P-",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "1"
}
}],
}
Move channels up
"channelData": {
"intentResult": {
"name": "CHANNEL_UP"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "P+",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "1"
}
}],
}
Mute TV
"channelData": {
"intentResult": {
"name": "MUTE"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "MUTE",
"deviceId": "10.149.202.30_E0B70ADBE4CA"
}
}],
}
Unmute TV
"channelData": {
"intentResult": {
"name": "UNMUTE"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "UNMUTE",
"deviceId": "10.149.202.30_E0B70ADBE4CA"
}
}],
}
Switch TV off
"channelData": {
"intentResult": {
"name": "SWITCH_OFF"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "STANDBY",
"deviceId": "10.149.202.30_E0B70ADBE4CA"
}
}],
}
Switch TV on
"channelData": {
"intentResult": {
"name": "SWITCH_ON"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "STANDBY",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "1"
}
}],
}
Pause TV
"channelData": {
"intentResult": {
"name": "PAUSE"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "PAUSE",
"deviceId": "10.149.202.30_E0B70ADBE4CA"
}
}],
}
Resume TV example
"channelData": {
"intentResult": {
"name": "RESUME"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "PLAY",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
}
}],
}
Stop TV
"channelData": {
"intentResult": {
"name": "STOP"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "STOP",
"deviceId": "10.149.202.30_E0B70ADBE4CA"
}
}],
}
Volume up
"channelData": {
"intentResult": {
"name": "VOLUME_UP"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "VOL+",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "5"
}
}],
}
Volume down
"channelData": {
"intentResult": {
"name": "VOLUME_DOWN"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "VOL-",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "5"
}
}],
}
Move forward
"channelData": {
"intentResult": {
"name": "MOVE_FORWARD"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "MOVE_FORWARD",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "60"
}
}],
Move back
"channelData": {
"intentResult": {
"name": "MOVE_BACK"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "MOVE_BACK",
"deviceId": "10.149.202.30_E0B70ADBE4CA",
"levels": "60"
}
}],
Disable subtitles
"channelData": {
"intentResult": {
"name": "AUDIO_SUBTITLES",
"entities": []
},
"actions": [
{
"name": "AUDIO_SUBTITLES",
"target": "stb",
"params": {
"deviceId": "Mi-29283",
"subtitles": "None"
}
},
{
"name": "MAKE_SOUND",
"target": "channel",
"params": {
"sound": "positive"
}
}
],
Change language
"channelData": {
"intentResult": {
"name": "AUDIO_SUBTITLES",
"entities": []
},
"actions": [
{
"name": "REMOTEON.AUDIO_SUBTITLES",
"target": "stb",
"params": {
"deviceId": "Mi-29283"
}
},
{
"name": "MAKE_SOUND",
"target": "channel",
"params": {
"sound": "positive"
}
}
],
Go to app
"channelData": {
"correlator": "520f1e3a-f02b-4bf1-bcda-19d30e0cba0b",
"version": "3",
"intentResult": {
"name": "GOTOAPP",
"entities": [{
"type": "ent.tv_app",
"entity": "Netflix",
}]
},
"actions": [
{
"name": "GOTOAPP",
"target": "stb",
"params": {
"deviceId": "Mi-29283",
"name": "Netflix",
"id": "ID03242"
}
},
{
"name": "MAKE_SOUND",
"target": "channel",
"params": {
"sound": "positive"
}
}
],
"status": {
"code": "SUCCESS",
"message": "Success"
}
}
Communications examples
Call a number
"channelData": {
"actions": [{
"name": "COMMUNICATIONS.CALL_NUMBER",
"target": "channel",
"params": {
"items": [{
"type": "ent.phonenumber",
"value": "916547889"
}]
}],
Call a contact
"channelData": {
"actions": [{
"name": "COMMUNICATIONS.CALL_NAME",
"target": "channel",
"params": {
"items": [{
"type": "ent.com_name",
"value": "mamá"
}]
}],
Redial a number
"channelData": {
"actions": [{
"name": " COMMUNICATIONS.REDIAL",
"target": "channel",
"params": {
"items": [{
"type": "ent.phonenumber",
"value": "916547889"
}]
}],
Domotics examples
Switch off the lights
"channelData": {
"actions": [{
"name": "DOMOTICS.LIGHT_OFF",
"target": "channel",
"params": {
"actionCode": "LIGHT_OFF",
"deviceId": "",
"levels": "1"
}
}],
Switch on the lights
"channelData": {
"actions": [{
"name": "DOMOTICS.LIGHT_ON",
"target": "channel",
"params": {
"actionCode": "LIGHT_ON",
"deviceId": "",
"levels": "1"
}
}],
Miscellaneous examples
Get access to wifi
"content": {
"type": "wifi_info",
"data": {
"status": "ok",
"ssid": "xxxx",
"password": "yyyy",
"bssid": "zzzzzz",
"channel": "10",
"authentication": "WPA-2",
}
}
Navigation examples
Show selected section
"channelData": {
"actions": [
{
"name": "NAVIGATION.SECTION_SHOW",
"target": "stb",
"params": {
"deviceId": "Mi-29283",
"name": "Seccion1",
"id": "ID0666"
}
},
{
"name": "MAKE_SOUND",
"target": "channel",
"params": {
"sound": "positive"
}
}
]
}
Go back in navigation
"channelData": {
"intentResult":{
"name": "NAVIGATION.BACK"
},
"actions": [{
"name": "SEND_KEY",
"target": "stb",
"params": {
"keyCode": "BACK",
"devideId": "Mi-29283
}
}],
Constants values
This section includes the possible values that some fields could take. Specifically, the fields defined here are activeApp from the request, target from the actions and sound from the cross action MAKE_SOUND defined in Aura’s response.
Active app values
| App Name | Description |
|---|---|
| movistar | Telefonica TV platform. By default, application. |
| netflix | Netflix TV platform. |
Action target values
| Target Name | Description |
|---|---|
| channel | The action must be executed by the channel sending the request. |
| stb | The action must be executed over the Set-Top-Box. |
Sound values
| Sound | Description |
|---|---|
| positive | The channel might make a positive sound. |
| negative | The channel might make a negative sound. |
Input examples
The information included in this section represents a subset of an example of third-party request. Concretely, a request that a user makes to Aura from Netflix app and with the needed permissions to ask for Netflix content.
"channelData": {
"appContext": {
"application": {
"activeApp": "netflix",
"thirdParties": [
"name": "netflix",
"data": {
"third_deviceID": "ESN Value",
"persoParameters": {
"cookieList": [ {
"name": "ABCDEG",
"value": "XXXX"
},
{
"name": "nfvdid",
"value": "YYYYY"
}],
"tokenDET": "Recommendation Token",
"vdid": "VDID Value"
}
}]
}
}
}