メッセージ

Notification > Notification Hub > API v1.0使用ガイド > メッセージ

自由形式のメッセージ送信リクエスト

リクエスト本文にメッセージ内容を入力し、メッセージを送信リクエストします。

各メッセージチャンネルにメッセージを送信するためには、各メッセージチャンネルの送信情報が登録されている必要があります。送信情報の登録は、Notification Hubコンソール > 送信情報タブで行うことができます。メッセージチャンネルの発信情報の詳細な説明は、Notification > Notification Hub > 利用ポリシー及び事前設定案内で確認できます。

リクエスト

POST /message/v1.0/{messageChannel}/free-form-messages/{messagePurpose}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

共通リクエスト本文

メッセージチャンネルによるリクエスト本文の詳細は、下記のメッセージチャンネル別詳細リクエスト本文をご確認ください。

{
  "statsKeyId": "統計_ID",
  "scheduledDateTime": "2024-10-29T00:06:29+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "...": "メッセージ_チャンネルに_よって_異なる_形式"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ]
    }
  ],
  "content": {
    "...": "メッセージ_チャンネルに_よって_異なる_形式"
  }
}

• メッセージチャンネルによってsender, contentフィールドは異なる形式を持ちます。
• メッセージチャンネルによって recipients[].contacts.contactType, recipients[].contacts.contactフィールドに入力できる値が異なります。
• 予約送信の場合、scheduledDateTimeを設定します。送信開始前の予約送信は、リクエストのキャンセルが可能です。リクエストキャンセルAPIを呼び出すか、Notification Hubコンソール > 送信照会でキャンセルできます。
• 承認後送信の場合、confirmBeforeSendをtrueに設定します。承認後送信のメッセージはNotification Hubコンソール > 送信照会で承認すると送信が行われます。
• 予約送信と承認後送信は同時に設定できません。

メッセージチャンネル別senderフィールド

• お知らせトーク(ALIMTALK)は発信キー(senderKey)と発信プロフィールタイプ(senderProfileType)を必ず入力する必要があります。
• カカともへのメッセージ(FRIENDTALK)はNORMAL(一般)発信プロフィールタイプのみ使用できます。 GROUP(グループ)発信プロフィールタイプの発信キーを使用すると送信に失敗します。
• 発信者プロフィールタイプはGROUP(グループ)と NORMAL(一般)があります。GROUPはグループ発信者プロフィール、 NORMALは一般発信者プロフィールです。

レスポンス本文

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "messageId": "メッセージ_ID"
}

リクエスト例

### 専門メッセージ送信
POST {{endpoint}}/message/v1.0/PUSH/free-form-messages/{messagePurpose}
Content-Type: application/json
X-NC-APP-KEY: {{appKey}}
X-NHN-Authorization: {{authorizationToken}}

{
  "confirmBeforeSend": false,
  "sender": {
    "senderPhoneNumber": "01012341234"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ]
    }
  ],
  "content": {
    "messageType": "SMS",
    "body": "こんにちは。 NHN Cloudの新規商品Notification Hubがリリースされました。"
  }
}

curl -X POST "${ENDPOINT}/message/v1.0/PUSH/free-form-messages/${MESSAGE_PURPOSE}" \
     -H "Content-Type: application/json" \
     -H "X-NC-APP-KEY: ${APP_KEY}" \
     -H "X-NHN-Authorization: ${ACCESS_TOKEN}" \
     -d '{
        "confirmBeforeSend": false,
        "sender": {
            "senderPhoneNumber": "01012341234"
        },
        "recipients": [
            {
            "contacts": [
                {
                "contactType": "PHONE_NUMBER",
                "contact": "01012345678"
                }
            ]
            }
        ],
        "content": {
            "messageType": "SMS",
            "body": "こんにちは。 NHN Cloudの新規商品Notification Hubがリリースされました。"
        }
    }'

メッセージチャンネル別詳細リクエスト本文例

SMS

