Objetos

Last update: 3 years ago by yered.rios

Message

Propiedad	Descripción	Tipo	Requerimientos
text	Texto a enviar. Codificado en UTF-8.	String	Obligatorio si no se especifica: richCard contentInfo. Sólo puede ser especificado en conjunto con suggestions.
richCard	Estructura de Tarjeta Enriquecida.	RichCard	Obligatorio si no se especifica: text contentInfo. Sólo puede ser especificado en conjunto con suggestions.
contentInfo	Información acerca de una imagen o video.	ContentInfo	Obligatorio si no se especifica: text richCard. Sólo puede ser especificado en conjunto con suggestions.
suggestions	Lista de respuestas sugeridas y acciones sugeridas (realizar llamada, enviar ubicación, etc).	Suggestion[]	Máximo 11 sugerencias.

RichCard

Propiedad	Descripción	Tipo	Requerimientos
carouselCard	Carrusel de tarjetas.	CarouselCard	Obligatorio si no se especifica: standaloneCard. No puede ser especificado en conjunto con standaloneCard.
standaloneCard	Tarjeta única.	StandaloneCard	Obligatorio si no se especifica: carouselCard. No puede ser especificado en conjunto con carouselCard.

StandaloneCard

Propiedad	Descripción	Tipo	Requerimientos
cardOrientation	Ancho de las tarjetas del carrusel.	String	Obligatorio Valores aceptados: "HORIZONTAL" (si en cardContent se especifica el campo media, éste debe contener al menos el campo title, description o suggestions[]). "VERTICAL".
thumbnailImageAlignment	Alineación del preview de la imagen cuando cardOrientation es "HORIZONTAL".	String	Obligatorio Valores aceptados: "LEFT" "RIGHT"
cardContent	Contenido de la tarjeta.	CardContent	Obligatorio.

CarouselCard

Propiedad	Descripción	Tipo	Requerimientos
cardWidth	Ancho de las tarjetas del carrusel.	String	Obligatorio Valores aceptados: "CARD_WIDTH_UNSPECIFIED" "SMALL" (Media.height de tipo TALL no puede ser utilizado). "MEDIUM"
cardContents	Listado de contenido por cada tarjeta en el carrusel.	CardContent[]	Obligatorio Mínimo 2 elementos, máximo 10 elementos.

CardContent

Propiedad	Descripción	Tipo	Requerimientos
title	Título de la tarjeta.	String	Máximo 200 caracteres.
description	Texto dentro de la tarjeta.	String	Máximo 2000 caracteres.
media	Imagen o video a incluir en la tarjeta.	Media
suggestions	Lista de respuestas sugeridas y acciones sugeridas (realizar llamada, enviar ubicación, etc).	Suggestion[]	Máximo 4 elementos.

Media

Propiedad	Descripción	Tipo	Requerimientos
height	Altura de la imagen o video dentro de una tarjeta.	String	Obligatorio Valores aceptados: "SHORT" "MEDIUM" "TALL"(No disponible para carouselCard.cardWidth con valor "SMALL").
contentInfo	Información acerca de la imagen o video.	ContentInfo	Obligatorio.

ContentInfo

Propiedad	Descripción	Tipo	Requerimientos
fileUrl	URL de acceso público donde se localiza el archivo, imagen o video.	String	Obligatorio La plataforma determina el tipo de archivo del encabezado HTTP content-type, éste debe estar presente en la respuesta HTTP de la URL y tener un valor de acuerdo al tipo de archivo.
thumbnailUrl	URL de acceso público de la vista previa de la imagen o video.	String	Si no se indica, la plataforma RCS muestra una vista previa en blanco hasta que el dispositivo del usuario descargue el archivo.
forceRefresh	Indica si se busca el archivo y la vista previa de las URL’s especificadas incluso si la plataforma ya tiene copias en cache de estos archivos.	Boolean	Default: false

Suggestion

Propiedad	Descripción	Tipo	Requerimientos
reply	Respuesta sugerida que el usuario puede pulsar para responder al Agente.	suggestedreply	Obligatorio si no se especifica: action.
action	Acción que el usuario puede pulsar para iniciar alguna operación en el dispositivo (realizar llamada, enviar ubicación, etc.)	SuggestedAction	Obligatorio si no se especifica: reply.

SuggestedReply

Propiedad	Descripción	Tipo	Requerimientos
text	Texto que se muestra en la respuesta sugerida y que se envía al Agente cuando el usuario la presiona.	String	Obligatorio. Máximo 25 caracteres.
postbackData	Información que recibe el Agente cuando el usuario presiona la respuesta sugerida.	String	Obligatorio.

SuggestedAction

Propiedad	Descripción	Tipo	Requerimientos
text	Texto que se muestra en la acción sugerida.	String	Obligatorio Máximo 25 caracteres.
postbackData	Información que recibe el Agente cuando el usuario presiona la acción sugerida.	String	Obligatorio.
dialAction	Abre la aplicación para realizar llamadas con un número telefónico pre cargado.	DialAction	Obligatorio si no se especifica: viewLocationAction createCalendarEventAction openUrlAction shareLocationAction.
viewLocationAction	Abre la aplicación de mapas y coloca el pin en una ubicación especificada por el Agente.	ViewLocationAction	Obligatorio si no se especifica: dialAction createCalendarEventAction openUrlAction shareLocationAction.
createCalendarEventAction	Inicia la creación de un nuevo evento dentro de la aplicación de calendario con datos precargados.	CreateCalendarEventAction	Obligatorio si no se especifica: dialAction viewLocationAction openUrlAction shareLocationAction.
openUrlAction	Abre el navegador con la URL indicada. Esta URL puede abrir una app si ésta se encuentra configurada para ello.	OpenUrlAction	Obligatorio si no se especifica: dialAction viewLocationAction createCalendarEventAction shareLocationAction.
shareLocationAction	Abre la aplicación de mapas para que el usuario elija una ubicación y la envíe al Agente.	ShareLocationAction	Obligatorio si no se especifica: dialAction viewLocationAction createCalendarEventAction openUrlAction.

DialAction

Propiedad	Descripción	Tipo	Requerimientos
phoneNumber	Número telefónico que se pre llena en la aplicación para realizar llamadas.	String	Obligatorio El número debe estar en el formato E.164, ej: +525512345678

ViewLocationAction

Propiedad	Descripción	Tipo	Requerimientos
latLong	La latitud y longitud de una ubicación específica.	LatLng	Obligatorio.
label	Texto a mostrar como etiqueta del pin colocado en la latitud y longitud especificadas.	String

LatLng

Propiedad	Descripción	Tipo	Requerimientos
latitude	Latitud en grados	Number	Obligatorio. Debe estar en el rango de -90.0 y +90.0.
longitude	Longitud en grados	Number	Obligatorio Debe estar en el rango de -180.0 y +180.0.

CreateCalendarEventAction

Propiedad	Descripción	Tipo	Requerimientos
startTime	Fecha y hora de inicio del evento en horario UTC.	String	Obligatorio Formato RFC3339. Ej: 2020-10- 02T19:00:00Z
endTime	Fecha y hora de fin del evento en horario UTC.	String	Obligatorio Formato RFC3339. Ej: 2020-10- 02T20:00:00Z
title	Título del evento.	String
description	Descripción del evento.	String

OpenUrlAction

Propiedad	Descripción	Tipo	Requerimientos
url	Url a abrir en el navegador.	String	Obligatorio.

RCS — Anterior