템플릿 상세 조회

Request

브랜드에 등록된 지정 템플릿 상세 내역을 조회합니다.

get

브랜드에 등록된 지정 템플릿 상세 내역을 조회합니다.

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

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

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

Authorizations
Path parameters
brandIdstring · max: 13Required

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

messagebaseIdstringRequired

messagebase ID Path parameter 입니다.

Header parameters
X-RCS-Brandkeystring · max: 18Optional

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

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

get
GET /api/1.1/brand/{brandId}/messagebase/{messagebaseId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

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

array<object>

O

Messagebase 객체입니다.

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

result - array<object>

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

groupId

string

템플릿이 대량등록된 경우 그룹ID 입니다.

messagebaseId

string

40

O

템플릿 ID

tmpltName

string

40

템플릿 등록시 입력된 템플릿 명칭입니다.

messagebaseformId

string

40

O

템플릿의 원형인 템플릿 양식 ID 입니다.

brandId

string

O

템플릿이 등록되어 있는 브랜드 ID 입니다. 공통으로 사용하는 템플릿인 경우 'common'으로 표시됩니다.

status

string

템플릿의 상태를 표시합니다. ready : 사용 pause : 사용중지

approvalResult

string

템플릿의 승인 상태입니다.

  • 저장 : RCS Biz Center 홈페이지에서 템플릿 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 템플릿은 승인요청을 해야 승인대기 상태로 변경됩니다.

  • 승인대기 : 템플릿 등록 직후 검수 이전 상태입니다.

  • 검수시작 : 템플릿 검수가 시작된 상태입니다.

  • 승인 : 검수가 완료되어 이통3사에 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다.

  • 반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 템플릿은 수정 후 다시 승인요청 할 수 있습니다.

  • 검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다.

  • 승인대기(수정) : 승인된 템플릿 변경 승인요청 직후 검수 이전 상태입니다.

  • 검수시작(수정) : 승인된 템플릿 변경으로 승인요청된 템플릿 검수가 시작된 상태입니다.

  • 반려(수정) : 승인된 템플릿 변경 검수 처리 결과 반려된 상태입니다.

  • 검수완료(수정) : 승인된 브랜드 변경 검수 승인은 되었으나 이통3사 정보 등록이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 단말 브랜드 홈 정보가 다를 수 있습니다

approvalReason

string

승인 사유

registerDate

string

템플릿 등록일시

approvalDate

string

템플릿 승인일시

updateDate

string

템플릿 수정일시

registerId

string

20

템플릿 등록 계정 ID

updateId

string

20

템플릿 수정 계정 ID

productCode

string

O

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

spec

string

레이아웃 구조가 리치카드인지 오픈리치카드인지 구분합니다.

"richcard", "openrichcard"

cardType

string

64

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

  • standalone

  • standalone horizontal

  • standalone media top - carousel

  • carousel medium

  • carousel small

  • Highlighted Image n Title

  • Highlighted Image

  • Thumbnail

  • SNS

  • Description

  • Cell

  • Free

agencyId

string

20

템플릿을 대행사가 등록한 경우, 등록한 대행사ID 입니다.

inputText

string

300

정보성 텍스트 템플릿 서술(Description)인 경우, 템플릿 등록시 입력한 원본 문장을 제공합니다.

attribute

array<string>

통계용 속성 정보 제공 목적의 필드이며, messagebaseform의 [bizCondition, bizCategory, bizService] 로 구성된 배열입니다.

object

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

object

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

array<object>

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

array<object>

이미지 템플릿용 파일 등록 정보입니다.

formattedString

object

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

guideInfo - object

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

maxLineCount

integer

max 라인수

maxDisplayText

integer

버튼명 글자수

maxDescriptionSize

integer

카드별 max 본문 글자수

imageWidth

integer

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

imageHeight

integer

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

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 설정 여부를 지정합니다.

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로 처리됩니다.

files - array<object>

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

fileId

string

64

O

등록된 파일의 ID 입니다.

url

string

128

등록된 파일의 URL 정보 입니다.

fileName

string

256

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

imageWidth

integer

이미지 가로 크기 입니다.

imageHeight

integer

이미지 세로 크기 입니다.

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "groupId": null,
            "messagebaseId": "UBR.61hBmMP164-test2024062105",
            "tmpltName": "타이틀자유형-스타일",
            "messagebaseformId": "TATA001C",
            "brandId": "BR.61hBmMP164",
            "status": "ready",
            "approvalResult": "검수완료",
            "approvalReason": "",
            "registerDate": "2024-07-10T11:16:08.000+09",
            "approvalDate": "2024-07-10T11:24:26.000+09",
            "updateDate": "2024-07-10T11:24:26.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75",
            "productCode": "tmplt",
            "spec": "openrichcard",
            "cardType": "cell",
            "agencyId": null,
            "inputText": null,
            "attribute": [
                "인터넷/컴퓨터",
                "타이틀 자유형",
                "타이틀 자유형"
            ],
            "guideInfo": {
                "maxLineCount": 0,
                "maxDisplayText": 16,
                "maxDescriptionSize": 90,
                "imageWidth": "0",
                "imageHeight": "0",
                "detailInfo": null
            },
            "policyInfo": {
                "cardCount": 1,
                "maxTitleSize": 0,
                "maxButtonCount": 2,
                "maxDescriptionSize": 86,
                "maxMediaSize": 0,
                "buttonsAllowed": false,
                "adHeaderAllowed": false,
                "adBodyAllowed": true
            },
            "params": [
                {
                    "param": "2",
                    "isMandatory": true,
                    "type": "string",
                    "contentType": "cell",
                    "strSize": -1,
                    "fileSize": null,
                    "strRegx": null,
                    "verification": [],
                    "imageWidth": null,
                    "imageHeight": null,
                    "couplingId": null,
                    "inputText": null,
                    "relationId": null
                },
                {
                    "param": "3",
                    "isMandatory": true,
                    "type": "string",
                    "contentType": "cell",
                    "strSize": -1,
                    "fileSize": null,
                    "strRegx": null,
                    "verification": [],
                    "imageWidth": null,
                    "imageHeight": null,
                    "couplingId": null,
                    "inputText": null,
                    "relationId": null
                },
                {
                    "param": "5",
                    "isMandatory": true,
                    "type": "string",
                    "contentType": "cell",
                    "strSize": -1,
                    "fileSize": null,
                    "strRegx": null,
                    "verification": [],
                    "imageWidth": null,
                    "imageHeight": null,
                    "couplingId": null,
                    "inputText": null,
                    "relationId": null
                },
                {
                    "param": "c4",
                    "isMandatory": true,
                    "type": "string",
                    "contentType": "cell",
                    "strSize": -1,
                    "fileSize": null,
                    "strRegx": null,
                    "verification": [],
                    "imageWidth": null,
                    "imageHeight": null,
                    "couplingId": null,
                    "inputText": null,
                    "relationId": null
                },
                {
                    "param": "지점번호",
                    "isMandatory": true,
                    "type": "string",
                    "contentType": "etc",
                    "strSize": -1,
                    "fileSize": null,
                    "strRegx": null,
                    "verification": [],
                    "imageWidth": null,
                    "imageHeight": null,
                    "couplingId": null,
                    "inputText": null,
                    "relationId": null
                }
            ],
            "formattedString": {
                "RCSMessage": {
                    "trafficType": "advertisement",
                    "openrichcardMessage": {
                        "card": "open_rich_card",
                        "version": "1.0.0",
                        "zoomAllowed": true,
                        "scaleAllowed": true,
                        "layout": {
                            "widget": "LinearLayout",
                            "width": "match",
                            "height": "content",
                            "orientation": "vertical",
                            "children": [
                                {
                                    "widget": "LinearLayout",
                                    "width": "match",
                                    "height": "content",
                                    "orientation": "vertical",
                                    "padding": "20dp",
                                    "children": [
                                        {
                                            "widget": "LinearLayout",
                                            "width": "match",
                                            "height": "content",
                                            "orientation": "horizontal",
                                            "visibility": "visible",
                                            "children": [
                                                {
                                                    "widget": "TextView",
                                                    "width": "match",
                                                    "height": "content",
                                                    "textStyle": "bold",
                                                    "textAlignment": "textStart",
                                                    "text": "제목",
                                                    "textColor": "#232323",
                                                    "textSize": "19dp",
                                                    "weight": "1"
                                                },
                                                {
                                                    "widget": "TextView",
                                                    "width": "match",
                                                    "height": "content",
                                                    "textStyle": "bold",
                                                    "textAlignment": "textEnd",
                                                    "text": "",
                                                    "textColor": "#0094ff",
                                                    "textSize": "19dp",
                                                    "weight": "1",
                                                    "visibility": "gone"
                                                }
                                            ]
                                        },
                                        {
                                            "width": "match",
                                            "height": "3dp",
                                            "widget": "View",
                                            "background": "#232323",
                                            "visibility": "visible",
                                            "marginTop": "10dp",
                                            "marginBottom": "12dp"
                                        },
                                        {
                                            "width": "match",
                                            "height": "content",
                                            "widget": "LinearLayout",
                                            "orientation": "vertical",
                                            "children": [
                                                {
                                                    "width": "match",
                                                    "height": "content",
                                                    "widget": "LinearLayout",
                                                    "visibility": "visible",
                                                    "orientation": "horizontal",
                                                    "children": [
                                                        {
                                                            "text": "{{1}",
                                                            "width": "match",
                                                            "height": "content",
                                                            "weight": 1.0,
                                                            "widget": "TextView",
                                                            "textSize": "18dp",
                                                            "textColor": "#232329",
                                                            "textAlignment": "textStart",
                                                            "textStyle": "bold"
                                                        },
                                                        {
                                                            "text": "{{2}}",
                                                            "width": "match",
                                                            "height": "content",
                                                            "weight": 1.0,
                                                            "widget": "TextView",
                                                            "textSize": "16dp",
                                                            "textColor": "#232323",
                                                            "textAlignment": "textEnd"
                                                        }
                                                    ]
                                                },
                                                {
                                                    "width": "match",
                                                    "height": "content",
                                                    "widget": "LinearLayout",
                                                    "visibility": "visible",
                                                    "orientation": "horizontal",
                                                    "children": [
                                                        {
                                                            "text": "{{3}}",
                                                            "width": "match",
                                                            "height": "content",
                                                            "weight": 1.0,
                                                            "widget": "TextView",
                                                            "textSize": "20dp",
                                                            "textColor": "#122329",
                                                            "textAlignment": "textEnd",
                                                            "textStyle": "bold"
                                                        },
                                                        {
                                                            "text": "{{c4}}",
                                                            "width": "match",
                                                            "height": "content",
                                                            "weight": 1.0,
                                                            "widget": "TextView",
                                                            "textSize": "16dp",
                                                            "textColor": "#232323",
                                                            "textAlignment": "textEnd"
                                                        }
                                                    ]
                                                },
                                                {
                                                    "width": "match",
                                                    "height": "1dp",
                                                    "widget": "View",
                                                    "background": "#232323",
                                                    "visibility": "visible",
                                                    "marginTop": "12dp",
                                                    "marginBottom": "12dp"
                                                },
                                                {
                                                    "width": "match",
                                                    "height": "content",
                                                    "widget": "LinearLayout",
                                                    "visibility": "visible",
                                                    "orientation": "horizontal",
                                                    "children": [
                                                        {
                                                            "text": "{{5}}",
                                                            "width": "match",
                                                            "height": "content",
                                                            "weight": 1.0,
                                                            "widget": "TextView",
                                                            "textSize": "16dp",
                                                            "textColor": "#232323",
                                                            "textAlignment": "textStart"
                                                        }
                                                    ]
                                                }
                                            ]
                                        },
                                        {
                                            "widget": "LinearLayout",
                                            "width": "match",
                                            "height": "content",
                                            "orientation": "vertical",
                                            "children": [
                                                {
                                                    "widget": "Button",
                                                    "width": "match",
                                                    "height": "42dp",
                                                    "background": "#EAEAEA",
                                                    "textColor": "#0094ff",
                                                    "textSize": "16dp",
                                                    "text": "고객센터",
                                                    "textStyle": "normal",
                                                    "textAlignment": "center",
                                                    "click": {
                                                        "action": {
                                                            "dialerAction": {
                                                                "dialPhoneNumber": {
                                                                    "phoneNumber": "1522{{지점번호}}"
                                                                }
                                                            },
                                                            "displayText": "고객센터",
                                                            "postback": {
                                                                "data": "set_by_chatbot_dial_phone_number"
                                                            }
                                                        }
                                                    },
                                                    "corner_radius": "8dp",
                                                    "visibility": "visible",
                                                    "marginTop": "12dp"
                                                },
                                                {
                                                    "widget": "Button",
                                                    "width": "match",
                                                    "height": "42dp",
                                                    "background": "#EAEAEA",
                                                    "textColor": "#0094ff",
                                                    "textSize": "16dp",
                                                    "text": "{{btnName2}}",
                                                    "textStyle": "normal",
                                                    "textAlignment": "center",
                                                    "click": {
                                                        "action": {
                                                            "urlAction": {
                                                                "openUrl": {
                                                                    "url": ""
                                                                }
                                                            },
                                                            "displayText": "dummy"
                                                        }
                                                    },
                                                    "corner_radius": "8dp",
                                                    "visibility": "gone",
                                                    "marginTop": "8dp"
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    }
                }
            }
        }
    ],
    "status": 200
}
{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

Last updated

Was this helpful?