Twilio 请求 节点

使用 Twilio 请求 节点连接到 Twilio ,并发出请求以对对象 (例如,呼叫,入局电话号码,消息和消息服务) 执行操作。

Twilio 请求 节点在 WindowsAIX®Linux® 系统上可用。

本主题包含以下几部分:

用途

可以在消息流中使用 Twilio 请求 节点来连接到 Twilio 并对对象执行操作,例如:
调用
进行语音呼叫,检索呼叫详细信息,按标识检索呼叫详细信息或更新呼叫详细信息
入局电话号码
检索入局电话号码
消息服务
检索消息服务
消息
检索消息,取消预定消息,编辑消息,按标识检索消息,按电话号码发送消息或通过消息传递服务发送消息

Twilio 请求 节点操作是同步的非事务性操作,这意味着如果消息流在 Twilio 请求 节点之后失败并回滚,那么数据源上的操作仍将完成。

Twilio 请求 节点包含在消息流节点选用板的 Twilio 抽屉中,并通过以下图标在 IBM® App Connect Enterprise Toolkit 中表示:
此图显示 Twilio 请求节点图标。

终端和属性

Twilio 请求 节点的实例放入消息流后,可以对其进行配置。 有关更多信息,请参阅 配置消息流节点。 节点的属性在“属性”视图中显示。 所有必须输入值的必需属性(无缺省值的属性)都用星号标记。

下表描述了 Twilio Request 节点终端。

终端 描述
输入 接受节点处理的消息的输入终端。 Twilio 请求 节点由到达 In 终端的消息驱动。
输出 从其传播消息树的输出终端。 输出消息树包含从 Twilio 连接器返回的对象。
无数据 如果成功调用 Twilio 连接器,但操作未返回任何数据 (因为未找到任何记录) ,那么会将消息发送到 No Data 终端。 如果某个操作未返回任何数据,并且未连接“No Data”终端,那么将抛出异常。
故障 如果在 Twilio 请求 节点中发生错误,那么会将消息发送到 Failure 终端。

下表描述了此节点的属性。 标题为 M 的列指示属性是否为必需(如果在未定义缺省值时必须输入值,那么在面板上以星号标记);标题为 C 的列指示属性是否可配置(在将消息流添加到 BAR 文件以进行部署时可更改该值)。

下表描述了 Twilio 请求 节点的 描述 属性:
属性 M C 缺省 描述
节点名 节点类型 Twilio Request 节点的名称。
简短描述   节点的简要描述。
详细描述   描述消息流中节点用途的文本。
下表描述了 Twilio 请求 节点的 基本 属性。
属性 M C 缺省 描述
Action   此属性显示要由 Twilio 请求 节点执行的操作。 该操作是通过“连接器发现”向导定义的,并且以只读格式显示在 Action 属性中。

单击 启动连接器发现 以启动 Twilio 连接器的 "连接器发现" 向导,并定义所需的操作。

对象   该属性显示要对其执行指定操作的对象。 对象通过连接器发现向导定义,然后以只读格式显示在 Object 属性中。
模式基本名称   描述从 Twilio 连接器发送和接收的请求消息和响应消息的格式的模式文件的名称。 映射 节点可以使用模式文件来映射数据值。 您可以通过单击 打开请求模式打开响应模式 按钮来打开模式。

仅当所选操作和对象需要请求消息时,才会生成请求模式。 如果所选操作的类型为 RETRIEVEDELETE,那么连接器仅返回响应模式。

连接器属性   根据发现期间为 Twilio 连接器指定的对象和操作, 连接器属性 部分将显示已通过 "连接器发现" 向导为连接器设置的属性。 如果在发现期间未设置连接器属性,那么此部分不会显示在 "基本" 选项卡中。
下表描述了 Twilio 请求 节点的 连接 属性。
属性 M C 缺省 描述 mqsiapplybaroverride 命令属性
策略   此属性指定包含用于连接的安全身份详细信息的策略的名称。 该策略的类型为 Twilio,并且在策略项目中进行定义。 policyUrl
超时(秒) 60 此属性指定节点等待 Twilio 处理操作的时间 (以秒计)。 缺省值为 60 秒。 timeout
下表描述了 Twilio 请求 节点的 过滤器 属性。
属性 M C 缺省 描述
过滤器选项 过滤器选项 部分中的属性控制在执行 Twilio 请求 节点时要对哪些对象进行操作。 过滤器选项在发现期间在 "连接器发现" 向导中定义,但之后可以使用节点的 "过滤器" 选项卡中的 编辑 按钮来修改值。 如果在连接器发现期间未设置过滤条件,那么不会在选项卡的 过滤器选项 部分中显示任何属性。

