이미지 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

이미지 목록을 조회합니다.

참고

이미지는 최대 1년 동안 보관되며, 이후에는 자동으로 삭제됩니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /brandmessage/v2/services/{serviceId}/images

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
serviceId String Required Biz Message 서비스 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
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 Required 이미지 목록
pageIndex Integer Required 페이지 인덱스
pageSize Integer Required 페이지당 항목 수
itemCount Integer Required 응답 결과 수
hasPrevious Boolean Required 이전 페이지 존재 여부
  • true | false
    • true: 존재
    • false: 존재 안 함
hasNext Boolean Required 다음 페이지 존재 여부
  • true | false
    • true: 존재
    • false: 존재 안 함
totalCount Integer Required 전체 항목 수

items

items에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
imageId String Required 이미지 아이디
imageUrl String Required 이미지 URL
imageType String Required 이미지 파일 타입
imageName String Required 이미지 파일 이름
createTime String Required 이미지 업로드 시간

응답 상태 코드

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
}