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

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
serviceId String Required Biz Messageサービス ID

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

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

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

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/alimtalk/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}' 

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
requestId String - リクエスト ID
  • リクエストがrequestIdを含む場合、表示
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
templateCode String - テンプレートコード
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: 処理中。messageStatusCodemessageStatusDescが表示されない
    • 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 - 代替送信メッセージの受信状態コード
failover.messageStatusName String - 代替送信メッセージの受信状態
failover.messageStatusDesc String - 代替送信メッセージ受信状態の説明

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

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

レスポンス例

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

{
    "statusCode": "202",
    "statusName": "success",
    "messages": [
        {
            "requestTime": "2025-11-25T15:39:20.899",
            "requestId": "RBAA-*************-****-********-zgrtzVEW",
            "messageId": "aa724ca6-****-****-****-66dfc1a700e7",
            "countryCode": "82",
            "to": "010********",
            "content": "ホンギルドン様、\nご依頼の[PO394857]翻訳文書を本日18:00にメールでお送りする予定です。\n\nメール送信後、お知らせいたします。\n今しばらくお待ちください。",
            "plusFriendId": "@******",
            "templateCode": "temp001",
            "completeTime": "2025-11-25T15:39:21",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "成功",
            "messageStatusCode": "0000",
            "messageStatusName": "success",
            "messageStatusDesc": "正常に送信",
            "useSmsFailover": true
        },
        {
            "requestTime": "2025-11-25T11:59:35.611",
            "requestId": "RBAA-*************-****-********-ERsezZLD",
            "messageId": "0a7e05bf-****-****-****-cfb51e38fe36",
            "countryCode": "82",
            "to": "010********",
            "content": "シム・チョンイ様、\nご依頼の35周年お祝いの翻訳文書を本日14時にメールでお送りする予定です。\n\nメール送信後、お知らせいたします。\n今しばらくお待ちください。",
            "plusFriendId": "@******",
            "templateCode": "temp001",
            "completeTime": "2025-11-25T11:59:36",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "成功",
            "messageStatusCode": "3016",
            "messageStatusName": "fail",
            "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": "eyJwYXJhbWV0ZXJIYXNoIjoiN...LWNmYjUxZTM4ZmUzNiJ9",
    "itemCount": 2,
    "hasMore": true
}