레이아웃 구성 규칙 조회

Request

메시지 상품별 레이아웃 구성 규칙을 조회합니다.

get

https://api-qa.rcsbizcenter.com/api/1.1https://api.rcsbizcenter.com/api/1.1

/baselayout/product/rule

메시지 상품별 레이아웃 구성 규칙을 조회합니다. 본 규칙에 부합해야만 레이아웃 등록/수정이 가능합니다.

• 계정 권한: 대행사

Authorizations

jwtAuth

AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Responses

200

페이지 내 Response 섹션 참조

No content

get

/baselayout/product/rule

HTTPcURLJavaScriptPython

GET /api/1.1/baselayout/product/rule HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

페이지 내 Response 섹션 참조

No content

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		상품별 레이아웃 구성 규칙 정보
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
productCode	string	20			레이아웃 사용이 가능한 메시지 상품 코드 입니다. sms lms mms
componentCount	integer				레이아웃 정의 시 지정 가능한 최대 컴포넌트 개수 입니다.
componentMinCount	integer				레이아웃 정의 시 필요한 최소 컴포넌트 개수 입니다.
buttonCount	integer				레이아웃 정의 시 지정 가능한 버튼 컴포넌트 개수 입니다.
componentLimit	object				현재 제공되는 컴포넌트 그룹ID 별 레이아웃 내 설정 가능한 컴포넌트 그룹의 지정 가능 개수를 표시합니다.

componentLimit - object

필드명	타입	길이	필수여부	기본값	설명
ImageGroup	integer				이미지를 표시할 수 있는 컴포넌트 그룹입니다.
TitleGroup	integer				제목을 표시할 수 있는 컴포넌트 그룹입니다.
BannerGroup	integer				배너형태의 이미지를 표시할 수 있는 컴포넌트 그룹입니다.
DescriptionGroup	integer				일반적인 내용을 표시할 수 있는 컴포넌트 그룹입니다.
ItemGroup	integer				작은 아이콘형태 이미지와 소제목을 표시할 수 있는 컴포넌트 그룹입니다.
ThumbDescGroup	integer				작은 이미지와 설명을 표시할 수 있는 컴포넌트 그룹입니다.
TableGroup	integer				표 형식으로 내용을 표시할 수 있는 컴포넌트 그룹입니다.
ThumbnailGroup	integer				작은 아이콘형태 이미지와 소제목을 표시할 수 있는 컴포넌트 그룹입니다.
NoticeGroup	integer				특정 용도의 내용을 표시할 수 있는 컴포넌트 그룹입니다.
ButtonGroup	integer				버튼을 표시할 수 있는 컴포넌트 그룹입니다.

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "productCode": "sms",
            "componentMinCount": 1,
            "componentCount": 2,
            "buttonCount": 1,
            "componentLimit": {
                "ItemGroup": 1,
                "TableGroup": 1,
                "ButtonGroup": 1,
                "DescriptionGroup": 1,
                "TitleGroup": 1
            }
        },
        {
            "productCode": "lms",
            "componentMinCount": 1,
            "componentCount": 6,
            "buttonCount": 3,
            "componentLimit": {
                "ItemGroup": 1,
                "NoticeGroup": 1,
                "TableGroup": 2,
                "ButtonGroup": 3,
                "DescriptionGroup": 3,
                "TitleGroup": 1
            }
        },
        {
            "productCode": "mms",
            "componentMinCount": 1,
            "componentCount": 6,
            "buttonCount": 3,
            "componentLimit": {
                "ItemGroup": 1,
                "NoticeGroup": 1,
                "TableGroup": 1,
                "ThumbnailGroup": 1,
                "ButtonGroup": 3,
                "ThumbDescGroup": 1,
                "DescriptionGroup": 1,
                "ImageGroup": 1,
                "TitleGroup": 1,
                "BannerGroup": 1
            }
        }
    ],
    "status": 200
}

401

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