属性值可以是文本值,也可以是 ESQL 或 XPATH 表达式,在执行时从传递到 Twilio 请求 节点的消息内容解析此表达式。

要检索的最大项数 15 要检索的最大项数 属性指定可以从 Twilio 连接器检索的最大项数。 此属性仅适用于 Retrieve 操作。

此属性是在发现期间在 "连接器发现" 向导中定义的,但您之后可以在 Twilio 请求 节点的 过滤器限制 部分中修改值。 如果在连接器发现期间未在 "连接器发现" 向导中设置过滤条件,那么此属性不会显示在节点的 "过滤器" 选项卡中。

如果超出限制     如果超出限制 属性指定在从连接器检索的项数超过指定的最大值时要执行的操作。 此属性仅适用于 Retrieve 操作。
可以选择以下某个操作:
  • 报告错误
  • 处理集合中的最大项数,如要检索的最大项数属性所设置。

此属性是在发现期间在 "连接器发现" 向导中定义的,但您之后可以在 Twilio 请求 节点的 过滤器限制 部分中修改值。 如果在连接器发现期间未在 "连接器发现" 向导中设置过滤条件,那么此属性不会显示在节点的 "过滤器" 选项卡中。

下表描述了 Twilio 请求 节点的 请求 属性。

属性 M C 缺省 描述
请求方式 此属性确定执行所选操作 (在连接器发现期间指定) 时发送到连接器的消息。 请求方式 是在连接器发现期间使用 "连接器发现" 向导设置的。 如果要编辑此属性,请通过在节点属性编辑器中单击 启动连接器发现 来启动 "连接器发现" 向导。
可以将此属性设置为以下任一值:
使用映射输入
选择此值后,连接器将从 映射输入 表中描述的位置获取其输入数据,并应用在连接器发现期间定义的映射逻辑。
使用数据位置
选择此值时,连接器将从 数据位置 字段中定义的单个位置获取其输入数据,而不应用任何映射逻辑。 由于没有映射逻辑应用于此输入数据,因此它必须与连接器的请求模式相匹配。
映射输入   映射输入 表用于定义在构建要发送到连接器的消息时可用的输入,以及用于定义需要过滤器的操作的过滤器值。
映射输入 表中的条目描述了消息组合件的特定部分以及定义这些部分的模式:
  • 输入名称 是映射输入表中行的唯一名称。
  • 输入位置 指定消息组合件中的位置。
  • 消息域 指定输入位置的解析器。
  • 模式位置 指定在输入位置描述消息的 JSON 模式。
  • 模式根 指定模式文件中描述消息结构的位置。 仅当 JSON 模式不在模式文档的根目录时,才需要执行此操作。

缺省情况下,该表包含描述通用输入消息和本地环境树的结构化部分的数据。

您可以向 映射输入 表添加一个条目,以指定消息组合件中由关联 JSON 模式描述的消息的位置。 如果先前的消息流节点定义了到达此节点的输入终端的 JSON 消息的结构,那么会找到该模式,并建议将其作为您可以使用的选项。

有关使用 JSONata 映射的更多信息,请参阅 配置发现连接器请求节点的映射JSONata 映射示例

数据位置 $Body 此属性指定入局消息树中的位置,从中检索数据以构成从请求节点发送的请求。 缺省值 $Body 表示入局消息体。 您可以输入定义要序列化和发送的消息树的位置的任何 XPath 或 ESQL 表达式。

仅当 请求方式 属性设置为 使用数据位置时,此属性才适用。