{
  "statsKeyId": "統計_キー_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "senderPhoneNumber": "01012341234"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ]
    }
  ],
  "content": {
    "messageType": "MMS",
    "title": "[NHN Cloud Notification Hub]告知事項",
    "body": "こんにちは。 NHN Cloud Notification Hubです。",
    "attachmentIds": [
      "添付_ファイル_ID"
    ]
  }
}

RCS

{
  "statsKeyId": "統計_キー_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "ブランド_ID",
    "chatbotId": "チャットルーム_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ]
    }
  ],
  "content": {
    "messageType": "SMS",
    "unsubscribePhoneNumber": "08012341234",
    "title": "[NHN Cloud Notification Hub]告知事項",
    "body": "こんにちは。 NHN Cloud Notification Hubです。",
    "mmsType": "HORIZONTAL",
    "messagebaseId": "44o4SUjpqnjDuUcH+uHvPg==",
    "cards": [
        {
          "title":"testTitle",
          "description":"testBody",
          "media":"fileId",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : "{ \"action\": { \"urlAction\":{\"openUrl\":{\"url\":\"http://www.test.com\"} },\"displayText\":\"Webサイトへ移動\"}}"
            },
            {
              "buttonType" : "URL",
              "buttonJson" : "{ \"action\": { \"urlAction\":{\"openUrl\":{\"url\":\"http://www.test.com\"} },\"displayText\":\"Webサイトへ移動\"}}"
            }
          ]
        }
    ],
    "buttons": [
        {
            "buttonType": "URL",
            "buttonJson": "{ \"action\": { \"urlAction\":{\"openUrl\":{\"url\":\"http://www.test.com\"} },\"displayText\":\"Webサイトへ移動\"}}"
        }
    ]
  }
}

カカともへのメッセージ - テキスト型

• お知らせトークは、テンプレート登録後、承認された状態で送信可能なため、テンプレート、フローメッセージの送信のみ可能です。
• お知らせトークのsender, contentフィールドはテンプレートメッセージ送信のリクエスト本文をご確認ください。
• カカともへのメッセージ(FRIENDTALK)はNORMAL(一般)発信プロフィールタイプのみ使用できます。GROUP(グループ)発信プロフィールタイプの発信キーを使用すると送信に失敗します。

{
    "statsKeyId": "統計_キー_ID",
    "scheduledDateTime": "2024-10-24T06:29:00+09:00",
    "confirmBeforeSend": false,
    "sender": {
        "senderKey": "発信プロフィール_発信キー"
    },
    "recipients": [
        {
          "contacts": [
            {
              "contactType": "PHONE_NUMBER",
              "contact": "01012345678"
            }
          ]
        }
    ],
    "content": {
      "messageType": "TEXT",
      "content": "送信_内容",
      "buttons": [
        {
          "type": "WL",
          "name": "ボタン_名前",
          "linkMo": "モバイル_リンク",
          "linkPc": "PC_リンク",
          "schemeIos": "iOS_アプリ_リンク",
          "schemeAndroid": "Android_アプリ_リンク",
          "bizFormKey": "ビズフォーム_キー"
        }
      ],
      "coupon": {
        "title": "クーポン_タイトル",
        "description": "クーポン_詳細_説明",
        "linkMo": "モバイル_リンク",
        "linkPc": "PC_リンク",
        "schemeIos": "iOS_アプリ_リンク",
        "schemeAndroid": "Android_アプリ_リンク"
      }
    }
}

カカともへのメッセージ - 画像型 / ワイド画像型

• カカともへのメッセージ(FRIENDTALK)はNORMAL(一般)発信プロフィールタイプのみ使用できます。 GROUP(グループ)発信プロフィールタイプの発信キーを使用すると送信に失敗します。

