Webフック

SMSサービス内で特定イベントが発生すると、Webフック設定に定義されているURLにPOSTリクエストを作成します。
作成されたPOSTリクエストについてのAPI文書です。

Webフック送信

[URL]

Http method URI
POST Webフック設定に定義した対象URL

[Header]

値 タイプ 説明
X-Toast-Webhook-Signature String Webフック設定時に入力した署名

[Request body]

{
  "hooksId": "202007271010101010sadasdavas",
  "webhookConfigId": "String",
  "productName": "SMS",
  "appKey": "akb3dukdmdjsdSvgk",
  "event": "UNSUBSCRIBE",
  "hooks": [
    {
      ...
    }
  ]
}
値 タイプ 説明
hooksId String Webフック設定に定義されているURLにPOSTリクエストを行うたびに作成される固有のID
webhookConfigId String Webフック設定ID
productName String Webフックイベントが発生したサービス名
appKey String Webフックイベントが発生したサービスアプリケーションキー
event String Webフックイベント名
* UNSUBSCRIBE：広告メッセージ受信番号登録
hooks List Webフックイベント発生時のデータ
* 詳細はイベントタイプ別hooks定義を参照してください。

cURL

curl -X POST \
    '{TargetUrl}' \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'X-Toast-Webhook-Signature: application/json;charset=UTF-8' \
    -d '{
        "hooksId": "202007271010101010sadasdavas",
        "webhookConfigId": "String",
        "productName": "Sms",
        "appKey": "akb3dukdmdjsdSvgk",
        "event": "UNSUBSCRIBE",
        "hooks": [
            {
                ...
            }
        ]
    }
'

イベントタイプ別hooks定義

Webフック設定で定義されたURLでPOSTリクエストを作成する時、イベントタイプ別のフック(hook)データです。

広告メッセージ受信番号登録

値 タイプ 説明
hooks[].hookId String サービスでイベント発生時に作成される固有ID
hooks[].recipientNo String 受信拒否された携帯電話番号
hooks[].unsubscribeNo String 受信拒否サービスに登録された080番号
hooks[].enterpriseName String 受信拒否サービスに登録された業者名
hooks[].createdDateTime String 受信拒否リクエスト日時
* yyyy-MM-dd'T'HH:mm:ss.SSSXXX		 
"hooks": [
  {
    "hookId": "202007271010101010sadasdavas",
    "recipientNo": "01012341234",
    "unsubscribeNo": "08012341234",
    "enterpriseName": "NHN Cloud",
    "createdDateTime": "2020-09-09T11:25:10.000+09:00"    
  }
]
目次
TOP