레이아웃 등록

Request

브랜드 내에서 사용할 수 있는 레이아웃을 등록 합니다.

post

브랜드 내에서 사용할 수 있는 레이아웃을 등록 합니다.

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

Authorizations

Path parameters

brandIdstring · max: 13Required

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

Header parameters

X-RCS-Brandkeystring · max: 18Optional

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

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

Body

레이아웃 등록 객체 정보 입니다.

layoutNamestring · max: 40Required

maxLength: 40 - 레이아웃 이름을 지정합니다.

productCodestring · enum · max: 20Required

maxLength: 20 - 레이아웃의 메시지 상품 코드 입니다.

Possible values:

sampleLayoutIdstring · max: 40Optional

maxLength: 40 - 샘플 레이아웃 ID 입니다. 샘플 레이아웃을 이용하여 부분적으로 컴포넌트 변경하여 등록하는 경우 설정합니다.

post

HTTPcURLJavaScriptPython

POST /api/1.1/brand/{brandId}/layout HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 573

{
  "layoutName": "text",
  "productCode": "sms",
  "sampleLayoutId": "text",
  "headerComposition": [
    {
      "index": 1,
      "componentId": "text",
      "options": {
        "leftAlign": "left",
        "rightAlign": "left",
        "leftTextStyle": "normal",
        "rightTextStyle": "normal",
        "maxCount": 5
      }
    }
  ],
  "bodyComposition": [
    {
      "index": 1,
      "componentId": "text",
      "options": {
        "leftAlign": "left",
        "rightAlign": "left",
        "leftTextStyle": "normal",
        "rightTextStyle": "normal",
        "maxCount": 5
      }
    }
  ],
  "footerComposition": [
    {
      "index": 1,
      "componentId": "text",
      "options": {
        "leftAlign": "left",
        "rightAlign": "left",
        "leftTextStyle": "normal",
        "rightTextStyle": "normal",
        "maxCount": 5
      }
    }
  ]
}

❖ request body sample

SMS

{
    "layoutName": "SMS_{{YYYYMMDDHHmmss}}",
    "productCode": "sms,
    "headerComposition": [
        {
            "index": 0,
            "componentId": "CP-MainTitle",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        }
    ],
    "bodyComposition": [
        {
            "index": 1,
            "componentId": "CP-Description",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        }        
    ],
    "footerComposition": []
}

LMS

{
    "layoutName": "LMS_{{YYYYMMDDHHmmss}}",
    "productCode": "lms",
    "headerComposition": [
        {
            "index": 0,
            "componentId": "CP-MainTitle",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        }
    ],
    "bodyComposition": [
        {
            "index": 1,
            "componentId": "CP-Description",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        },
        {
            "index": 1,
            "componentId": "CP-HButton",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        },
        {
            "index": 1,
            "componentId": "CP-Description",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        },
        {
            "index": 1,
            "componentId": "CP-VButton",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 1
            }
        }
    ],
    "footerComposition": []
}

MMS

{
    "layoutName": "MMS_{{YYYYMMDDHHmmss}}",
    "productCode": "mms",
    "headerComposition": [
        {
            "index": 0,
            "componentId": "CP-ImageSquare"
        }
    ],
    "bodyComposition": [
        {
            "index": 1,
            "componentId": "CP-Description",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        },
        {
            "index": 1,
            "componentId": "CP-ItemA",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        },
        {
            "index": 1,
            "componentId": "CP-HButton",
            "options": {
                "leftAlign": "left",
                "rightAlign": "right",
                "leftTextStyle": "normal",
                "rightTextStyle": "normal",
                "maxCount": 5
            }
        }        
    ],
    "footerComposition": []
}

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		레이아웃 ID(= messagebaseId)
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
layoutId	string				등록된 레이아웃 ID(= messagebaseId) 입니다. 레이아웃 ID는 RCS 발송에 사용하는 messagebaseId 로 사용됩니다.

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "layoutId": "CLMBR.0a81DDlZjz-11GLm0hv4RX9zJB82D9r"
        }
    ],
    "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 참조