InteractiveCanvas (Dialogflow)

El objeto interactiveCanvas es la interfaz para tu acción conversacional que está disponible en tu app web.

Nota: El objeto interactiveCanvas se adjunta al objeto window. Si usas un framework de frontend para desarrollar la app web, debes asegurarte de tener acceso a window para configurar la API.

Métodos

lista

ready(callbacks) returns undefined

La aplicación web de Interactive Canvas lo llama una vez que se carga para registrar devoluciones de llamada.

Parámetros
callbacks	InteractiveCanvasCallbacks Un objeto que contiene devoluciones de llamada de métodos.

Nota: Debes invocar la API de ready en la app web en cuanto se cargue la página. De lo contrario, se cerrará la Acción.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Envía una consulta de texto a la acción conversacional.

Parámetros
textQuery	string La consulta que se enviará a la acción conversacional.
state	string Uno de los siguientes: READY: La plataforma puede aceptar solicitudes. BLOCKED: Hay una consulta en tránsito y se descartará la consulta nueva. UNKNOWN: No se pudo determinar el estado actual de la consulta.

Precaución: textQuery debe tener 640 caracteres o menos.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Determina la altura del encabezado en la parte superior de una pantalla.

Parámetros
height	number Es la altura en píxeles.

InteractiveCanvasCallbacks

Estas devoluciones de llamada proporcionan una forma de responder a la información o las solicitudes de tu acción conversacional, mientras que los métodos proporcionan una forma de enviar información o solicitudes a tu acción conversacional.

onUpdate

onUpdate(data) returns undefined

Se llama cuando se envía un HtmlResponse desde la acción conversacional. Después de que finalice la llamada a función, el TTS comenzará de inmediato.

Parámetros
data	Object Se actualizaron los datos que envió el webhook.

onTtsMark

onTtsMark(markName) returns undefined

Es la devolución de llamada que se invoca durante la reproducción de TTS.

Marcas especiales que siempre se activan:

• START indica el inicio de la TTS.
• END indica el final del TTS.
• ERROR indica un error al reproducir el TTS.

También puedes definir marcas personalizadas con SSML y la etiqueta <mark>, como <mark name="custom"/>.

Nota: Las marcas de SSML no se invocan en los siguientes casos:

• Antes de que comience la TTS, el usuario presiona el micrófono, o el cliente de Interactive Canvas invoca a sendTextQuery. Se cancelará el TTS y se ignorarán las marcas de SSML incluidas en él.
• Durante la función de TTS, el usuario presiona el micrófono, o el cliente de Interactive Canvas invoca a sendTextQuery. El TTS se interrumpe y las marcas de SSML restantes se ignoran.

Parámetros
markName	string Marca el nombre invocado durante la reproducción de TTS.