{
    "statsKeyId": "統計_キー_ID",
    "scheduledDateTime": "2024-10-24T06:29:00+09:00",
    "confirmBeforeSend": false,
    "sender": {
        "senderKey": "発信プロフィール_発信キー"
    },
    "recipients": [
        {
          "contacts": [
            {
              "contactType": "PHONE_NUMBER",
              "contact": "01012345678"
            }
          ]
        }
    ],
    "content": {
      "messageType": "WIDE_IMAGE",
      "content": "送信_内容",
      "attachmentId": "添付_ファイル_ID",
      "imageLink": "画像_リンク_URL",
      "buttons": [
        {
          "type": "WL",
          "name": "ボタン_名前",
          "linkMo": "モバイル_リンク",
          "linkPc": "PC_リンク",
          "schemeIos": "iOS_アプリ_リンク",
          "schemeAndroid": "Android_アプリ_リンク",
          "bizFormKey": "ビズフォーム_キー"
        }
      ],
      "coupon": {
        "title": "クーポン_タイトル",
        "description": "クーポン_詳細_説明",
        "linkMo": "モバイル_リンク",
        "linkPc": "PC_リンク",
        "schemeIos": "iOS_アプリ_リンク",
        "schemeAndroid": "Android_アプリ_リンク"
      }
    }
}

カカともへのメッセージ - ワイドアイテムリスト型

• カカともへのメッセージ(FRIENDTALK)はNORMAL(一般)発信プロフィールタイプのみ使用できます。 GROUP(グループ)発信プロフィールタイプの発信キーを使用すると送信に失敗します。

{
    "statsKeyId": "統計_キー_ID",
    "scheduledDateTime": "2024-10-24T06:29:00+09:00",
    "confirmBeforeSend": false,
    "sender": {
        "senderKey": "発信プロフィール_発信キー"
    },
    "recipients": [
        {
          "contacts": [
            {
              "contactType": "PHONE_NUMBER",
              "contact": "01012345678"
            }
          ]
        }
    ],
    "content": {
      "messageType": "WIDE_ITEMLIST",
      "buttons": [
        {
          "type": "WL",
          "name": "ボタン_名前",
          "linkMo": "モバイル_リンク",
          "linkPc": "PC_リンク",
          "schemeIos": "iOS_アプリ_リンク",
          "schemeAndroid": "Android_アプリ_リンク",
          "bizFormKey": "ビズフォーム_キー"
        }
      ],
      "header": "ヘッダ",
      "item": {
          "list": [{
            "title": "アイテム_タイトル",
            "attachmentId": "添付_ファイル_ID",
            "linkMo": "モバイル_リンク",
            "linkPc": "PC_リンク",
            "schemeIos": "iOS_アプリ_リンク",
            "schemeAndroid": "Android_アプリ_リンク"
          },
          {
            "title": "アイテム_タイトル",
            "attachmentId": "添付_ファイル_ID",
            "linkMo": "モバイル_リンク",
            "linkPc": "PC_リンク",
            "schemeIos": "iOS_アプリ_リンク",
            "schemeAndroid": "Android_アプリ_リンク"
          },
          {
          "title": "アイテム_タイトル",
          "attachmentId": "添付_ファイル_ID",
          "linkMo": "モバイル_リンク",
          "linkPc": "PC_リンク",
          "schemeIos": "iOS_アプリ_リンク",
          "schemeAndroid": "Android_アプリ_リンク"
          }
        ]
      },
      "coupon": {
        "title": "クーポン_タイトル",
        "description": "クーポン_詳細_説明",
        "linkMo": "モバイル_リンク",
        "linkPc": "PC_リンク",
        "schemeIos": "iOS_アプリ_リンク",
        "schemeAndroid": "Android_アプリ_リンク"
      }
    }
}

カカともへのメッセージ - カルーセルフィード型

• カカともへのメッセージ(FRIENDTALK)はNORMAL(一般)発信プロフィールタイプのみ使用できます。 GROUP(グループ)発信プロフィールタイプの発信キーを使用すると送信に失敗します。

