SMS-Integrationsreferenz

Fügen Sie Aktionsbefehle zum Nacrichtenobjekt context hinzu, um den Ablauf des Dialogs mit Kunden zu verwalten, die per Telefon durch SMS-Nachrichten mit dem Assistenten interagieren.

Erfahren Sie mehr über die unterstützten Befehle und reservierten Kontextvariablen, die von der SMS-Integration verwendet werden.

Unterstützte Befehle

Jede Aktion besteht aus einer Eigenschaft command, gefolgt von einer optionalen Eigenschaft parameter zum Definieren von Parametern für Befehle, die Parameter erfordern. Die Befehle, die in der folgenden Tabelle beschrieben sind, werden von der SMS-Integration unterstützt.

Aktionen, die Sie von der Aktion aus initiieren können
Aktionsbefehl	Beschreibung	Parameter
`terminateSession`	Beendet die aktuelle SMS-Sitzung. Verwenden Sie diesen Befehl, um sicherzustellen, dass die nachfolgende Textnachricht eine neue Sitzung auf Assistentenebene startet, die keine Kontextwerte aus der aktuellen Sitzung übernimmt.	Keine
`smsActSendMedia`	Aktiviert das MMS-Messaging (MMS = Multimedia Messaging).	`mediaURL`: Gibt ein JSON-Array mit öffentlich zugänglichen Medien-URLs an, die an den Benutzer gesendet werden.
`smsActSetDisambiguationConfig`	Konfiguriert die Vorgehensweise für die Verarbeitung der Auswahlmöglichkeiten, die in einer Begriffsklärungsliste angezeigt werden.	`prefixText`: Gibt Text an, der vor jeder Option eingefügt werden soll. Beispiel: `Press %s for`. Dabei steht `%s` für die Nummer eines Eintrags in einer Auswahlliste. Diese Nummer wird während der Laufzeit durch die tatsächliche Nummer ersetzt.
`smsActSetOptionsConfig`	Konfiguriert die Vorgehensweise für die Verarbeitung des Antworttyps für Optionen.	`prefixText`: Gibt Text an, der vor jeder Option eingefügt werden soll. Beispiel: `Press %s for`. Dabei steht `%s` für die Nummer eines Eintrags in einer Auswahlliste. Diese Nummer wird während der Laufzeit durch die tatsächliche Nummer ersetzt.

Reservierte Kontextvariablen

Die folgende Tabelle beschreibt die Kontextvariablen, die im Zusammenhang mit der SMS-Integration eine besondere Bedeutung haben. Diese Variablen sollten ausschließlich für den dokumentierten Zweck verwendet werden.

In Tabelle 2 werden die Kontextvariablen beschrieben, die durch Ihre Aktion festgelegt werden. Tabelle 3 beschreibt die Kontextvariablen, die Sie mit der SMS-Integration festlegen können.

Tabelle 2. Kontextvariablen, die durch Ihre Aktion festgelegt werden

SMS-Kontextvariablen, die durch die Aktion gesetzt werden
Name der Kontextvariablen	Erwarteter Wert	Beschreibung
`smsConversationResponseTimeout`	Zeit in Millisekunden	Die Zeit in Millisekunden, die die Integration auf den Empfang einer Antwort von der Aktion wartet. Wenn das Zeitlimit überschritten wird, versucht die Integration, die Aktion erneut zu kontaktieren. Wenn der Service weiterhin nicht erreichbar ist, schlägt die SMS-Antwort fehl.

Tabelle 3. Kontextvariablen, die von der Integration festgelegt werden

SMS-Kontextvariablen, die durch die Integration gesetzt werden
Name der Kontextvariablen	Beschreibung
`smsTenantPhoneNumber`	Die Telefonnummer des Integrations-Tenants, an den der Benutzer Nachrichten sendet.
`smsUserPhoneNumber`	Die Telefonnummer des Benutzers, der Nachrichten mit der Integration austauscht.
`smsUserData`	Daten im JSON-Format, die wortwörtlich an die Service-Orchestrierungs-Engine oder den watsonx Assistant übergeben werden. Diese Variable wird nur gesendet, wenn die Sitzung vom Integrations-Tenant gestartet wird und die Daten über die REST-API gesendet werden.
`smsSessionTimeoutCount`	Der Zeitlimitwert der Sitzung. Diese Variable wird nur gesendet, wenn der Zeitlimitwert über die REST-API definiert wird.
`smsError`	Wenn die Integration keine SMS-Nachricht sendet, enthält diese Variable Details zum aufgetretenen Fehler.
`smsSessionID`	Die global eindeutige ID (Globally Unique ID, GUID) für die SMS-Gateway-Sitzung.
`smsMedia`	Die Liste `arraylist` für `mediaURL` und der entsprechende `mediaContentType`. Diese Kontextvariable wird am Ende jeder Dialogrunde gelöscht.