InteractiveCanvas (Dialogflow)

L'objet interactiveCanvas correspond à l'interface de votre action de conversation qui est disponible dans votre application Web.

Méthodes

prêt

ready(callbacks) returns undefined

Appelée par l'application Web Interactive Canvas une fois qu'elle est chargée pour enregistrer les rappels.

Paramètres
callbacks InteractiveCanvasCallbacks

Objet contenant des rappels de méthode.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Envoie une requête textuelle à l'action de conversation.

Paramètres
textQuery string

Requête à envoyer à l'action de conversation.
state string

Choisissez l'une des options suivantes :

READY: Les requêtes peuvent être acceptées par la plate-forme.

BLOCKED: Une requête est en cours de transfert et la nouvelle requête sera ignorée.

UNKNOWN: Impossible de déterminer l'état actuel de la requête.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Détermine la hauteur de l'en-tête en haut d'un écran.

Paramètres
height number

Hauteur en pixels.

InteractiveCanvasCallbacks

Ces rappels vous permettent de répondre aux informations ou aux requêtes de votre action de conversation, tandis que les méthodes vous permettent d'envoyer des informations ou des requêtes à votre action de conversation.

onUpdate

onUpdate(data) returns undefined

Appelée lorsqu'une exception HtmlResponse est envoyée par l'action de conversation. À la fin de l'appel de fonction, la synthèse vocale commence immédiatement.

Paramètres
data Object

Données envoyées par le webhook.

onTtsMark

onTtsMark(markName) returns undefined

Rappel invoqué lors de la lecture par synthèse vocale.

Signes spéciaux qui sont toujours déclenchés:

  • START indique le début de la synthèse vocale.
  • END indique la fin de la synthèse vocale.
  • ERROR indique une erreur de lecture de la synthèse vocale.

Vous pouvez également définir des marques personnalisées à l'aide de SSML et de la balise <mark>, par exemple <mark name="custom"/>.

Paramètres
markName string

Marquez le nom invoqué pendant la lecture par synthèse vocale.