{
    "statsKeyId": "統計_キー_ID",
    "scheduledDateTime": "2024-10-24T06:29:00+09:00",
    "confirmBeforeSend": false,
    "sender": {
        "senderKey": "発信プロフィール_発信キー"
    },
    "recipients": [
        {
          "contacts": [
            {
              "contactType": "PHONE_NUMBER",
              "contact": "01012345678"
            }
          ]
        }
    ],
    "content": {
      "messageType": "CAROUSEL_FEED",
      "carousel": {
        "list": [
          {
            "header": "カルーセル_アイテム_タイトル",
            "message": "カルーセル_アイテム_メッセージ",
            "attachment": {
              "buttons": [
                {
                  "type": "WL",
                  "name": "ボタン_名前",
                  "linkMo": "モバイル_リンク",
                  "linkPc": "PC_リンク",
                  "schemeIos": "iOS_アプリ_リンク",
                  "schemeAndroid": "Android_アプリ_リンク"
                }
              ],
              "image": {
                "attachmentId": "添付_ファイル_ID",
                "imageLink": "画像_リンク_URL"
              },
              "coupon": {
                "title": "クーポン_タイトル",
                "description": "クーポン_詳細_説明",
                "linkMo": "モバイル_リンク",
                "linkPc": "PC_リンク",
                "schemeIos": "iOS_アプリ_リンク",
                "schemeAndroid": "Android_アプリ_リンク"
              }
            }
          },
          {
            "header": "カルーセル_アイテム_タイトル",
            "message": "カルーセル_アイテム_メッセージ",
            "attachment": {
              "buttons": [
                {
                  "type": "WL",
                  "name": "ボタン_名前",
                  "linkMo": "モバイル_リンク",
                  "linkPc": "PC_リンク",
                  "schemeIos": "iOS_アプリ_リンク",
                  "schemeAndroid": "Android_アプリ_リンク"
                }
              ],
              "image": {
                "attachmentId": "添付_ファイル_ID",
                "imageLink": "画像_リンク_URL"
              },
              "coupon": {
                "title": "クーポン_タイトル",
                "description": "クーポン_詳細_説明",
                "linkMo": "モバイル_リンク",
                "linkPc": "PC_リンク",
                "schemeIos": "iOS_アプリ_リンク",
                "schemeAndroid": "Android_アプリ_リンク"
              }
            }
          }
        ],
        "tail": {
          "linkMo": "モバイル_リンク",
          "linkPc": "PC_リンク",
          "schemeAndroid": "Android_アプリ_リンク",
          "schemeIos": "iOS_アプリ_リンク"
        }
      }
    }
}

Email

{
  "sender": {
    "senderMailAddress": "sender@example.com"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "EMAIL_ADDRESS",
          "contact": "recipient@example.com"
        }
      ]
    }
  ],
  "content": {
    "title": "[NHN Cloud Notification Hub]告知事項",
    "body": "こんにちは。 NHN Cloud Notification Hubです。",
    "attachmentIds": [
      "添付_ファイル_ID"
    ]
  }
}

• 発信者メールアドレスのドメインは所有認証が完了している必要があります。
• 添付ファイルは30MB以下で最大10個までアップロードできます。
• 添付ファイルの合計が最大30MBを超えることはできません。
• 最大30MBまで添付可能ですが、受信するメールシステム(gmail.com, naver.comなど)の添付ファイル制限ポリシーにより制限超過で拒否されたり、スパム判定率が高くなる可能性があるため、10MB以内で添付することを推奨します。
• recipients[].contacts[].contactType フィールドには EMAIL_ADDRESSのみ使用可能です。
• recipients[].contacts[].contact フィールドには受信者メールアドレスを入力します。

Push

