Classic/VPC環境で利用できます。
メッセージを送信します。テキスト、画像、ワイド画像、ワイドアイテムリスト、コマース、カルーセルコマース、カルーセルフィード、プレミアム動画、基本テンプレートなどのメッセージタイプをサポートします。
- ターゲティングコードを指定することで、メッセージ対象のグループを指定できます。
- M: 顧客の情報提供型広告の受信に同意したユーザー(カカオトーク受信同意)
- N: 顧客の情報提供型広告の受信に同意したユーザー(カカオトーク受信同意) - チャンネル友達
- I: 顧客の送信リクエスト対象 ∩ チャンネル友達
- ブランドメッセージの申し込みが完了したチャンネルに限り、ターゲティングコード M、Nグループ送信を利用できます。
- ターゲティングコード M、Nグループで送信する際は、チャンネルに指定された080無料受信拒否番号を使用します。
- 自由型送信
- AC(チャンネル追加)ボタンは使用できません。
- 基本型の送信
- BC、BTボタンは使用できません。
- 夜間の送信制限が適用されます (20:50~翌日8:00)。
テキスト型メッセージ
テキスト型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
content |
String | Required | メッセージ内容
|
buttons |
Array | Optional | ボタン情報
|
coupon |
Object | Optional | クーポン情報 |
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
ボタンタイプ
ボタンタイプの説明は次の通りです。
| フィールド | タイプ | 説明 |
|---|---|---|
WL |
String | ウェブリンク
|
AL |
String | アプリリンク
|
BF |
String | ビジネスフォーム
|
AC |
String | チャンネル追加
|
BK |
String | ボットキーワード |
MD |
String | メッセージ伝達 |
BC |
String | 相談トークに切り替え
|
BT |
String | チャットボットに切り替え
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType":"TEXT",
"targeting":"I",
"isAdult":"false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
]
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
messageId |
String | Required | メッセージ ID |
countryCode |
String | Optional | 国コード |
to |
String | Required | 受信番号 |
requestStatusCode |
String | Required | リクエストの状態コード
|
requestStatusName |
String | Required | リクエスト状態
|
requestStatusDesc |
String | Required | リクエスト状態の説明 |
useSmsFailover |
Boolean | Required | SMS代替送信を使用するか
|
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-dDYJgYGe",
"requestTime": "2025-12-01T17:00:42.572",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "f38c01be-****-****-****-3bddf7615aef",
"countryCode": "82",
"to": "010********",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
画像型メッセージ
画像型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
content |
String | Required | メッセージの内容
|
buttons |
Array | Optional | ボタン情報
|
image |
Object | Optional | 画像情報
|
image.imageId |
String | Conditional | 画像 ID
|
image.imageLink |
String | Conditional | 画像 URL
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType":"IMAGE",
"targeting":"I",
"isAdult":"false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"image": {
"imageId": "88903684-****-****-****-5d6eb410bf30",
"imageLink": "https://mud-kage.kakao.com/dn/zNW4l/***********/**********************/img_l.jpg"
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-01T17:45:40.047",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "5ba5a7a8-****-****-****-55a76b65f7ec",
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
ワイド画像型メッセージ
ワイド画像型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
content |
String | Required | メッセージの内容
|
buttons |
Array | Optional | ボタン情報
|
image |
Object | Optional | 画像情報
|
image.imageId |
String | Conditional | 画像 ID
|
image.imageLink |
String | Conditional | 画像 URL
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType":"WIDE_IMAGE",
"targeting":"I",
"isAdult":"false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"image": {
"imageId": "4983629b-****-****-****-8546230fc8f2",
"imageLink": "https://mud-kage.kakao.com/dn/JR45M/***********/**********************/img_l.jpg"
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-02T11:54:21.776",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "d8dedd42-****-****-****-2f7b08d080da",
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
ワイドアイテムリスト型メッセージ
ワイドアイテムリスト型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
headerContent |
String | Required | ヘッダ(件名)
|
buttons |
Array | Optional | ボタン情報
|
item |
Object | Required | ワイドリスト情報 |
item.list |
Array | Required | ワイドリスト |
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
item.list
item.listの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
title |
String | Required | アイテムの件名
|
imageId |
String | Required | 画像 ID
|
linkMobile |
String | Required | モバイルウェブリンク
|
linPc |
String | Optional | PCウェブリンク
|
schemeAndroid |
String | Optional | Androidアプリリンク
|
schemeIos |
String | Optional | iOSアプリリンク
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType": "WIDE_ITEM_LIST",
"targeting":"I",
"isAdult": "false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"headerContent": "お祝いカード",
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"item": {
"list": [
{
"title": "メイン",
"imageId": "34ba283e-****-****-****-db59803ae7eb",
"linkMobile": "https://******.com/ko/"
},
{
"title": "アイテム1",
"imageId": "67828a69-****-****-****-9026147fe5ee",
"linkMobile": "https://******.com/ko/"
},
{
"title": "アイテム2",
"imageId": "67828a69-****-****-****-9026147fe5ee",
"linkMobile": "https://******.com/ko/"
}
]
}
}
]
}
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-02T13:54:05.618",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "a5e6541c-****-****-****-57ab20c82f9e",
"countryCode": "82",
"to": "010********",
"content": null,
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
コマース型メッセージ
コマース型(COMMERCE)メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
additionalContent |
String | Optional | 付加情報
|
buttons |
Array | Required | buttons情報
|
image |
Object | Optional | 画像情報
|
image.imageId |
String | Conditional | 画像 ID
|
image.imageLink |
String | Conditional | 画像 URL
|
commerce |
Object | Required | コマース情報 |
commerce.title |
String | Required | 商品名
|
commerce.regularPrice |
String | Required | 通常価格(ウォン)
|
commerce.discountPrice |
String | Conditional | 割引価格(ウォン)
|
commerce.discountRate |
String | Conditional | 割引率(%)
|
commerce.discountFixed |
String | Conditional | 定額割引価格(%)
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType": "COMMERCE",
"targeting":"I",
"isAdult": "false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"additionalContent": "お祝いカード10%割引",
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"image": {
"imageId": "88903684-****-****-****-5d6eb410bf30",
"imageLink": "https://mud-kage.kakao.com/dn/zNW4l/***********/**********************/img_l.jpg"
},
"commerce": {
"title":"10%割引",
"regularPrice":"10000",
"discountPrice":"9000",
"discountRate":"10"
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-dDYJgYGe",
"requestTime": "2025-12-02T14:53:14.350",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "601df2a9-****-****-****-d5c1b178447e",
"countryCode": "82",
"to": "010********",
"content": null,
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
カルーセルコマース型メッセージ
カルーセルコマース型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
carousel |
Object | Required | カルーセル情報 |
carousel.head |
Object | Optional | カルーセルイントロ情報 |
carousel.head.headerContent |
String | Required | ヘッダ(件名)
|
carousel.head.content |
String | Required | 内容
|
carousel.head.imageId |
String | Required | 画像 ID
|
carousel.head.linkMobile |
String | Conditional | モバイルウェブリンク
|
carousel.head.linkPc |
String | Optional | PCウェブリンク
|
carousel.head.schemeAndroid |
String | Optional | Androidアプリリンク
|
carousel.head.schemeIos |
String | Optional | iOSアプリリンク
|
carousel.list |
Array | Required | カルーセルリスト
|
carousel.tail |
Object | Optional | カルーセルのもっと見る情報 |
carousel.tail.linkMobile |
String | Required | モバイルウェブリンク
|
carousel.tail.linkPc |
String | Optional | PCウェブリンク
|
carousel.tail.schemeAndroid |
String | Optional | Androidアプリリンク
|
carousel.tail.schemeIos |
String | Optional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
carousel.list
carousel.listの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
additionalContent |
String | Optional | 付加情報
|
buttons |
Array | Required | ボタン情報: buttons
|
image |
Object | Optional | 画像情報
|
image.imageId |
String | Conditional | 画像 ID
|
image.imageLink |
String | Conditional | 画像 URL
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
commerce |
Object | Required | コマース情報 |
commerce.title |
String | Required | 商品名
|
commerce.regularPrice |
Integer | Required | 通常価格(ウォン)
|
commerce.discountPrice |
Integer | Conditional | 割引価格(ウォン)
|
commerce.discountRate |
Integer | Conditional | 割引率(%)
|
commerce.discountFixed |
Integer | Conditional | 定額割引価格(%)
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"messageType": "CAROUSEL_COMMERCE",
"targeting":"I",
"isAdult": "false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"carousel": {
"head": {
"headerContent":"お祝いカード",
"content":"お祝いカード割引イベント",
"imageId":"cde370b6-****-****-****-6a122739e51f",
"linkMobile":"https://******.com/ko/"
},
"list": [
{
"image": {
"imageId": "cde370b6-****-****-****-6a122739e51f",
"imageLink": "https://mud-kage.kakao.com/dn/hIaN2/***********/**********************/img_l.jpg"
},
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"commerce": {
"title": "10%割引",
"regularPrice": "10000",
"discountPrice": "9000",
"discountRate": "10"
}
},
{
"image": {
"imageId": "cde370b6-****-****-****-6a122739e51f",
"imageLink": "https://mud-kage.kakao.com/dn/***********/**********************/img_l.jpg"
},
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"commerce": {
"title": "10%割引",
"regularPrice": "10000",
"discountPrice": "9000",
"discountRate": "10"
}
}
],
"tail": {
"linkMobile": "https://hansem.com/ko/"
}
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-02T15:56:08.336",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "89e11238-****-****-****-a400627816af",
"countryCode": "82",
"to": "010********",
"content": null,
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
カルーセルフィード型メッセージ
カルーセルフィード型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
carousel |
Object | Required | カルーセル情報 |
carousel.list |
Array | Required | カルーセルリスト
|
carousel.tail |
Object | Optional | カルーセルのもっと見る情報 |
carousel.tail.linkMobile |
String | Required | モバイルウェブリンク
|
carousel.tail.linkPc |
String | Optional | PCウェブリンク
|
carousel.tail.schemeAndroid |
String | Optional | Androidアプリリンク
|
carousel.tail.schemeIos |
String | Optional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
carousel.list
carousel.listの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
headerContent |
String | Required | ヘッダ(件名)
|
message |
String | Required | 内容
|
buttons |
Array | Required | ボタン情報
|
image |
Object | Optional | 画像情報
|
image.imageId |
String | Conditional | 画像 ID
|
image.imageLink |
String | Conditional | 画像 URL
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": @******",
"messageType": "CAROUSEL_FEED",
"targeting":"I",
"isAdult": "false",
"messages": [
{
"countryCode": "82",
"to": "010********",
"carousel": {
"list": [
{
"headerContent":"お祝いカード1",
"message":"お祝いカード割引イベント1",
"image": {
"imageId":"6c4b9ceb-****-****-****-cf550dd5f2e8",
"imageLink": "https://mud-kage.kakao.com/dn/C2Ft0/***********/**********************/img_l.jpg"
},
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"coupon": {
"title": "10%割引",
"description": "10%割引",
"linkMobile": "https://******.com/ko/blog/"
}
},
{
"headerContent":"お祝いカード2",
"message":"お祝いカード割引イベント2",
"image": {
"imageId":"6c4b9ceb-****-****-****-cf550dd5f2e8",
"imageLink": "https://mud-kage.kakao.com/dn/C2Ft0/***********/**********************/img_l.jpg"
},
"buttons": [
{
"type": "WL",
"name": "公式サイト",
"linkMobile": "https://******.com/ko/",
"linkPc": "https://******.com/ko/"
},
{
"type": "WL",
"name": "ブログ",
"linkMobile": "https://******.com/ko/blog/",
"linkPc": "https://******.com/ko/blog/"
}
],
"coupon": {
"title": "10%割引",
"description": "10%割引",
"linkMobile": "https://******.com/ko/blog/"
}
}
],
"tail": {
"linkMobile": "https://******.com/ko/"
}
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-02T16:43:08.144",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "a357721f-****-****-****-6b03cd053dbb",
"countryCode": "82",
"to": "010********",
"content": null,
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
プレミアム動画型メッセージ
プレミアム動画型メッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
targeting |
String | Optional | ターゲティングコード
|
isAdult |
Boolean | Optional | 対象の年齢
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
headerContent |
String | Optional | ヘッダ(件名)
|
content |
String | Optional | 内容
|
video |
Object | Required | 動画情報 |
video.thumbnailId |
String | Required | 動画サムネイル用画像 ID
|
video.videoUrl |
String | Required | カカオ TV動画 URL
|
buttons |
Array | Optional | ボタン情報: buttons
|
coupon |
Object | Optional | クーポン情報
|
coupon.title |
String | Required | クーポンの件名
|
coupon.description |
String | Required | クーポンの説明
|
coupon.linkMobile |
String | Conditional | モバイルウェブリンク
|
coupon.linkPc |
String | Optional | PCウェブリンク
|
coupon.schemeAndroid |
String | Conditional | Androidアプリリンク
|
coupon.schemeIos |
String | Conditional | iOSアプリリンク
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
Array | Required | ボタンタイプ情報 |
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Optional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
bizFormId |
String | Optional | ビジネスフォーム ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId":"@******",
"messageType":"PREMIUM_VIDEO",
"targeting":"I",
"isAdult":false,
"messages":[
{
"countryCode":"82",
"to":"010********",
"headerContent":"お祝いカード",
"content":"お祝いカード",
"video": {
"thumbnailId":"7b8101c8-****-****-****-ad384cb8e215",
"videoUrl":"https://tv.kakao.com/v/********"
},
"buttons":[
{
"type":"WL",
"name":"公式サイト",
"linkMobile":"https://******.com/ko/"
}
],
"coupon": {
"title":"お祝いカード10%割引",
"description":"お祝いカード10%割引イベント",
"linkMobile":"https://******.com/ko/"
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-dDYJgYGe",
"requestTime": "2025-12-02T17:18:16.512",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "9c5063e5-****-****-****-fd10d1aab9c4",
"countryCode": "82",
"to": "010********",
"content": "お祝いカード",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}
テンプレート(基本型)メッセージ
ブランドメッセージテンプレート(基本型)でメッセージを送信します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /brandmessage/v2/services/{serviceId}/messages |
リクエストヘッダ
Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
serviceId |
String | Required | Biz Messageサービス ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
plusFriendId |
String | Required | チャンネル ID
|
messageType |
String | Required | メッセージタイプ
|
templateCode |
String | Required | メッセージテンプレートコード
|
targeting |
String | Optional | ターゲティングコード
|
messages |
Array | Required | メッセージ情報 |
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
templateParameters |
Object | Required | テンプレートパラメータ
|
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージの内容
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId":"@hckang",
"messageType":"TEXT",
"templateCode":"**********7fe153599b210d9e865a**********",
"targeting":"I",
"messages":[
{
"countryCode":"82",
"to":"010********",
"templateParameters": {
"名前": "ホンギルドン",
"割引金額": "10000"
}
}
]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
requestId |
String | Required | リクエスト ID |
requestTime |
DateTime | Required | リクエスト日時
|
statusCode |
String | Required | リクエストの状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Optional | メッセージ情報 |
レスポンスステータスコード
Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"requestId": "RBBA-*************-****-********-zVDPjteh",
"requestTime": "2025-12-03T11:44:27.774",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "789e27ff-****-****-****-fc50656fe511",
"countryCode": "82",
"to": "010********",
"content": null,
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "成功",
"useSmsFailover": false
}
]
}