下表描述了 Twilio 请求 节点的 结果 属性。
属性 M C 缺省 描述
结果数据位置 $ResultRoot 此属性指定消息中复制到输出消息中 Output data location 字段的位置。

例如, $ResultRoot (缺省值) 将结果消息插入到 Output data location 属性指定的位置的输出树中。

有关更多信息,请参阅 从外部系统访存数据时将结果消息与输入消息组合

输出数据位置 $OutputRoot 此属性指定 Twilio 请求 节点将输出发送到的消息树位置。 复制的消息部分由 Result data location 属性指定。 缺省值指定将检索到的消息复制到外发消息的根。

请参阅 从外部系统访存数据时将结果消息与输入消息组合

复制本地环境 选中 此属性控制是复制入局本地环境还是传播入局本地环境。 缺省情况下,此复选框处于选中状态,指定复制本地环境以便保留传入的本地环境。 本地环境的新增项只能供位于此节点下游位置的节点查看。 如果取消选中此复选框,那么传入本地环境将用于外发消息。 在此节点完成修改后,此节点对本地环境进行的任何修改将可供位于此节点下游和上游位置的节点查看。
下表描述了 Twilio 请求 节点 响应消息解析 属性。
属性 M C 缺省 描述
消息域 JSON 用于解析响应消息的域。 缺省情况下,传播的消息位于 JSON 域中。 您无法指定其他域。
消息模型   这是在其中定义入局消息的消息模型模式文件的名称或位置。 您不能设置此属性。
消息   响应消息的名称。 节点自动检测消息类型;您无法设置此属性。
物理格式   响应消息物理格式的名称。 您不能设置此属性。

下表描述了 Twilio 请求 节点的 验证 属性。

属性 M C 缺省 描述 mqsiapplybaroverride 命令属性
验证 内容和值 此属性控制是否针对连接器发现期间发现的请求模式验证请求消息,并在缺省情况下启用。 可以将此属性设置为下列其中一个值:
关闭请求消息的验证。
内容和值
根据发现的请求模式验证请求消息。 内容检查包括内容验证和组合,值检查包括检查值是否符合数据类型,长度,范围和枚举。 缺省情况下设置此选项。
继承
使用随输入消息树提供的验证设置,优先于节点上提供的任何设置。 继承 因此解析为 内容和值。 如果选择了 继承 ,那么选项卡上的其他验证属性不可用。
validateRequestMaster
失败操作 异常列表 此属性控制发生验证失败时执行的操作。 可以将其设置为下列其中一个值:
异常
遇到第一次验证失败时抛出异常。 如果您已要求对消息流进行用户跟踪,那么失败还将记录在用户跟踪中,并且验证将停止。 如果您希望在遇到失败时尽快停止消息处理,请使用此设置。
异常列表
如果迂到验证失败,但仅当当前解析或写入操作已完成时,才会抛出异常。 如果您已要求对消息流进行用户跟踪,那么每个失败还将记录在用户跟踪中,并且验证将停止。 如果您希望在验证失败时停止消息处理,但希望查看遭遇的失败的完整列表,请使用此设置。 缺省情况下设置此选项。
用户跟踪
所有验证失败都将记录到用户跟踪中,即使您未要求用户跟踪消息流也是如此。 如果要继续处理消息而不考虑验证失败 (如果有可能) ,请使用此设置。
本地错误日志
所有验证失败都会记录到错误日志中 (例如, Windows 上的事件日志)。 如果要继续处理消息而不考虑验证失败 (如果有可能) ,请使用此设置。
 
响应验证选项 响应消息的验证不受此节点控制。 发现连接器构建响应消息并生成与模式匹配的有效消息。  
下表描述了 Twilio 请求 节点的 监视 属性。
属性 M C 缺省 描述
事件 为节点定义的事件显示在此选项卡上。 缺省情况下,不会在消息流中的任何节点上定义任何监视事件。 使用 添加编辑删除 来创建,更改或删除节点的监视事件; 请参阅 使用监视属性配置监视事件源 以获取详细信息。

通过选中或取消选中启用复选框,可以启用或禁用此处显示的事件。