레이아웃 목록 조회

Request

브랜드 별 등록된 레이아웃 목록을 조회합니다.

브랜드 별 등록된 레이아웃 목록을 조회합니다.

• 계정 권한: 대행사
• 브랜드 권한: 운영자

get

/brand/{brandId}/layout

Authorizations

Path parameters

brandIdstring · max: 13required

maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

Query parameters

offsetinteger · default: 0

시작 offset 번호(default: 0) 입니다.

limitinteger · min: 100 · max: 1000 · default: 100

조회 최대 건수(default: 100, maximum: 1000) 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.

대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/layout' \
  --header 'Authorization: Bearer JWT'

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		레이아웃 기본 정보 입니다.
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O
pagination	object		O		전체 건수와 페이징 조건을 제공합니다.
links	object		O		이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
layoutId	string	40			레이아웃 ID 입니다.
layoutName	string	40			레이아웃 이름 입니다.
productCode	string	20			레이아웃의 메시지 상품 코드 입니다. sms lms mms
status	string				레이아웃의 상태를 표시합니다. ready : 사용 pause : 사용중지
registerId	string	20			등록자 ID 입니다.
registerDate	string				등록일시 입니다.
updateDate	string				수정일시 입니다.
approvalResult	string				레이아웃 등록 상태입니다. 레이아웃은 운영자 검수 없이 자동 등록됩니다. 승인 : 이통3사에 정상 등록된 상태입니다. 저장 : RBC 웹에서 저장만 했을 경우 상태이며 별도 등록요청을 해야 합니다. 검수완료 : 이통 3사 등록 중 에러로 인해 최종 완료가 되지 않은 상태로 수정이나 삭제가 불가능한 상태입니다.

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "layoutId": "CLMBR.0a81DDlZjz-11GLm0hv4RX9zJB82D9r",
            "layoutName": "MMS_2024x06x26x10x11x22",
            "productCode": "mms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "leekmdevagency",
            "registerDate": "2024-07-03 10:44:51",
            "updateDate": "2024-07-03 10:44:51"
        },
        {
            "layoutId": "CLSBR.0a81DDlZjz-3WQxe43IgX1tnJnyqV04",
            "layoutName": "SMS_2024x06x26x10x11x22",
            "productCode": "sms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "leekmdevagency",
            "registerDate": "2024-07-03 10:35:04",
            "updateDate": "2024-07-03 10:35:04"
        },
        {
            "layoutId": "CLLBR.0a81DDlZjz-9OYjpEElL0HDIB079ac1",
            "layoutName": "2024x06x26x10x11x22",
            "productCode": "lms",
            "status": "ready",
            "approvalResult": "승인",
            "registerId": "leekmdevagency",
            "registerDate": "2024-07-03 10:20:10",
            "updateDate": "2024-07-03 10:20:11"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3
    },
    "status": 200
}

400

{
    "error": {
        "code": "64001",
        "message": "Missing X-RCS-BrandKey header"
    },
    "status": 400
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

403

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조