Categories:
JSON schema for channelData v3 request model
Description of the JSON schema for channelData v3 request model
General conventions
- Properties corresponding to the request model can be general (applicable for all channels) or specific for TV channels. In order to identify the type(s) of each property, regarding the abovementioned classification, the following symbols will be used in the JSON schemas:
| Types of properties | Tags in JSON schemas |
|---|---|
| General property (applicable for all channels) | No tag in description |
| Specific property for TV channels Currently: Movistar Plus, Movistar Home, STB |
Tag [TV] in description |
- The mandatory parameters are included in the field required of each property in the corresponding JSON files.
JSON schema for channelData v3 request model
{
"$schema": "http://json-schema.org/schema#",
"$id": "resource:/aura-models/channel-data/3.2.0/request/channeldata-3.2.0-request.schema#",
"$ref": "#/definitions/aura/bot/3.2.0/request/RequestChannelData",
"$version": "3.2.0",
"definitions": {
"aura": {
"bot": {
"3.2.0": {
"request": {
"RequestChannelData": {
"type": "object",
"description": "Properties corresponding to the request model can be general (applicable for all channels), specific for TV channels or specific for Living Apps. In order to identify the type(s) of each property, regarding the abovementioned classification, the following symbols will be used in the JSON schemas: General property (No tag in description), Specific property for TV channels Currently: Movistar Plus, Movistar Home, STB (Tag [TV] in description), Specific property for Living Apps (Tag [LA] in description).",
"additionalProperties": false,
"properties": {
"appContext": {
"description": "This property contains application context data to let the Aura bot instance adapt its response to the characteristics of the application being used by the Telefónica client to interact with Aura. It contains both general properties and specific properties for TV channels and Living Apps.",
"$ref": "#/definitions/aura/bot/3.2.0/request/AppContext"
},
"auraCommand": {
"description": "This property makes it possible to send a specific intent to the Aura bot on behalf of the Telefónica client interacting with Aura. Consequently, the message contents do not need to be analysed to recognize the Telefónica client intent.",
"$ref": "#/definitions/aura/bot/3.2.0/request/AuraCommand"
},
"correlator": {
"description": "This property contains an UUID uniquely identifying the concrete request sent through the channel. This unique identifier is of great help when doing cross system analysis, as a way to correlate the actions executed by distinct elements of the whole system associated to the fulfilment of the same request. In case the correlator property is not provided, the Aura bot will generate one and pass it over in any interaction with any external component.",
"type": "string",
"format": "uuid"
},
"imageSettings": {
"description": "This property makes it possible to provide information about the graphical screening capabilities exposed by the application used by the Telefónica client to interact with the Aura bot instance. The contents of this property are typically used to optimize the graphical content sent by the Aura bot instance to the application finally showing the graphical information sent.",
"$ref": "#/definitions/aura/bot/3.2.0/request/ImageSettings"
},
"version": {
"description": "This property encodes the version of the Aura Request - Response Semantic Model being used, so the structural dependencies and semantics of the data provided can be properly managed (e.g, 0.1, 0.2, 0.3, 1.0.0, 2.0.0, 3, 4, etc).",
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+){0,2}$"
},
"payload": {
"description": "Channel data payload information. This property can be used by an external component to aura-bot in order to send information for the enrichment of the request. Information is sent that does not correspond to the bot-framework communication model, but that aura-bot and certain dialogs use to complete processing. Currently it is used by components interacting with the bot through Aura bridge, but it could is used by any component.",
"type": "object"
}
},
"required": [
"appContext",
"version"
],
"title": "ChannelData"
},
"AppContext": {
"type": "object",
"additionalProperties": false,
"properties": {
"application": {
"description": "[TV] This property includes information about the characteristics of the application being used by the Telefónica client to interact with the Aura bot instance. It is optional but recommended. It contains both general sub-properties and specific ones for TV channels. In Spain it is a mandatory parameter for TV use cases. It is a general property, but for the current model, it is only applied for TV use cases. In fact, in Spain it is a mandatory parameter for TV use cases",
"$ref": "#/definitions/aura/bot/3.2.0/request/Application"
},
"channel": {
"description": "This property includes information about the channel being used by the Telefónica client to interact with the Aura bot instance.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Channel"
},
"device": {
"description": "[TV] This property includes Information about the physical device used by the Telefónica client to interact with the Aura bot instance. It is optional but recommended. In Spain it is a mandatory parameter for TV use cases.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Device"
},
"location": {
"description": "[TV] This property includes information about the location where the user is located. It is optional but recommended. In Spain, it is a mandatory parameter for TV use cases. If not sent, logical.unknown location will be used.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Location"
},
"user": {
"description": "[TV] This property includes information about the user associated to the Telefónica client interacting with the Aura bot instance. This information can be used to customize the response sent back by the Aura bot instance to the specific Telefónica client. It is a general property, but for the current model, it is only applied for TV use cases. In fact, in Spain it is a mandatory parameter for TV use cases.",
"anyOf": [
{
"$ref": "#/definitions/aura/bot/3.2.0/request/TvUser"
}
]
},
"contextFilters": {
"description": "This property includes information in a string array format which may be used to filter the final response sent by the Aura bot instance back to the Telefónica client. For example, to determine the most appropriate answer to a generic question. The format of each entry of the array should be key:value, where both key and value are application dependant.contextfilters for more information.#contextfilters for more information.",
"type": "array",
"items": {
"type": "string"
}
},
"timestamp": {
"description": "This property includes an ISO 8601 formatted string with the exact local time instant when the request was sent. It should contain the local time including the corresponding time zone. For example: 2019-07-01T10:15:30+01:00, for a Europe/Madrid time.",
"type": "string",
"format": "date-time"
},
"timezone": {
"description": "This property includes the time zone from where the Telefónica client is interacting with the Aura bot instance according to the official time zones (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"type": "string"
},
"livingApp": {
"description": "[LA] This property includes the time zone from where the Telefónica client is interacting with the Aura bot instance, according to the [official time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"$ref": "#/definitions/aura/bot/3.2.0/request/LivingApp"
}
},
"required": [
"channel",
"timestamp",
"timezone"
],
"title": "AppContext"
},
"Application": {
"type": "object",
"additionalProperties": false,
"properties": {
"activeApp": {
"description": "This property includes information about the application or third party that is opened in the channel. An example of this is 'netflix' or 'movistar'. The value of the application must be something stipulated between the channels and the developers of use cases in case they want to make a different logic based on this value and it should not depend on the environment. By default, the activeApp is 'movistar'.",
"type": "string"
},
"countryId": {
"description": "This property includes 2-letters country identifier as defined by the ISO-3166 specification (https://en.wikipedia.org/wiki/ISO_3166) where the Telefónica client is located.",
"type": "string"
},
"screen": {
"description": "[TV] This property includes information about the screen characteristics used by the Telefónica client to interact with the Aura bot instance.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Screen"
},
"thirdParties": {
"description": "This property includes an array of third parties that are available in the application. Each third party is described by a name and an open object with the information that is necessary to interact with the third party.",
"type": "array",
"items": {
"$ref": "#/definitions/aura/bot/3.2.0/request/ThirdParty"
}
},
"thirdPartiesContent": {
"description": "Boolean where the channel indicates if contents from third parties are allowed or not in the response. It is an optional field, if not included it is considered as false",
"type": "boolean"
},
"playing": {
"description": "[TV] This property includes information about the content being played for the specific cases when the Telefónica client is interacting with the Aura bot instance through a media player such as a TV or a channel enabled to be linked with a TV.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Playing"
},
"playMode": {
"description": "[TV] For the specific cases when the Telefónica client is interacting with the Aura bot instance through a media player (such as a TV), this property states if the access if being made by the concrete media player device or by an external app where the content is embedded and played. The property can have one on these values: 'locale', if content is played in the physical media player device; 'remote', if content is played in an external app.",
"type": "string",
"enum": [
"locale",
"remote"
]
}
},
"title": "Application"
},
"Screen": {
"type": "object",
"additionalProperties": false,
"properties": {
"elements": {
"description": "It contains both general sub-properties and specific ones for TV channels. For the specific cases when the Telefónica client is interacting with the Aura bot instance through a media player (such as a TV), this property includes information about what it is being shown in the screen.",
"type": "array",
"items": {
"$ref": "#/definitions/aura/bot/3.2.0/request/Element"
}
},
"name": {
"description": "This property includes an identifier of the screen or section of the screen the Telefónica customer is interacting through with the Aura bot. The value of this field is open, but it should follow this format: 'rootSection.[childrenSections].pageName'. It should contain a dot-separated list of the section's navigation tree, ending with the current page. For a common understanding, 'home' should be used for the main page of each section.",
"type": "string"
}
},
"title": "Screen"
},
"Element": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "[TV] This property identifies the type of the element. It represents what is shown in the user's screen. In case the element that the channel is describing belongs to a third party (for example Netflix) the element type should be 'thirdPartyContent'.",
"type": "string",
"enum": [
"tvContent",
"thirdPartyContent"
]
},
"payload": {
"description": "General property (applicable for different channels), although in the current model it only includes sub-properties for TV channels and thirdParties.",
"anyOf": [
{
"$ref": "#/definitions/aura/bot/3.2.0/request/TvPayload"
},
{
"$ref": "#/definitions/aura/bot/3.2.0/request/ThirdPartyPayload"
},
{
"type": "object"
}
]
}
},
"required": [
"type",
"payload"
],
"title": "Element"
},
"TvPayload": {
"type": "object",
"additionalProperties": false,
"properties": {
"contentId": {
"description": "Content identifier.For live content, equivalent to show_id in Spain and schedule_id in GVP platform.",
"type": "string"
},
"vodAssociated": {
"description": "'true', if the content is available on Video on Demand; 'false' for all other content types.",
"type": "boolean"
},
"resumeTime": {
"description": "Time in seconds already watched by the user.",
"type": "integer"
},
"catalogType": {
"description": "Type of content being played. Possible values are: 'live' for broadcasted content; 'vod' for video on demmand; '17d' for last 7 days; 'record' for recordings. ",
"type": "string",
"enum": [
"live",
"vod",
"l7d",
"record"
]
},
"liveProgramId": {
"description": "This property includes an identifier of the airing of the show the Telefónica customer is watching. Only for U7D, live and recordings. Equivalent to CRID_id in Spain and program_id in GVP platform.",
"type": "string"
},
"season": {
"description": "Season number for recurrent content.",
"type": "integer"
},
"episode": {
"description": "Episode number for recurrent content.",
"type": "integer"
},
"title": {
"description": "Content title (title of the movie or of the specific episode)",
"type": "string"
},
"focus": {
"description": "'true', if the visual element is focused; 'false' if not.",
"type": "boolean"
}
},
"required": [
"contentId",
"catalogType"
],
"title": "TvPayload"
},
"ThirdPartyPayload": {
"type": "object",
"additionalProperties": false,
"properties": {
"thirdPartyId": {
"description": "Identifier of the application or third party to which the content belongs.",
"type": "string"
},
"thirdPartyName": {
"description": "Name of the application or third party to which the content belongs.",
"type": "string"
},
"contentId": {
"description": "Content identifier.",
"type": "string"
},
"catalogType": {
"description": "Type of content being played. Possible values are: 'live' for broadcasted content; 'vod' for video on demmand; '17d' for last 7 days; 'record' for recordings.",
"type": "string",
"enum": [
"live",
"vod",
"l7d",
"record"
]
},
"title": {
"description": "Content title (title of the movie or of the specific episode)",
"type": "string"
},
"focus": {
"description": "'true', if the visual element is focused; 'false' if not.",
"type": "boolean"
},
"deeplink": {
"description": "Content deeplink",
"type": "string"
}
},
"title": "ThirdPartyPayload"
},
"ThirdParty": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "This property includes a name of the ThirdParty for which it contains information.",
"type": "string"
},
"data": {
"description": "This property includes an open object where the channel can put all the information that is necessary to interact with the ThirdParty.",
"type": "object"
}
},
"required": [
"name"
],
"title": "ThirdParty"
},
"Playing": {
"type": "object",
"additionalProperties": false,
"properties": {
"catalogType": {
"description": "Type of content being played. Possible values are: 'live' for broadcasted content; 'vod' for video on demmand; '17d' for last 7 days; 'record' for recordings.",
"type": "string",
"enum": [
"live",
"vod",
"l7d",
"record"
]
},
"audioList": {
"description": "This property includes an array whose values are 3-letters codes (ISO 639-2) stating the available audio language.",
"type": "array",
"items": {
"type": "string"
}
},
"currentAudioId": {
"description": "This property states the audio language selected by the Telefónica client to play the associated content. The value of this property must be one of the keys included in the audioList property.",
"type": "string"
},
"subtitlesList": {
"description": "This property includes an array whose values are 3-letters codes (ISO 639-2) stating the available languages for subtitles.",
"type": "array",
"items": {
"type": "string"
}
},
"currentSubtitlesId": {
"description": "This property states the subtitles language selected by the Telefónica client to play the associated content. The value of this property must be one of the keys included in the subtitlesList property. If no subtitles are selected, this property should not be included.",
"type": "string"
},
"recordingAllowed": {
"description": "This property indicates if the content can be recorded.The possible values of this property are: 'false', if the content cannot be recorded (unique possible value if 'type' is VoD); 'true', if the content can be recorded.",
"type": "boolean"
},
"resumeTime": {
"description": "Time in seconds already watched by the user.",
"type": "integer"
},
"channelNumber": {
"description": "In case the Telefónica customer is playing content on the TV device this property indicates the tuned dial the Telefónica customer is watching. Only for Live content.",
"type": "string"
},
"contentId": {
"description": "Content identifier.",
"type": "string"
},
"channelId": {
"description": "In case the Telefónica customer is playing content on an IPTV device, this property indicates the unique identifier of the channel the Telefónica customer is watching. Only for Live and recorded content.",
"type": "string"
},
"liveProgramId": {
"description": "Program id that allows to relate all the broadcasts of the same content. It is a Content ID.",
"type": "string"
},
"startOverAllowed": {
"description": "This property states if the associated content can be watched from the beginning or not. The possible values of this property are: 'false', if the content cannot be started again; 'true', if the content can be started again.",
"type": "boolean"
},
"season": {
"description": "Season number for recurrent content.",
"type": "integer"
},
"episode": {
"description": "Episode number for recurrent content.",
"type": "integer"
},
"movedBackward": {
"description": "This parameter is used to indicate that the user has moved the playback backwards, either with the 'view from the beginning' button or with the 'rewind' button. This parameter only makes sense when the user is watching a television channel, otherwise the value will be 'false'. It can take two values: 'false', if the user is watching a channel and has not moved its playback back; 'true' if he is watching a channel and has moved its playback backwards.",
"type": "boolean"
}
},
"required": [
"catalogType",
"contentId"
],
"title": "Playing"
},
"Channel": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "This property includes a unique identifier in UUID format which uniquely identifies the channel in Aura. The UUID is the same for all OBs. This identifier must be provided by Aura Operations Team to the channel.",
"type": "string",
"format": "uuid"
},
"interfaceLanguage": {
"description": "This property includes a combination of ISO-3166 2-letters country codes and ISO 639-1 2-letter language code separated by a hyphen stating the language used by the Telefónica client to interact with the concrete Aura bot instance. For example, 'es-ES' for spanish used in Spain.",
"type": "string"
},
"modality": {
"description": "This property describes the way the Telefónica client used to interact with the Aura bot instance.",
"type": "string",
"enum": [
"audio",
"text",
"form"
]
}
},
"required": [
"id",
"modality"
],
"title": "Channel"
},
"Device": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "This property includes a unique identifier of the device the Telefónica client used to interact with the Aura bot instance. This id must be already registered in the backends of the OB.",
"type": "string"
},
"type": {
"description": "This property states the type of device used by the Telefónica client used to interact with the Aura bot instance. The possible values should be aligned with the APIs backend to ensure that contents will be returned. Some values used nowadays are 'homebase', 'android.cell', 'remote', 'HB_TEF'",
"type": "string"
},
"platform": {
"description": "This property describes the specific platform the Telefónica client used to interact with the Aura bot instance.",
"type": "string",
"enum": [
"home",
"mobile",
"other",
"pc",
"stb",
"tablet",
"tv"
]
},
"maxQuality": {
"description": "Highest video quality of the device prepared to reproduce a content (physical media player device or external device). This field will have one of the following values: 'UHD_4K' for 4K content; 'HighDefinition' for HD content; 'StandardDefinicion' for SD content; 'LowDefinition' for LD content. These values are the same you can find in the 4P API for retrieving content (https://developers.baikalplatform.com/apis/video-contents/2.0.0/).",
"type": "string",
"enum": [
"HighDefinition",
"LowDefinition",
"StandardDefinition",
"UHD_4K"
]
},
"allowedCatalogTypes": {
"type": "string",
"description": "This property includes a comma-separated list of the catalog types that the device is able to play."
}
},
"required": [
"id",
"type"
],
"title": "Device"
},
"Location": {
"type": "object",
"additionalProperties": false,
"properties": {
"logical": {
"description": "This property describes the location from where the Telefónica client interacts with the Aura bot instance.",
"type": "string",
"enum": [
"home",
"outside",
"unknown"
]
},
"currentRegion": {
"description": "[TV] This property indicates which is the TV demarcation where the user is at the time of the request. It is used to return to the user only those channels that she can see, based on this region. Property only available for TV channels.",
"type": "string"
}
},
"title": "Location"
},
"TvUser": {
"type": "object",
"additionalProperties": false,
"properties": {
"accountNumber": {
"description": "This property includes an identifier uniquely identifying the Telefónica client interacting with the Aura bot instance.",
"type": "string"
},
"ageRating": {
"description": "This property includes the age rating code",
"type": "string"
},
"childProfile": {
"description": "This flag indicates if the profile for kids is enabled",
"type": "boolean"
},
"productList": {
"description": "This property includes a list of the products available in the active contract for the Telefónica client interacting with the Aura bot instance.",
"type": "array",
"items": {
"type": "string"
}
},
"profile": {
"description": "This property describes the commercial offer chosen by the Telefónica client interacting with the Aura bot instance. This property only applies in the case of Spain for STB, Movistar Home and Movistar Plus channels. Some possible values for this property are: 'anonimo', 'basico', 'iptv', 'junior' in Spain; '58|TVOD' in GVP Platform.",
"type": "string"
},
"purchaseList": {
"description": "List with the content purchased by the user (tVOD).",
"type": "array",
"items": {
"type": "string"
}
},
"STBList": {
"description": "This property includes the list of STBs which belongs to the Telefónica client interacting with the Aura bot instance.",
"type": "array",
"items": {
"$ref": "#/definitions/aura/bot/3.2.0/request/STBType"
}
},
"videoProfileName": {
"description": "This property includes an identifier of the content profile the Telefónica client has selected to interact with the Aura bot instance.",
"type": "string"
}
},
"required": [
"accountNumber",
"STBList"
],
"title": "TvUser"
},
"STBType": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "This property includes the device identifier of the STB.",
"type": "string"
},
"model": {
"description": "This property includes the device model of the STB.",
"type": "string"
},
"prettyName": {
"description": "This property includes a printable name of the STB device. This can be modified by the user using the STB UI.",
"type": "string"
},
"remotePlayAllowed": {
"description": "This property includes a boolean value (this is, true or false) describing if the STB device allows the possibility of playing content launched from a remote entity such as a mobile application.",
"type": "boolean"
},
"remotePlayOn": {
"description": "This property includes a boolean value (this is, true or false) describing if the STB device is on or off.",
"type": "boolean"
},
"maxQuality": {
"description": "Highest video quality of the device. This field will have one of the following values: 'UHD_4K' for 4K content; 'HighDefinition' for HD content; 'StandardDefinition' for SD content; 'LowDefinition' for LD content. These values are the same you can find in the 4P API for retrieving contents (https://developers.baikalplatform.com/apis/video-contents/2.0.0/).",
"type": "string",
"enum": [
"HighDefinition",
"LowDefinition",
"StandardDefinition",
"UHD_4K"
]
}
},
"required": [
"id",
"model",
"maxQuality"
],
"title": "STBType"
},
"LivingApp": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "[LA] This property includes an identifier uniquely identifying (UUID) the Living App in Aura.",
"type": "string",
"format": "uuid"
},
"name": {
"description": "[LA] This property includes a semantic identifier uniquely identifying the Living App in Aura.",
"type": "string"
},
"prefix": {
"description": "[LA] This property includes the short name associated to the Living App",
"type": "string"
},
"sessionId": {
"description": "[LA] This property includes an identifier uniquely identifying the session associated to the Living App in Aura. The sessionId property must be sent if it was previously received in the start-living-app event response message.",
"type": "string"
}
},
"required": [
"id",
"name",
"prefix",
"sessionId"
],
"title": "LivingApp"
},
"AuraCommand": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Type of Aura command sent on behalf of the Telefónica client interacting with the Aura bot instance. The possible values of this property are:\n -'intent': This type of Aura command is associated to sending an already known user intention.\n - 'suggestion': This type of Aura command is dedicated to send the suggestions provided by Aura Bot. The command must be returned as it was sent, without any change.\n - 'notification': this type of Aura command is associated to an intent generated by a notification sent by Aura Notifications System.\n - 'operation': this type of Aura command is associated to intents which need an already running dialog context in Aura. It is something like a sub-dialog within a main one.\n - 'text': type of Aura command intended for setting a given text in the value of the command. The result will be the same as setting the string as the text of the request.\n - 'event': this Aura command contains an event that happened in the channel and must be informed to Aura bot, so it can be handled properly: stored in the context or in Kpis, for example.",
"type": "string",
"enum": [
"intent",
"suggestion",
"notification",
"operation",
"text",
"event"
]
},
"value": {
"description": "This property includes the data needed to execute the command. Its content depends on the type of Aura command.",
"anyOf": [
{
"$ref": "#/definitions/aura/bot/3.2.0/request/SuggestionValue"
},
{
"$ref": "#/definitions/aura/bot/3.2.0/request/NotificationValue"
},
{
"$ref": "#/definitions/aura/bot/3.2.0/request/EventValue"
},
{
"type": "string"
}
]
},
"utm": {
"description": "It shows the exact interface element that was used by the user to launch the auraCommand.",
"$ref": "#/definitions/aura/bot/3.2.0/request/Utm"
}
},
"required": [
"type",
"value"
],
"title": "AuraCommand",
"allOf": [
{
"if": {
"properties": {
"type": {
"pattern": "intent|suggestion|operation"
}
}
},
"then": {
"properties": {
"value": {
"$ref": "#/definitions/aura/bot/3.2.0/request/SuggestionValue"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "notification"
}
}
},
"then": {
"properties": {
"value": {
"$ref": "#/definitions/aura/bot/3.2.0/request/NotificationValue"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "text"
}
}
},
"then": {
"properties": {
"value": {
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "event"
}
}
},
"then": {
"properties": {
"value": {
"$ref": "#/definitions/aura/bot/3.2.0/request/EventValue"
}
}
}
}
]
},
"SuggestionValue": {
"type": "object",
"additionalProperties": false,
"properties": {
"intent": {
"description": "This property includes the Aura intention reference which will determine the Aura dialog to execute. The format of this property is: intent.<libraryId>.<intentId>.In case the prefix intent. is not included in the value of this property, it will be included by default.",
"type": "string"
},
"entities": {
"description": "This property includes an array of additional information the Aura bot instance needs to properly accomplish the intent of the Telefónica client. Every entity is a JSON object including 2 properties: 'type': this property includes a string stating the type of entity; 'entity': this property includes a string stating the value of the entity.",
"type": "array",
"items": {
"$ref": "#/definitions/aura/bot/3.2.0/request/Entity"
}
}
},
"required": [
"intent"
],
"title": "SuggestionValue"
},
"NotificationValue": {
"type": "object",
"additionalProperties": false,
"properties": {
"action": {
"description": "This property includes the Aura intention reference, that informs which dialog is executed to accomplish the Telefónica client intent. The format of this property is: <libraryId>.<intentId>. As with the rest of intents, the Aura bot instance will add by default the prefix 'intent.' to resolve it.",
"type": "string"
},
"notificationData": {
"description": "This property includes detailed information about the notification being sent to the Telefónica client. The data sent will let Aura predict unusual behaviour in clients billing, balance or data consumption. Depending on the action, the data included in this property will be one of the payloads defined in aura-insights-events API (https://developers.baikalplatform.com/apis/aura-bot-events/)",
"type": "object"
}
},
"required": [
"action",
"notificationData"
],
"title": "NotificationValue"
},
"EventValue": {
"type": "object",
"additionalProperties": false,
"properties": {
"intent": {
"description": "This property includes the Aura intention reference informing which dialog is executed to accomplish the Telefónica client intent. The format of this property is: <libraryId>.<intentId>. As with the rest of intents, the Aura bot instance will add by default the prefix 'intent.' to resolve it.",
"type": "string"
},
"entities": {
"description": "This property includes an array of additional information the Aura bot instance needs to properly accomplish the intent of the Telefónica client. Every entity is a JSON object including 2 properties: 'type': this property includes a string stating the type of entity; 'entity': this property includes a string stating the value of the entity.",
"type": "array",
"items": {
"$ref": "#/definitions/aura/bot/3.2.0/request/Entity"
}
},
"text": {
"description": "User utterance.",
"type": "string"
},
"type": {
"description": "Event type: local-grammar.",
"type": "string"
},
"payload": {
"description": "Specific per event type.",
"type": "object"
}
},
"required": [
"type"
],
"title": "EventValue"
},
"Utm": {
"type": "object",
"additionalProperties": false,
"properties": {
"source": {
"description": "It identifies which site sent the traffic. Please, use the channel name.",
"type": "string"
},
"medium": {
"description": "It identifies what type of link was used, such as cost per click or email.",
"type": "string"
},
"campaign": {
"description": "It identifies a specific product promotion or strategic campaign.",
"type": "string"
},
"term": {
"description": "It identifies search terms.",
"type": "string"
},
"content": {
"description": "It identifies what was specifically clicked to bring the user to the site, such as a banner ad or a text link.",
"type": "string"
}
},
"required": [
"source"
],
"title": "Utm"
},
"Entity": {
"type": "object",
"additionalProperties": false,
"properties": {
"canon": {
"description": " This property includes the canonical form of the entity sent on behalf of the Telefónica client interacting with the Aura bot instance.",
"type": "string"
},
"endIndex": {
"description": "The index at which this entity ends in the original user message.",
"type": "number"
},
"entity": {
"description": "This property includes the value of the entity sent on behalf of the Telefónica client interacting with the Aura bot instance.",
"type": "string"
},
"label": {
"description": "This property includes an internally used descriptive tag of the entity sent on behalf of the Telefónica client interacting with the Aura bot instance.",
"type": "string"
},
"score": {
"description": "This property includes the accuracy (in per 1 units) of the recognized entity sent on behalf of the Telefónica client interacting with the Aura bot instance. In the case of Aura commands this value should be 1 since in this case fully recognized intentions are sent.",
"type": "number"
},
"startIndex": {
"description": "The index at which this entity starts in the original user message.",
"type": "number"
},
"type": {
"description": "This property includes the type of the entity sent on behalf of the Telefónica client interacting with the Aura bot instance. The format used by this property is the following one: ent.<entityType>",
"type": "string"
}
},
"required": [
"canon",
"entity",
"score",
"type"
],
"title": "Entity"
},
"ImageSettings": {
"type": "object",
"additionalProperties": false,
"properties": {
"graphicsWidth": {
"description": "This property indicates the recommended width in pixels of the images the Aura bot instance should sent to the Telefónica client according to the communication means she is using to interact with Aura. The default value is 500.",
"type": "integer"
},
"resolution": {
"description": "This property indicates the recommended scaling factor the Aura bot instance should apply to the images sent to the Telefónica client. The possible values for this property are: 'mdpi': 1.0x; 'hdpi': 1.5x; 'xhdpi': 2.0x; 'xxhdpi': 3.0x; 'xxxhdpi': 4.0x. The default value is 'mdpi'.",
"type": "string",
"enum": [
"mdpi",
"hdpi",
"xhdpi",
"xxhdpi",
"xxxhdpi"
]
}
},
"title": "ImageSettings"
}
}
}
}
}
}
}
Last modified November 11, 2025: feat: Clean up of Living Apps related stuff #AURA-30761 [RTM] (c97ca748)