SMSインテグレーション・リファレンス
この機能は現在、IBM watsonx OrchestrateのAIアシスタント・ビルダーでは利用できない。
アクション・コマンドをメッセージの context オブジェクトに追加し、電話で SMS メッセージを送信してアシスタントと対話する顧客との会話フローを管理することができます。
SMS統合で使用される、サポートされているコマンドと予約済みのコンテキスト変数について説明します。
サポートされるコマンド
各アクションは、command プロパティーと、それに続くオプションの parameter プロパティー (パラメーターが必要なコマンドにパラメーターを定義します) から構成されます。 以下の表に記載されているコマンドは、SMS統合でサポートされています。
| アクション・コマンド | 説明 | パラメーター |
|---|---|---|
terminateSession |
現行の SMS セッションを終了します。 このコマンドを使用すると、次のテキスト・メッセージは、現行セッションのコンテキスト値を一切保持していない、アシスタント・レベルで新規のセッションを開始できるようになります。 | なし |
smsActSendMedia |
MMS メッセージを有効にします。 | mediaURL: ユーザーに送信されるパブリックにアクセス可能なメディア URL の JSON 配列を指定。 |
smsActSetDisambiguationConfig |
明確化リストに表示される選択肢の処理方法を構成します。 | prefixText: 各オプションの前に含めるテキスト。 例えば、Press %s for などです。%s は、リストの選択肢に対応する番号を表し、実行時に実際の番号に置き換えられます。 |
smsActSetOptionsConfig |
オプション応答タイプの処理方法を構成します。 | prefixText: 各オプションの前に含めるテキスト。 例えば、Press %s for などです。%s は、リストの選択肢に対応する番号を表し、実行時に実際の番号に置き換えられます。 |
予約済みコンテキスト変数
次の表は、SMS統合のコンテキストで特別な意味を持つコンテキスト変数について説明したものです。 記載している用途以外の目的に、これらの変数を使用しないでください。
表 2 では、アクションによって設定されるコンテキスト変数について説明しています。 表 3 に、SMS統合で設定できるコンテキスト変数を示します。
表 2. アクションによって設定されるコンテキスト変数
| コンテキスト変数名 | 期待値 | 説明 |
|---|---|---|
smsConversationResponseTimeout |
ミリ秒単位の時間 | 統合がアクションからの応答の受信を待機する時間 (ミリ秒)。 時間制限を超えると、統合はアクションに再び接続しようとします。 まだサービスに到達できない場合は、SMS 応答は失敗します。 |
表 3. 統合によって設定されるコンテキスト変数
| コンテキスト変数名 | 説明 |
|---|---|
smsTenantPhoneNumber |
ユーザーがメッセージングしている統合テナント電話番号。 |
smsUserPhoneNumber |
統合との間でメッセージを交換しているユーザーの電話番号。 |
smsUserData |
サービス・オーケストレーション・エンジンやAIアシスタント・ビルダー・サービスにそのまま渡すJSON形式のデータ。 この変数が送信されるのは、セッションが統合テナントから開始され、データが REST API を使用して送信される場合に限られます。 |
smsSessionTimeoutCount |
セッション・タイムアウト値。 この変数が送信されるのは、タイムアウト値が REST API を使用して定義されている場合に限られます。 |
smsError |
統合が SMS メッセージの送信に失敗した場合、この変数に、発生したエラーに関する詳細が含まれます。 |
smsSessionID |
関連する SMS Gateway セッションのグローバル固有 ID (GUID)。 |
smsMedia |
mediaURL および対応する mediaContentType の arraylist。 このコンテキスト変数は、各会話ターンの終了時にクリアされます。 |