RCS Biz Center

템플릿 양식 상세 조회

Request

템플릿 유형의 상세 내용을 조회합니다.

get
/messagebase/messagebaseform/{messagebaseformId}

템플릿 유형의 상세 내용을 조회합니다.

params, formattedString을 이용하여 템플릿 작성시 사용합니다.

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

Authorizations
AuthorizationstringRequired

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

Path parameters
messagebaseformIdstringRequired

messagebaseform ID Path parameter 입니다.

Responses
200

페이지 내 Response 섹션 참조

No content
get
/messagebase/messagebaseform/{messagebaseformId}
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>

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

messagebaseformId

string

40

O

템플릿 양식 ID 입니다.

formName

string

40

O

템플릿 양식명 입니다.

cardType

string

64

카드종류를 구분합니다. 향후 추가될 수 있습니다.

  • Description

  • Cell

  • Free

bizCondition

array<string>

양식을 사용할 수 있는 대상 업태의 목록입니다.

bizCategory

string

20

Description, Cell의 유형그룹 입니다.

bizService

string

20

Description, Cell의 세부 유형 입니다.

registerDate

string

템플릿 양식 등록일시 입니다.

updateDate

string

템플릿 양식 수정일시 입니다.

mediaUrl

array<object>

이미지 파일ID와 URL 및 사용 유형 정보를 제공합니다.

productCode

string

메시지 상품종류 구분값입니다. "sms", "lms", "mms", "tmplt", "itmpl"

spec

string

양식의 레이아웃 구조가 리치카드인지 오픈리치카드인지 구분합니다. "richcard", "openrichcard" AOS/iOS 26 통합 지원 규격이 추가되었습니다. "richcardPlus"

guideInfo

object

템플릿 작성에 필요한 가이드 정보를 제공하기 위하여 양식 정의 시 포함되는 정보입니다. 리치카드의 경우 messagebaseInfo에서 제공됩니다.

policyInfo

object

리치카드, 오픈리치카드에 포함된 content(title, description, media, button) 에 대한 검증 정책 저장을 위한 객체입니다.

params

array<object>

템플릿의 개별 파라미터를 검수하기 위한 대상 파라미터 정보 객체입니다. 크기 관련 필드는 <=0 인 경우 체크하지 않습니다.

formattedString

object

GSMA 및 TTA RCS 규격이며 JSON 형식으로 정의된 템플릿의 레이아웃 데이터입니다.

GSMA RCC.07-v11.0 참조 https://www.gsma.com/solutions-and-impact/technologies/networks/wp-content/uploads/2019/10/RCC.07-v11.0.pdf

TTAK.KO-06.0410/R7 참조

https://committee.tta.or.kr/data/standard_view.jsp?secondDepthCode=PG1105&firstDepthCode=TC011&pk_num=TTAK.KO-06.0410/R7&commit_code=PG1105

mediaUrl - array<object>

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

fileId

string

url

string

typeName

string

이미지의 사용 유형을 구분합니다.

  • icon - 템플릿 양식 아이콘 이미지

  • profile - 브랜드 프로필 이미

  • background - 브랜드 백그라운드 이미지

fileName

string

256

등록한 파일의 이름입니다.

guideInfo - object

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

maxLineCount

integer

max 라인수

maxDisplayText

integer

버튼명 글자수

maxDescriptionSize

integer

카드별 max 본문 글자수

imageWidth

integer

이미지 권고 가로 사이즈 단위는 Pixel

imageHeight

integer

이미지 권고 세로 사이즈 단위는 Pixel

detailInfo

object

리치카드 메시지 상품별 1라인당 글자수, 타이틀 라인수 및 버튼 수에 따라 메시지가 잘려 보이지 않는 최대 라인수 정보를 제공합니다.

메시지가 수신된 단말에 따라 상이할 수 있으나 리치카드 RCS메시지 발송 시 권장사항으로 참고하시기 바랍니다.

LMS와 MMS 12종 총 13종에 대해 개별 제공됩니다.

detailInfo - object

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

productCardType

string

상품 카드 종류

releaseDate

string

정보 제공 일자(내용 수정시 일시 변경)

summary

string

요약 정보

charactersPerLine

object

각 항목 별 권장 라인당 글자수

combinations

array<object>

디스크립션 권장 라인수 조합

policyInfo - object

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

buttonsAllowed

boolean

MaaP FE /message의 buttons 사용 유무

  • true : buttons 필드 사용

  • false : buttons 에 값이 들어오면 실패 처리

adHeaderAllowed

boolean

header에 광고 인입 허가 여부

  • true : 광고인입 허용(MaaP FE /message의 header 체크안함)

  • false : 광고인입 불허(MaaP FE /message이 header가 1(광고) 이면 실패 처리)

adBodyAllowed

boolean

광고 문구 허용 여부

  • true : 본문 광고 문구를 체크하지 않음.

  • false : 본문이 "(광고)"로 시작하면 실패 처리

cardCount

integer

카드 개수

maxTitleSize

integer

개별 타이틀 글자 최대 수. 사용하지 않음.

maxButtonCount

integer

버튼 최대 개수

maxDescriptionSize

integer

  • RichCard인 경우(Carousel포함) Description들의 글자수 총합.

  • OpenRichCard인 경우 변수부 글자수 총합. <=0 인 경우 사용하지 않음.

