For the complete documentation index, see llms.txt. This page is also available as Markdown.

템플릿 등록 요청

초기 텍스트 템플릿에서만 제한적으로 사용 가능한 API 이므로 템플릿 등록 v2 API 사용을 권장합니다.

Request

브랜드 내에서 사용할 텍스트 템플릿을 등록합니다. POST /brand/{brandId}/v2/messagebase 를 이용하면 모든 유형의 템플릿을 등록할 수 있습니다.

post
/brand/{brandId}/messagebase

브랜드 내에서 사용할 텍스트 템플릿을 등록합니다. 등록된 템플릿은 RCS Biz Center 운영자의 승인 후 사용 가능합니다. 템플릿 등록 시 사용되는 messagebaseformId의 formattedString을 이용하여 템플릿의 formattedString을 등록해야 합니다.

[템플릿 등록을 위한 formattedString 처리 방법] #1. messagebaseform 리스트 조회 #2. 템플릿 생성 시 사용하고자 하는 messagebaseformId 상세 조회를 통해 formattedString 확인(messagebaseform의 formattedString은 수시 업데이트 될 수 있음) #3. Messagebaseform formattedString 의 각 widget Object 의 widgetPolicy.allowedAttributes 에 지정된 key의 value만 수정할 수 있음(이외 수정 시 오류) #4. Cell의 경우, ROOT.regMessagebases[0].formattedString.RCSMessage.openrichcardMessage.layout.children[1].children 내 object 단위 제거 할 수 있음 단, 1개 이상의 Object(LinearLayout)는 존재해야 함 #5. Cell의 경우, ROOT.regMessagebases[0].formattedString.RCSMessage.openrichcardMessage.layout.children[1].children[n].children 내 Object(TextView) 2개 중 1개는 삭제 가능함 #6. 타이틀 자유형(구 테마 강조형A) 제목 좌측 영역은 고정문자열 8자까지 허용(변수 사용 불가) #7. 타이틀 자유형(구 테마 강조형A) 제목 우측 영역에 해당하는 ROOT.formattedString.RCSMessage.openrichcardMessage.layout.children[0].children[0].children[1] 삭제 가능 #8. 타이틀 자유형(구 테마 강조형A) 제목 우측 영역에 해당하는 ROOT.formattedString.RCSMessage.openrichcardMessage.layout.children[0].children[0].children[1].text 값(value)은 템플릿 내 정의된 변수만 입력 가능(예시 참조)

  • 계정 권한: 마스터, 매니저, 대행사

  • 브랜드 권한: 브랜드 대표운영자, 운영자

  • 지원 범위: 텍스트 템플릿(타이틀 선택형 / 타이틀 자유형)

Authorizations
AuthorizationstringRequired

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

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
Responses
200

페이지 내 Response 섹션 참조

No content

post/brand/{brandId}/messagebase
200

페이지 내 Response 섹션 참조

No content

❖ request body sample

Response

필드명
타입
길이
필수여부
기본값
설명

array<object>

O

등록된 템플릿ID(= messagebaseId)

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

result - array<object>

필드명
타입
길이
필수여부
기본값
설명

messagebaseId

string

O

등록된 템플릿ID(= messagebaseId)

❖ response body sample

Last updated