Categories:
aura-movistar-libraries utility
aura-movistar-libraries utility contains utilities to use with dialogs in Movistar channels
Introduction
aura-movistar-libraries utility is an NPM library that contains utility functions provided by Aura Global Team to be used with dialogs in Movistar channels:
- Movistar Home
- Movistar Plus
- Set-top-box (STB)
Find more information in the Github repository: https://github.com/Telefonica/aura-common-utilities/tree/master/packages/aura-bot-utilities/src/aura-movistar-libraries-utilities/
To use it, just define the dependency with @telefonica/aura-movistar-libraries-utilities in your package.json. It is published as a private library in npm, so request a valid NPM token to access it.
models/intent-models
It contains all the necessary classes and interfaces for Movistar use cases. Some of these classes and interfaces are:
MovistarPlusResolution, MovistarStatus, SuggestionAction, etc.
utils/movistar-payload-utils
It contains the functions executed to fill the payload of the message depending on the settings/payloadType in the intent configuration.
The principal functions are: getPayloadDefault, getPayloadCommunications, getPayloadTV and getPayloadWifi.
utils/movistar-resolution-utils
It contains the function to make a query to the Movistar plus resolution API. This query returns a MovistarPlusResolution object that contains suggestions, actions, sound, payload, etc.
Object example returned by getMovistarPlusResolution with intent intent.common.greetings in the STB channel:
{
"intent":"intent.common.greetings",
"entities":[
],
"resources":[
{
"type":"title",
"name":"tv.notUnderstand",
"params":{
}
}
],
"status":"ok",
"payload":{
"type":"",
"data":{
},
"data_additional":{
},
"action":"NONE",
"status":{
"code":"470",
"message":"Intent not Supported Error - General Code",
"info":{
}
}
},
"user_action":{
},
"suggestions":[
{
"intent":"intent.tv.display",
"entities":[
{
"entity":"Canal Cocina",
"type":"ent.audiovisual_channel",
"score":1,
"canon":"Canal Cocina",
"label":""
}
],
"resources":[
{
"type":"title",
"name":"tv.switchToChannel.suggestion.title",
"params":{
"channels":"Canal Cocina"
}
},
{
"type":"button",
"name":"tv.switchToChannel.suggestion.button",
"params":{
"channels":"Canal Cocina"
}
}
]
}
/// More suggestions were returned but are ommited in this example object
],
"sound":"none"
}
utils/movistar-utils
A compendium of utilities which formats activity’s channelData to be compatible with Movistar channels.
The principal function of this file is getMovistarMessage. It returns a properly formed channelData message for the Movistar channels, depending on the input parameters and the settings field in the configuration of the intent. All other functions are auxiliary of this principal.
Example of object returned by getMovistarMessage with input params:
Input params
- Context: Context of the dialog
- Text:
null - MovistarConfig:
{
"type":"common",
"action":"COMMON.GREETINGS",
"locales":{
"success":[
"common:common.greetings.main"
],
"error":[
"common:common.error.main"
]
},
"needTvResolution":true
}
- MovistarPlusResolution: Same as show in previous example
Output message
{
"text":"Hola, buenas",
"channelData":{
"intent":{
"id":"intent.common.greetings",
"name":"intent.common.greetings",
"entities":[
]
},
"content":{
"text":"Hola, buenas",
"speak":"Hola, buenas",
"sound":"positive",
"actions":[
]
},
"dialogContext":[
{
"text":"Quiero ver Canal Cocina",
"value":{
"intent":"intent.tv.display",
"entities":[
{
"entity":"Canal Cocina",
"type":"ent.audiovisual_channel",
"score":1,
"canon":"Canal Cocina",
"label":""
}
]
}
}
/// More suggestions were returned but are ommited in this example object
],
"customData":{
"type":"common",
"action":"COMMON.GREETINGS",
"data":{
},
"data_additional":{
},
"status":{
"code":"200",
"message":"Success - General Code",
"info":{
}
}
},
"fullScreen":false,
"version":"1.0.0"
},
"inputHint":"acceptingInput",
"attachments":[
{
"contentType":"application/vnd.microsoft.card.hero",
"content":{
"buttons":[
{
"type":"postBack",
"title":"Quiero ver Canal Cocina",
"value":{
"name":"Quiero ver Canal Cocina",
"text":"Ver Canal Cocina",
"type":"suggestion",
"intent":"intent.tv.display",
"entities":[
{
"entity":"Canal Cocina",
"type":"ent.audiovisual_channel",
"score":1,
"canon":"Canal Cocina",
"label":""
}
],
"inputIntent":"intent.common.greetings",
"inputEntities":[
]
}
}
/// More suggestions were returned but are ommited in this example object
]
},
"name":"SUGGESTIONS"
}
]
}
suggestionType
Formerly, there was a differentiation between channels based on their prefix. This implementation was quite strict and to parameterize this behavior a new configuration variable has been developed.
SuggestionType must be configured for channels Movistar-Plus, Set-on-Box and Set-on-Box-Haac and its value can be either actions or attachments describing where suggestions must be placed in activity’s channelData.
- ‘actions’:
Movistar-Plus - ‘attachment’:
Set-on-Box,Set-on-Box-Haac