メッセージ送信リストの照会

Classic/VPC環境で利用できます。

ブランドメッセージのメッセージに対する送信リクエストリストを照会します。直近30日以内のリクエストリストを照会できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/brandmessage/v2/services/{serviceId}/messages

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	Biz Messageサービス ID プロジェクトリストの照会を参照

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

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`requestId`	String	Conditional	リクエスト ID メッセージ送信時、レスポンスで受け取ったリクエスト IDを入力 `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力 `requestStartTime`+`requestEndTime`と`completeStartTime`+`completeEndTime`は同時使用不可
`requestStartTime`	String	Conditional	送信リクエスト基準の照会開始日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力 `requestStartTime`+`requestEndTime`と`completeStartTime`+`completeEndTime`は同時使用不可
`requestEndTime`	String	Conditional	送信リクエスト基準の照会終了日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestStartTime`との期間が31日以内であること
`completeStartTime`	String	Conditional	送信完了基準の照会開始日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力 `requestStartTime`+`requestEndTime`と`completeStartTime`+`completeEndTime`は同時使用不可
`completeEndTime`	String	Conditional	送信完了基準の照会終了日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `completeStartTime`との期間が24時間以内であること
`plusFriendId`	String	Conditional	チャンネル ID NAVERクラウドプラットフォームコンソールの Simple & Easy Notification Service > Biz MessageBrand > KakaoTalk Channelで確認 `requestId`未入力時、必ず入力
`messageId`	String	Optional	メッセージ ID
`requestStatusName`	String	Optional	リクエスト状態 `success` \| `fail` `success`: 成功 `fail`: 失敗
`messageStatusName`	String	Optional	受信状態 `success` \| `processing` \| `fail` `success`: 成功 `processing`: 処理中 `fail`: 失敗
`templateCode`	String	Optional	テンプレートコード NAVERクラウドプラットフォームコンソールの Simple & Easy Notification Service > Biz MessageBrand > Message Templateで確認
`to`	String	Optional	受信番号数字のみ入力可能
`nextToken`	String	Optional	ページ位置トークン次のリスト照会時に使用し、前回の呼び出しからのレスポンスで受け取ったトークン値を入力
`pageSize`	Integer	Optional	ページごとの項目数 1~100 (デフォルト: 20) `requestId`入力時、デフォルトで100を適用

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages?requestStartTime=2025-11-25T09%3A10%3A00&requestEndTime=2025-11-25T23%3A30%3A00&pageSize=3' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`statusCode`	String	-	状態コード HTTPステータスコード規格に準拠 `202`: 成功その他: 失敗
`statusName`	String	-	状態 `success` \| `processing` \| `reserved` \| `fail` `success`: 成功 `processing`: 処理中 `reserved`: 予約 `fail`: 失敗
`messages`	Array	-	メッセージ送信リクエストリスト: messages
`pageSize`	Integer	-	ページごとの項目数
`pageIndex`	Integer	-	ページインデックス
`nextToken`	String	-	ページ位置トークン次のページがない場合、表示しない
`itemCount`	Integer	-	レスポンス結果数
`hasMore`	Boolean	-	次のページは存在するか `true`: 存在する `false`: 存在しない

`messages`

messagesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`requestTime`	String	-	リクエスト日時 YYYY-MM-DDTHH:mm:ss.sss形式
`requestId`	String	-	リクエスト ID
`messageId`	String	-	メッセージ ID
`countryCode`	String	-	国コード
`to`	String	-	受信番号
`content`	String	-	メッセージの内容
`plusFriendId`	String	-	チャンネル ID
`messageType`	String	-	メッセージタイプ `TEXT` \| `IMAGE` \| `WIDE_IMAGE` \| `WIDE_ITEM_LIST` \| `COMMERCE` \| `CAROUSEL_COMMERCE` \| `CAROUSEL_FEED` \| `PREMIUM_VIDEO` `TEXT`: テキスト `IMAGE`: 画像型 `WIDE_IMAGE`: ワイド画像型 `WIDE_ITEM_LIST`: ワイドリスト型 `COMMERCE`: コマース型 `CAROUSEL_COMMERCE`: カルーセルコマース型 `CAROUSEL_FEED`: カルーセルフィード型 `PREMIUM_VIDEO`: プレミアム動画型
`isAdult`	Boolean	-	対象の年齢 `true` \| `false` (デフォルト) `true`: 成人向け `false`: 全年齢向け
`targeting`	String	-	ターゲティングコード `M` \| `N` \| `I` (デフォルト) `M`: 顧客の情報提供型広告の受信に同意したユーザー(カカオトーク受信同意) `N`: 顧客の情報提供型広告の受信に同意したユーザー(カカオトーク受信同意)のうち、当該チャンネルの友達を除く `I`: 情報提供型広告の受信に同意したユーザー(カカオトーク受信同意)であり、なおかつ当該チャンネルの友達 `F`: チャンネルの友達ではない対象を除く(サポート予定)
`completeTime`	String	-	完了日時 YYYY-MM-DDTHH:mm:ss形式
`requestStatusCode`	String	-	リクエストの状態コード `A000`: 成功その他: 失敗
`requestStatusName`	String	-	リクエスト状態 `success` \| `fail` `success`: 成功 `fail`: 失敗
`requestStatusDesc`	String	-	リクエスト状態の説明
`messageStatusCode`	String	-	受信状態コードを参照 `0000`: 成功その他: 失敗
`messageStatusName`	String	-	受信状態 `success` \| `processing` \| `fail` `success`: 成功 `processing`: 処理中。`messageStatusCode`と`messageStatusDesc`が表示されない `fail`: 失敗
`messageStatusDesc`	String	-	受信状態の説明
`useSmsFailover`	Boolean	-	SMS代替送信を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`failover`	Object	-	SMS代替送信情報代替送信が実行された場合、表示
`failover.smsServiceId`	String	-	代替送信に使用された SMSサービス ID
`failover.requestId`	String	-	代替送信リクエスト ID
`failover.messageId`	String	-	代替送信メッセージ ID
`failover.requestStatusCode`	String	-	SMS代替送信リクエストの状態コードを参照
`failover.requestStatusName`	String	-	代替送信のリクエスト状態 `success` \| `fail` `success`: 成功 `fail`: 失敗
`failover.requestStatusDesc`	String	-	代替送信リクエスト状態の説明
`failover.messageStatus`	String	-	代替送信メッセージの状態 `READY` \| `PROCESSING` \| `COMPLETED` `READY`: 待機中 `PROCESSING`: 処理中 `COMPLETED`: 完了
`failover.messageStatusCode`	String	-	代替送信メッセージの受信状態コード SMS受信結果コードを参照
`failover.messageStatusName`	String	-	代替送信メッセージの受信状態
`failover.messageStatusDesc`	String	-	代替送信メッセージ受信状態の説明

レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "statusCode": "202",
    "statusName": "success",
    "messages": [
        {
            "requestTime": "2025-11-28T11:21:06.317",
            "requestId": "RBBA-*************-****-********-QlvjXtBr",
            "messageId": "bc87c708-****-****-****-57b56c506309",
            "countryCode": "82",
            "to": "010********",
            "plusFriendId": "@******",
            "messageType": "TEXT",
            "targeting": "I",
            "isAdult": false,
            "completeTime": "2025-11-28T11:21:06",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "成功",
            "messageStatusCode": "0000",
            "messageStatusName": "success",
            "messageStatusDesc": "正常に送信",
            "useSmsFailover": false
        },
        {
            "requestTime": "2025-11-28T10:46:55.663",
            "requestId": "RBBA-*************-****-********-kgepsygn",
            "messageId": "3d68485a-****-****-****-730c20492b51",
            "countryCode": "82",
            "to": "010********",
            "plusFriendId": "@******",
            "messageType": "TEXT",
            "targeting": "I",
            "isAdult": false,
            "completeTime": "2025-11-28T10:46:56",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "成功",
            "messageStatusCode": "0000",
            "messageStatusName": "success",
            "messageStatusDesc": "正常に送信",
            "useSmsFailover": true,
            "failover": {
                "smsServiceId": "ncp:sms:kr:27*********6:sens",
                "requestId": "RSLA-*************-****-********-ZzdhBYsk",
                "messageId": "6cc7eab4-****-****-****-c523f8a0e8ce",
                "requestStatusCode": "0",
                "requestStatusName": "success",
                "requestStatusDesc": "成功",
                "messageStatus": "COMPLETED",
                "messageStatusCode": "0",
                "messageStatusName": "success",
                "messageStatusDesc": "成功"
            }
        }
    ],
    "pageSize": 2,
    "pageIndex": 0,
    "nextToken": "**********V0ZXJIYXNoIjoiNTBkOTg5NTdkYmM2MjIwZWJjMzAyMzNiNmQwZWRlN**********jZGJlMmI5MTcyOTQ3ZDNiZjU0YzRjNjU3NiIsInRva2VuSGFzaCI6ImVmM2NlNGUyMjc1MTE1ZDNiMDZiNjhmNzJiOWM0MDcxOTQ1MjA2MGRiN2M4MmRiYTQ1MGMxNzIwOTBiNmMy**********NoZWRFcG9jaE1pbGxpcyI6MTc2NDI5NjU4MDIwMywicmVxdWVzdFRpbWVFcG9jaE1pbGxpcyI6MTc2NDI5NDQxNTY2MywiY29tcGxldGVUaW1lRXBvY2hNaWxsaXMiOm51bGwsIm1lc3NhZ2VJZCI6IjNkNjg0ODVhLWU3NmQtNGE3Ny05Y2Q0LTczMGMyMD**********",
    "itemCount": 2,
    "hasMore": true
}