このドキュメントでは、カスタムチャネルの設定例を参考として提供します。
設定の説明
HTTP チャネルタイプを例に、具体的な設定の説明は以下の通りです:
パラメータ |
説明 |
|---|---|
| Webhook アドレス | プッシュを受信する宛先アドレスで、http:// または https:// で始まる必要があります。 |
| プロキシ(オプション) | アラート情報を送信するプロキシを入力します。形式は http://ip:port です。ここで、ip はプロキシサーバーのIP、port はプッシュで使用するポートです。プロキシサーバーのIPが xxx.xxx.xxx.xxx で、80番ポートを使用してメッセージを送信する計画の場合、http://xxx.xxx.xxx.xxx:80。 と設定できます。 |
| リクエストメソッド | 実際の状況に応じて選択します。デフォルトはPOSTです。 |
| Header テンプレート | 実際のニーズに応じてHTTPプロトコルのHeaderテンプレートを記入します。異なるパラメータは;で区切ります。例:Content-Type:application/json;charset:utf-8 |
| Body テンプレート | プッシュ内容のテンプレートを記入します。空の場合はHTTP bodyを使用しません。テンプレート内で変数を参照できます。変数リストについては、プッシュチャネルの作成をご参照ください。 |
| Response 検証情報 | チャネルごとにResponseが異なるため、メッセージの送信が成功したかどうかを正確に判断するためには、送信成功時のResponse検証情報を設定する必要があります。
|
設定例
上図を例に、イベントに対応するタスクIDが10001の場合、ODCは設定されたWebhookに以下のようなリクエストを送信します。ここで、data フィールドの属性は実際に生成されたプッシュメッセージです:
curl -XPOST -H "Context-Type:application/json" -H "charset:utf-8" -H "appkey:xxxxxx" http://xxx.xxx.xxx.xxx:80 -d '{"jsonrpc":"2.0","params":{"output":"extend"},"auth":"*******","data":"...","task_id":"10001"}'
受信した応答に "message":"success" のキー値ペアが含まれている場合、ODCはこのプッシュが成功したとみなします。