与出站拨号规则一起使用的操作指南
在定义将数据返回到出站拨号规则的数据操作的成功模式时,需要特别注意事项。
嵌套输出属性
在构建其输出联系人(成功模式)时,必须在必要时嵌套属性。 如果 /execute 的输出字段 是复杂对象,则模式中的相应属性应为嵌套架构,而不是假定输出为 “扁平化” 的字符串。 出站已经使用了 ?flatten=true
来拼合输出。
未嵌套的属性示例
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data.my data field": {
"type": "string",
}
}
}
上面的示例在数据操作的成功模式中指定了一个 “data.my data 字段”。 如果出站拨号数据操作规则使用生成的操作将不起作用。 出站将无法在 /actions/ {actionId} /执行 响应中找到该字段。 它将跳过呼叫,结果是 ININ-OUTBOUN-RULERE-ERRORLER-SKIPED
。
为了避免这个问题,请将 “我的数据字段” 设置为 “data” 字段的嵌套属性:
正确嵌套的例子
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"my data field": {
"type": "string"
}
}
}
}
}
通常,你的输出架构应该与你关心从 /execute 请求返回的属性具有相同的结构。
考虑一下这个简单的对象,以及输出架构如何返回它:
一个简单的对象
{ "foo": { "bat": "bar" } }
简单对象的输出架构
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"foo": {
"type": "string"
}
}
}
要使其与 Outbound 兼容,请修改简单对象的输出架构以嵌套属性:
正确嵌套简单对象
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"foo": {
"type": "object",
"properties": {
"bat": {
"type": "string"
}
}
}
}
}
此模式将返回:
{ "foo": { "bat": "bar" } }
必填字段
如果有您的数据操作需要的字段,请在成功模式中将这些字段标记为必填字段。
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"contact_id",
"phone_number"
],
"properties": {
...
},