레이아웃 수정

Request

브랜드 내 레이아웃을 수정 합니다.

브랜드 내 레이아웃을 수정 합니다.

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

put

/brand/{brandId}/layout/{layoutId}

Authorizations

Path parameters

brandIdstring · max: 13required

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

layoutIdstringrequired

레이아웃ID 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

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

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

Body

layoutNamestring · max: 40required

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

productCodestring · enum · max: 20required

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

Options: sms, lms, mms

sampleLayoutIdstring · max: 40

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

headerCompositionobject[]required

레이아웃 내 사용되는 컴포넌트 객체입니다.

bodyCompositionobject[]required

레이아웃 내 사용되는 컴포넌트 객체입니다.

footerCompositionobject[]required

레이아웃 내 사용되는 컴포넌트 객체입니다.

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/layout/{layoutId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "layoutName": "text",
    "productCode": "sms",
    "sampleLayoutId": "text",
    "headerComposition": [
      {
        "index": 1,
        "componentId": "text",
        "options": {
          "leftAlign": "left",
          "rightAlign": "right",
          "leftTextStyle": "normal",
          "rightTextStyle": "normal",
          "maxCount": 5
        }
      }
    ],
    "bodyComposition": [
      {
        "index": 1,
        "componentId": "text",
        "options": {
          "leftAlign": "left",
          "rightAlign": "right",
          "leftTextStyle": "normal",
          "rightTextStyle": "normal",
          "maxCount": 5
        }
      }
    ],
    "footerComposition": [
      {
        "index": 1,
        "componentId": "text",
        "options": {
          "leftAlign": "left",
          "rightAlign": "right",
          "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)
body	object				중계사 발송 API /message 의 body에 사용되는 발송 전문 필드 정보입니다. 규격서에 나열된 항목 이외에도 지정한 컴포넌트별 입력 가능한 항목을 추출하여 구성 제공합니다.

❖ 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 참조