Riferimento di integrazione SMS

Aggiungere i comandi di azione all'oggetto messaggio context per gestire il flusso di conversazioni con i clienti che interagiscono con il proprio assistente inoltrando messaggi SMS al telefono.

Conoscere i comandi supportati e le variabili di contesto riservate che vengono utilizzate dall'integrazione SMS.

Comandi supportati

Ogni azione consiste in una proprietà 'command, seguita da una proprietà opzionale 'parameter per definire i parametri dei comandi che li richiedono. I comandi descritti nella seguente tabella sono supportati dall'integrazione SMS.

Azioni che si possono avviare dall'azione
Comando azione	Descrizione	Parametri
`terminateSession`	Termina la sessione SMS corrente. Utilizzare questo comando per garantire che il successivo messaggio di testo inizi una nuova sessione di assistente che non conservi alcun valore di contesto dalla sessione corrente.	Nessuno
`smsActSendMedia`	Abilita la messaggistica MMS.	`mediaURL`: Specifica un array JSON di URL multimediali accessibili al pubblico che vengono inviati all'utente.
`smsActSetDisambiguationConfig`	Configura come gestire le scelte visualizzate in un elenco di disambiguità.	`prefixText`: Testo da includere prima di ogni opzione. Ad esempio, `Press %s for` dove `%s` rappresenta il numero corrispondente a una scelta di elenco; questo viene sostituito con il numero effettivo in fase di esecuzione.
`smsActSetOptionsConfig`	Configura come gestire i tipi di risposta delle opzioni.	`prefixText`: Testo da includere prima di ogni opzione. Ad esempio, `Press %s for` dove `%s` rappresenta il numero corrispondente a una scelta di elenco; questo viene sostituito con il numero effettivo in fase di esecuzione.

Variabili di contesto riservate

La seguente tabella descrive le variabili di contesto che hanno un significato particolare nel contesto dell'integrazione SMS. Non devono essere utilizzati per scopi diversi dall'uso documentato.

La Tabella 2 descrive le variabili di contesto impostate dalla tua azione. La Tabella 3 descrive le variabili di contesto che è possibile impostare dall'integrazione SMS.

Tabella 2. Variabili di contesto impostate dalla tua azione

Variabili di contesto SMS impostate dall'azione
Nome variabile di contesto	Valore previsto	Descrizione
`smsConversationResponseTimeout`	Tempo in ms	La quantità di tempo in millisecondi che l'integrazione attende di ricevere una risposta dall'azione. Se il limite di tempo viene superato, l'integrazione tenta di contattare nuovamente l'azione. Se il servizio ancora non può essere raggiunto, la risposta SMS fallisce.

Tabella 3. Variabili di contesto impostate dall'integrazione

Variabili di contesto SMS impostate dall'integrazione
Nome variabile di contesto	Descrizione
`smsTenantPhoneNumber`	Il numero di telefono tenant di integrazione che l'utente è di messaggistica.
`smsUserPhoneNumber`	Il numero di telefono dell'utente che sta scambiando messaggi con l'integrazione.
`smsUserData`	I dati in formato JSON da passare verbatim al motore di orchestrazione del servizio o al servizio watsonx Assistant. Questa variabile viene inviata solo se la sessione viene avviata dall'inquilino di integrazione e i dati vengono inviati tramite REST API.
`smsSessionTimeoutCount`	Il valore di timeout della sessione. Questa variabile viene inviata solo se il valore di timeout viene definito tramite l'API REST.
`smsError`	Quando l'integrazione non riesce a inviare un SMS, questa variabile contiene dettagli sull'errore che si è verificato.
`smsSessionID`	L'identificatore globalmente univoco (GUID) per la relativa sessione di SMS Gateway.
`smsMedia`	`arraylist` di `mediaURL` e corrispondente `mediaContentType`. Questa variabile di contesto viene sdoganata alla fine di ogni turno di conversazione.