maxMediaSize

integer

Byte단위 미디어 크기 총합의 최대 크기, <=0 인 경우 사용하지 않음.

params - array<object>

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

param

string

20

O

검수 파라미터명. (영문, 한글, 숫자, '_' 만 사용)

isMandatory

boolean

false

필수여부.

  • true인 경우 중계사에서 메시지 전송 요청 시 해당 필드가 없는 경우 MaaP FE에서 실패처리한다.

  • false인 경우는 해당 필드가 없는 경우도 메시지 전송이 되도록 MaaP FE에서 적절하게 처리한다.

type

string

기술검사타입을 지정합니다.

  • string: 문자열 검사 대상

  • file: 파일 검사 대상

  • button: formattedString 내 button 제어 대상

  • layout: formattedString 내 button외 제어 대상

contentType

string

컨텐츠 유형, PolicyInfo 정책을 검사하는데 사용됩니다.

  • title: 메시지 상품 제한 글자수에 포함되지 않는 유형

  • description: 메시지 상품 제한 글자수에 포함되며 템플릿 등록 문장 패턴 검사 대상

  • maapfile: 메시지 내 표시되는 이미지/영상 등의 fileId 지정 대상

  • cell: 메시지 상품 제한 글자수에 포함되며 템플릿 등록 문장 패턴 검사 제외

  • displayText: Suggested Actions 규격의 버튼명

  • url: URL 형식 체크 대상

  • etc: 템플릿 등록 시 버튼 Action 중 URL을 제외한 나머지 Action 내 사용자 지정 변수

  • buttonName: Button 위젯의 버튼명

  • visibility: 메시지 표시 영역 별 표시 제어 영역

  • notice: 메시지 상품 제한 글자수에 포함되지 않는 유형

strSize

integer

글자 최대 크기, type이 string인 경우

fileSize

integer

파일 최대 크기, type이 file인 경우.

strRegx

string

65535

java regular expression, null 인경우 사용하지 않음. 예)

  1. 숫자만 : '^[0-9]*$'

  2. 영문자만 : '[a-zA-Z]*$'

  3. 한글만 : '^[가-힣]*$'

  4. 영어 & 숫자만 : '^[a-zA-Z0-9]*$'

  5. E-Mail : '^[a-zA-Z0-9]+@[a-zA-Z0-9]+$'

  6. 휴대폰 : '^01(?:0|1|[6-9])-(?:\d{3}|\d{4})-\d{4}$'

  7. 일반전화 : '^\d{2,3}-\d{3,4}-\d{4}$'

  8. 주민등록번호 : '\d{6}-[1-4]\d{6}'

  9. IP 주소 : '([0-9]{1,3}).([0-9]{1,3}).([0-9]{1,3}).([0-9]{1,3})'

verification

array<string>

문장 패턴 정의 (SKT향) "안녕하세요", "님 ", "원입니다."

imageWidth

integer

이미지 해상도 가로 크기 (지정된 크기의 이미지를 등록해야 정상 발송 가능)

imageHeight

integer

이미지 해상도 세로 크기 (지정된 크기의 이미지를 등록해야 정상 발송 가능)

couplingId

string

20

파라미터 간 함께 처리되어야 하는 경우 동일한 값을 부여 즉, 같은 값의 couplingId가 지정되는 경우 지정된 파라미터는 모두 조건을 만족해야 정상 발송 처리됨

inputText

string

65535

템플릿 등록시 사용자 입력한 원본 문장(고정부 & 변수부)을 제공합니다. 단, cell방식의 타이틀 선택형은 제공되지 않습니다.

relationId

string

param과 관계가 있는 param을 의미합니다. 주로 현재 param이 입력되지 않을 경우 메시지 상에 노출여부와 연관된 visibility에 지정된 param을 표시합니다. 메시지 발송시 이통MaaP FE에서 핸들링하는 것으로 템플릿 등록이나 메시지 발송 param과는 무관하며, 참조 용도로 제공됩니다.

setViewAll

boolean

true

viewAll(모두보기) 활성화 여부를 지정합니다.

messagebaseform.params의 각 Object 내 setViewAll이 포함된 Object에서만 사용 가능하며, 사용될 수 없는 Object에서 사용 시 무시됩니다.

활성화 여부만 선택 가능하며, 활성화 시 viewAll의 글자수는 RBC 내부 로직에 의해 지정됩니다.

  • true: 메시지 내 대상 파라미터 viewAll(모두보기) 활성화

  • false: 메시지 내 대상 파라미터 viewAll(모두보기) 비활성화

※ viewAll은 메시지 내 문자열이 표시되는 영역에 설정된 글자수 이상이 입력된 경우, 대상 영역을 '모두보기 >' 표시와 함께 접힌 상태로 표시하는 메시지 규격입니다.

viewAll

integer

150

viewAll(모두보기) 접힘 글자수 기준값을 지정합니다.

messagebaseform.params의 각 Object 내 viewAll이 포함된 Object에서만 사용 가능하며, 사용될 수 없는 Object에서 사용 시 무시됩니다.

  • 유효값: 150(default), 300

  • 유효값 이외 수치가 입력되는 경우 default로 처리됩니다.

❖ response body sample

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

Previous템플릿 양식 목록 조회Next템플릿 양식 로고 이미지 조회

Last updated

Was this helpful?