IBM Cloud Docs
SMS 集成参考

SMS 集成参考

向消息 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 介绍了短信集成可以设置的上下文变量。

表 2. 由操作设置的上下文变量

由操作设置的短信上下文变量
上下文变量名 期望值 描述
smsConversationResponseTimeout 时间(毫秒) 集成等待接收动作响应的时间(毫秒)。 如果超过时限,集成会尝试再次联系该操作。 如果仍无法访问服务,那么 SMS 响应将失败。

表 3。 由整合设置的上下文变量

集成设置的短信上下文变量
上下文变量名 描述
smsTenantPhoneNumber 用户正在进行消息传递的集成租户电话号码。
smsUserPhoneNumber 与集成交换消息的用户的电话号码。
smsUserData 要逐字传递到服务编排引擎或 watsonx Assistant 服务的 JSON 格式的数据。 仅当从集成租户启动会话并且通过 REST API 发送数据时,才会发送此变量。
smsSessionTimeoutCount 会话超时值。 仅当通过 REST API 定义超时值时,才会发送此变量。
smsError 集成未能发送 SMS 消息时,此变量包含有关所发生错误的详细信息。
smsSessionID 相关 SMS 网关会话的全局唯一标识 (GUID)。
smsMedia arraylist 和对应 mediaURLmediaContentType。 在每个交谈轮次结束时,都将清除此上下文变量。