発信ダイヤル規則で使用される操作のガイドライン

データをアウトバウンドダイヤルルールに返すデータアクションの成功スキーマを定義するときには、特別な考慮事項が適用されます。

ネスト出力プロパティ

When constructing its output contact (success schema), it is imperative to nest properties when necessary. If an output field from /execute is a complex object, the corresponding property in the schema should be a nested schema, and not a string that assumes “flattened” output. Outbound already uses ?flatten=true to flatten output.

ネストしていないプロパティの例

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data.my data field": {
      "type": "string",
    }
  }
}

The above example specifies a “data.my data field” in the success schema of a data action. The resulting action won’t work if it used by an outbound dialing data action rule. Outbound will be unable to find the field in the /actions/{actionId}/execute response. It will skip calls with a result of ININ-OUTBOUND-RULE-ERROR-SKIPPED.

この問題を回避するには、 「my data field」を 「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": {
   ...
    },