画像リストの照会

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

画像リストを照会します。

参考

画像は最大1年間保存され、その後は自動的に削除されます。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageIndex`	Integer	Optional	ページインデックス 0~N (デフォルト: 0)
`pageSize`	Integer	Optional	ページごとの項目数 1~200 (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/brandmessage/v2/services/ncp:kkobizmsg:kr:27*********6:sens/images?pageIndex=0&pageSize=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`items`	Array	-	画像リスト: items
`pageIndex`	Integer	-	ページインデックス
`pageSize`	Integer	-	ページごとの項目数
`itemCount`	Integer	-	レスポンス結果数
`hasPrevious`	Boolean	-	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	-	次のページは存在するか `true` \| `false` `true`: 存在する `false`: 存在しない
`totalCount`	Integer	-	総項目数

`items`

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

フィールド	タイプ	必須の有無	説明
`imageId`	String	-	画像 ID
`imageUrl`	String	-	画像 URL
`imageType`	String	-	画像ファイルタイプ画像タイプを参照
`imageName`	String	-	画像ファイル名
`createTime`	String	-	画像をアップロードした日時

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

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

レスポンス例

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

{
    "items": [
        {
            "imageId": "5b19970c-****-****-****-c8ec1cd8f37e",
            "imageUrl": "https://mud-kage.kakao.com/dn/dhkJRb/***********/**********************/img_l.jpg",
            "imageType": "BASIC",
            "imageName": "myImage.jpg",
            "createTime": "2025-11-27T17:29:06.253"
        }
    ],
    "pageIndex": 0,
    "pageSize": 20,
    "itemCount": 1,
    "hasPrevious": false,
    "hasNext": false,
    "totalCount": 1
}