{
  "statsId": "統計_ID",
  "scheduledDateTime": "2024-10-29T06:29:00+09:00",
  "confirmBeforeSend": false,
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "TOKEN_FCM",
          "contact": "トークン"
        }
      ]
    }
  ],
  "content": {
    "unsubscribePhoneNumber": "1234-1234",
    "unsubscribeGuide": "設定 > メニュー",
    "style": {
      "useHtmlStyle": true
    },
    "title" : "<b>NHN Cloud </b> Notification",
    "body" : "<b>リリースイベント</b> <i>告知事項確認</i>",
    "richMessage" : {
      "buttons" : [{
        "name" : "ボタン名",
        "submitName": "送信ボタン名",
        "buttonType" : "REPLY",
        "link" : "myapp://product_detail?product_id=1234",
        "hint" : "ボタンに関するヒント"
      }
      ],
      "media" : {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "androidMedia": {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "iosMedia": {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "largeIcon" : {
        "source" : "URL"
      },
      "group" : {
        "key" : "グループのキー",
        "description" : "グループについての説明"
      }
    },
    "customKey" : "customValue"
  }
}

• プッシュはsenderフィールドが必要ありません。
• プッシュはユーザーが定義したキーと値を追加してcontentフィールドを作成できます。
• recipients[].contacts[].contactType フィールドは TOKEN_FCM, TOKEN_APNS, TOKEN_ADM, TOKEN_APNS_SANDBOX, TOKEN_APNS_VOIP, TOKEN_APNS_VOIP_SANDBOXのいずれかでなければなりません。
• recipients[].contacts[].contactフィールドにはプッシュトークンを入力します。

テンプレートメッセージ送信リクエスト

リクエスト

POST /message/v1.0/{messageChannel}/template-messages/{messagePurpose}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

リクエスト本文

{
  "statsKeyId": "統計_ID",
  "scheduledDateTime": "2024-10-29T00:06:29+09:00",
  "confirmBeforeSend": false,
  "templateId": "テンプレート_ID",
  "templateParameters": {
    "key1": "value1",
    "key2": "value2",
    "key3": {
        "key4": "value4",
        "key5": "value5"
    }
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ],
      "templateParameters": {
        "key3": {
          "key4": "value4",
          "key5": "value5"
        },
        "key6": "value6"
      }
    }
  ]
}

• テンプレートパラメータはテンプレートに定義されたパラメータと一致する必要があります。
• テンプレートパラメータは共通テンプレートパラメータ、受信者テンプレートパラメータに区分されます。
• 共通テンプレートパラメータは、すべての受信者に同じように適用されるパラメータです。受信者テンプレートパラメータは、受信者ごとに異なるパラメータを適用する際に使用します。
• 受信者テンプレートパラメータがない場合は、共通テンプレートパラメータのみ適用されます。共通テンプレートパラメータと受信者テンプレートパラメータが重複する場合、受信者テンプレートパラメータが優先的に適用されます。
• テンプレートパラメータの値のタイプは、文字列または配列、オブジェクトのいずれかを指定できます。配列やオブジェクトタイプはFREE_MARKERテンプレートで使用できます。

レスポンス本文

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "messageId": "メッセージ_ID"
}

リクエスト例

### テンプレートメッセージ送信
POST {{endpoint}}/message/v1.0/SMS/template-messages/NORMAL
Content-Type: application/json
X-NC-APP-KEY: {{appKey}}
X-NHN-Authorization: {{authorizationToken}}

{
  "statsKeyId": "統計_ID",
  "scheduledDateTime": "2024-10-29T00:06:29+09:00",
  "confirmBeforeSend": false,
  "templateId": "テンプレート_ID",
  "templateParameters": {
    "key1": "value1",
    "key2": "value2",
    "key3": {
        "key4": "value4",
        "key5": "value5"
    }
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678"
        }
      ],
      "templateParameters": {
        "key3": {
          "key4": "value4",
          "key5": "value5"
        },
        "key6": "value6"
      }
    }
  ]
}

curl -X POST "${ENDPOINT}/message/v1.0/SMS/template-messages/${MESSAGE_PURPOSE}" \
     -H "Content-Type: application/json" \
     -H "X-NC-APP-KEY: ${APP_KEY}" \
     -H "X-NHN-Authorization: ${ACCESS_TOKEN}" \
     -d '{
        "statsKeyId": "統計_ID",
        "scheduledDateTime": "2024-10-29T00:06:29+09:00",
        "confirmBeforeSend": false,
        "templateId": "テンプレート_ID",
        "templateParameters": {
            "key1": "value1",
            "key2": "value2",
            "key3": {
                "key4": "value4",
                "key5": "value5"
            }
        },
        "recipients": [
            {
            "contacts": [
                {
                "contactType": "PHONE_NUMBER",
                "contact": "01012345678"
                }
            ],
            "templateParameters": {
                "key3": {
                "key4": "value4",
                "key5": "value5"
                },
                "key6": "value6"
            }
            }
        ]
    }'

フローメッセージ送信リクエスト

リクエスト

POST /message/v1.0/flow-messages/{messagePurpose}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

