Webhook郵送通知

Webhook URLはWebhook管理画面から設定が可能です。

郵送処理する際、そのステータスをWebhookとして通知します。

アウトライン

リクエスト

共通リクエストパラメータ

下記の項目を持つJSONオブジェクトです。

名前 型 概要
BillingRoboSignaturekey string ロボで自動生成する
Webhookページで更新可能
org string BillingRobo_RobotPayment
event_name string ウェブフックイベントの名称
mail_issue
regist_time string イベント発生時刻
notification_time string イベント通知時刻
billing_source_id int 請求元ID
event_detail array イベント詳細

event_detail (request)

共通リクエストパラメータのevent_detailの中身

名前 型 概要
type string 郵送タイプ
“order”:郵送発注 “order_fail”:郵送発注失敗 “sent”:郵送発送済み “fail”:郵送失敗 “complete”:郵送完了 “cancel”:郵送取消 “injunction”:郵送差止
mail array 詳細内容
mail (request)

event_detailパラメーターのmailの中身

名前 型 概要
number int 郵送コード
bill_number string 請求書番号
status int 郵送ステータス
0:注文済
1:発送済
2:完了
3:注文失敗
4:注文取り消し
5:注文差止
error_type int 郵送エラータイプ
0:その他エラー
1:枚数超過
2:ロゴファイルエラー
3:郵送不可の添付ファイルが含まれているため
4:枚数制限(349枚)オーバー
5:PDF生成エラー
order_date string 郵送注文日
mail_date string 郵送発送日
nondelivery_flg int 郵送不達フラグ
nondelivery_date string 郵送不達処理日
update_date string 更新日時

サンプル

{
  "BillingRoboSignaturekey": "$2y$10$ee1ZuZ6XSxEkzq9egVTLL.OlU7wb/WCgY0ORQyCZpfiDnhoPH2rXu",
  "org": "BillingRobo_RobotPayment",
  "id": "26",
  "event_name": "credit_status_issue",
  "regist_time": "2019-12-06 08:31:33",
  "notification_time": "2019-12-06 06:39:50",
  "billing_source_id": "1",
  "event_detail": {
    "type": "complete",
    "mail": {
      "number": "11",
      "bill_number": "201811-SELF-18",
      "status": "2",
      "order_date": "2018-11-16",
      "mail_date": "2018-11-16",
      "update_date": "2018-12-12 16:58:40"
    }
  }
}

TOPへ戻る