InteractiveCanvas (Dialogflow)

L'objet interactiveCanvas correspond à l'interface de votre action de conversation. mis à disposition dans votre application Web.

Méthodes

prêt

ready(callbacks) returns undefined

Appelé par l'application Web Interactive Canvas une fois qu'elle a été chargée pour enregistrer des 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 demandes peuvent être acceptées par la plate-forme.

BLOCKED: Une requête est en cours de transfert, et la nouvelle requête sera supprimé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 à des informations ou à des demandes de votre action conversationnelle, tandis que les méthodes permettent d'envoyer des informations ou des requêtes à votre action conversationnelle.

onUpdate

onUpdate(data) returns undefined

Appelé lorsqu'un HtmlResponse est envoyé à partir de l'action de conversation. Après à la fin de l'appel de fonction, la synthèse vocale commence immédiatement.

Paramètres
data Object

Données mises à jour envoyées par le webhook.

onTtsMark

onTtsMark(markName) returns undefined

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

Marques spéciales qui sont toujours déclenchées:

  • 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 en utilisant SSML et le tag <mark>, par exemple <mark name="custom"/>.

Paramètres
markName string

Marquer le nom comme appelé lors de la lecture TTS