リクエスト本文

{
  "statsKeyId": "統計_ID",
  "scheduledDateTime": "2024-10-29T00:06:29+09:00",
  "confirmBeforeSend": false,
  "flowId": "テンプレート_ID",
  "templateParameters": {
    "key1": "value1",
    "key2": "value2",
    "key3": {
        "key4": "value4",
        "key5": "value5"
    }
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "TOKEN_FCM",
          "contact": "token"
        },
        {
          "contactType": "EMAIL_ADDRESS",
          "contact": "recipient@example.com"
        },
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345679"
        }
      ],
      "templateParameters": {
        "key3": {
          "key4": "value4",
          "key5": "value5"
        },
        "key6": "value6"
      }
    }
  ]
}

• フローメッセージ送信もテンプレートメッセージ送信と同じようにテンプレートパラメータを使用します。
• 受信者の連絡先はフローで使用するメッセージチャンネルに必要な連絡先が全て含まれている必要があります。

レスポンス本文

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "messageId": "メッセージ_ID"
}

リクエスト例

### フローメッセージ送信
POST {{endpoint}}/message/v1.0/flow-messages/{{messagePurpose}}
Content-Type: application/json
X-NC-APP-KEY: {{appKey}}
X-NHN-Authorization: {{authorizationToken}}

{
  "statsKeyId": "統計_ID",
  "scheduledDateTime": "2024-10-29T00:06:29+09:00",
  "confirmBeforeSend": false,
  "flowId": "テンプレート_ID",
  "templateParameters": {
    "key1": "value1",
    "key2": "value2",
    "key3": {
        "key4": "value4",
        "key5": "value5"
    }
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "TOKEN_FCM",
          "contact": "token"
        },
        {
          "contactType": "EMAIL_ADDRESS",
          "contact": "recipient@example.com"
        }
      ],
        "templateParameters": {
          "key3": {
            "key4": "value4",
            "key5": "value5"
          },
          "key6": "value6"
        }
      }
    ]
}

curl -X POST "${ENDPOINT}/message/v1.0/flow-messages/${MESSAGE_PURPOSE}" \
     -H "Content-Type: application/json" \
     -H "X-NC-APP-KEY: ${APP_KEY}" \
     -H "X-NHN-Authorization: ${ACCESS_TOKEN}" \
     -d '{
       "statsKeyId": "統計_ID",
       "scheduledDateTime": "2024-10-29T00:06:29+09:00",
       "confirmBeforeSend": false,
       "flowId": "テンプレート_ID",
       "templateParameters": {
         "key1": "value1",
         "key2": "value2",
         "key3": {
           "key4": "value4",
           "key5": "value5"
         }
       },
       "recipients": [
         {
           "contacts": [
             {
               "contactType": "TOKEN_FCM",
               "contact": "token"
             },
             {
               "contactType": "EMAIL_ADDRESS",
               "contact": "recipient@example.com"
             }
           ],
           "templateParameters": {
             "key3": {
               "key4": "value4",
               "key5": "value5"
             },
             "key6": "value6"
           }
         }
       ]
     }'

メッセージリクエストキャンセル

送信前の予約メッセージ、承認後の送信メッセージの送信要求をキャンセルします。リクエストキャンセルされたメッセージは、連絡先別受信結果照会で照会できます。

リクエスト

POST /message/v1.0/messages/{messageId}/do-cancel
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

リクエストパラメータ

リクエスト本文

このAPIはリクエスト本文を要求しません。

レスポンス本文

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  }
}

リクエスト例

### メッセージリクエストキャンセル
POST {{endpoint}}/message/v1.0/messages/{{messageId}}/do-cancel
Content-Type: application/json
X-NC-APP-KEY: {{appKey}}
X-NHN-Authorization: {{accessToken}}

curl -X POST "${ENDPOINT}/message/v1.0/messages/${MESSAGE_ID}/do-cancel" \
     -H "Content-Type: application/json" \
     -H "X-NC-APP-KEY: ${APP_KEY}" \
     -H "X-NHN-Authorization: ${ACCESS_TOKEN}"