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

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

メッセージの送信リクエストリストを照会します。直近90日以内のリクエストリストを照会できます。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`requestId`	String	Conditional	リクエスト ID メッセージ送信時、レスポンスで受け取ったリクエスト IDを入力 `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力
`requestStartTime`	String	Conditional	送信リクエスト基準の照会開始日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力
`requestEndTime`	String	Conditional	送信リクエスト基準の照会終了日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestStartTime`との期間が30日以内であること
`completeStartTime`	String	Conditional	送信完了基準の照会開始日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `requestId`、`requestStartTime`+`requestEndTime`、`completeStartTime`+`completeEndTime`のいずれか1つは必ず入力
`completeEndTime`	String	Conditional	送信完了基準の照会終了日時 YYYY-MM-DD HH:mm:ss形式(URLエンコードが必要) `completeStartTime`との期間が24時間以内であること
`messageId`	String	Optional	メッセージ ID
`type`	String	Optional	メッセージタイプ `SMS` \| `LMS` \| `MMS` `SMS`: SMSメッセージ `LMS`: LMSメッセージ `MMS`: MMSメッセージ
`contentType`	String	Optional	メッセージコンテンツタイプ `COMM` \| `AD` `COMM`: 一般用 `AD`: 広告用
`countryCode`	String	Optional	国コード
`status`	String	Optional	リクエスト状態 `READY` \| `PROCESSING` \| `COMPLETED` `READY`: 待機中 `PROCESSING`: 処理中 `COMPLETED`: 完了
`from`	String	Optional	送信番号数字のみ入力可能
`to`	String	Optional	受信番号数字のみ入力可能
`statusName`	String	Optional	受信状態 `success` \| `fail` `success`: 成功 `fail`: 失敗
`nextToken`	String	Optional	ページ位置トークン次のリスト照会時に使用し、前回の呼び出しからのレスポンスで受け取ったトークン値を入力
`pageSize`	Integer	Optional	ページごとの項目数 1~100 (デフォルト: 20) `requestId`入力時、デフォルトで1000を適用

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/messages?requestStartTime=2025-11-25%2009%3A10%3A00&requestEndTime=2025-11-25%2010%3A30%3A00&pageSize=1' \
--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	Required	状態コード HTTPステータスコード規格に準拠 `202`: 成功その他: 失敗
`statusName`	String	Required	状態 `success` \| `reserved` \| `fail` `success`: 成功 `reserved`: 予約 `fail`: 失敗
`messages`	Array	Required	メッセージ送信リクエストリスト
`pageSize`	Integer	Required	ページごとの項目数
`pageIndex`	Integer	Required	ページインデックス
`itemCount`	Integer	Required	レスポンス結果数
`hasMore`	Boolean	Required	次のページは存在するか `true`: 存在する `false`: 存在しない
`nextToken`	String	Optional	ページ位置トークン次のページがない場合、表示しない

`messages`

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

フィールド	タイプ	必須の有無	説明
`requestId`	String	Required	リクエスト ID
`messageId`	String	Required	メッセージ ID
`requestTime`	String	Required	リクエスト日時 YYYY-MM-DD HH:mm:ss形式
`contentType`	String	Required	メッセージコンテンツタイプ `COMM` \| `AD` `COMM`: 一般用 `AD`: 広告用
`type`	String	Required	メッセージタイプ `SMS` \| `LMS` \| `MMS` `SMS`: SMSメッセージ `LMS`: LMSメッセージ `MMS`: MMSメッセージ
`countryCode`	String	Required	国コード
`from`	String	Required	送信番号
`to`	String	Required	受信番号
`completeTime`	String	Optional	完了日時 YYYY-MM-DD HH:mm:ss形式
`telcoCode`	String	Optional	通信キャリアコード
`status`	String	Required	リクエスト状態 `READY` \| `PROCESSING` \| `COMPLETED` `READY`: 待機中 `PROCESSING`: 処理中 `COMPLETED`: 完了
`statusCode`	String	Optional	受信結果コード
`statusName`	String	Optional	受信状態 `success` \| `fail` `success`: 成功 `fail`: 失敗
`statusMessage`	String	Optional	受信状態メッセージ

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

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

レスポンス例

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

{
    "statusCode": "202",
    "statusName": "success",
    "messages": [
        {
            "requestId": "RSMA-*************-****-********-ijYyjJqS",
            "messageId": "f574d3f0-****-****-****-daa31f50eaf5",
            "requestTime": "2025-11-25 10:17:00",
            "contentType": "COMM",
            "type": "MMS",
            "countryCode": "82",
            "from": "010********",
            "to": "010********",
            "completeTime": "2025-11-25 10:17:00",
            "telcoCode": "ETC",
            "status": "COMPLETED",
            "statusCode": "3018",
            "statusName": "fail",
            "statusMessage": "携帯電話加入通信キャリアを通じて送信番号偽装防止付加サービスに登録した番号を送信番号として使用する場合"
        }
    ],
    "pageSize": 1,
    "pageIndex": 0,
    "itemCount": 1,
    "hasMore": true,
    "nextToken": "eyJwYXJhbWV0ZXJI...MxZjUwZWFmNSJ9"
}