템플릿 목록 조회

Request

브랜드에 등록된 템플릿을 조회합니다.

브랜드에 등록된 템플릿을 조회합니다. 템플릿 별 승인 상태를 확인할 수 있습니다.

• 계정 권한: 마스터, 매니저, 대행사
• 브랜드 권한: 브랜드 대표운영자, 운영자
• 지원 범위: 텍스트 템플릿(타이틀 선택형 / 타이틀 자유형), 이미지 템플릿, LMS 템플릿

get

/brand/{brandId}/messagebase

Authorizations

Path parameters

brandIdstring · max: 13required

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

Query parameters

offsetinteger · default: 0

시작 offset 번호(default: 0) 입니다.

limitinteger · min: 100 · max: 1000 · default: 100

조회 최대 건수(default: 100, maximum: 1000) 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

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

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/messagebase' \
  --header 'Authorization: Bearer JWT'

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		Messagebase 기본 정보입니다.
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O
pagination	object		O		전체 건수와 페이징 조건을 제공합니다.
links	object		O		이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
groupId	string				템플릿이 대량등록된 경우 그룹ID 입니다.
messagebaseId	string				템플릿 ID
tmpltName	string				템플릿 등록시 입력된 템플릿 명칭입니다.
messagebaseformId	string				템플릿의 원형인 템플릿 양식 ID 입니다.
brandId	string				템플릿이 등록되어 있는 브랜드 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				템플릿 등록 계정 ID
updateId	string				템플릿 수정 계정 ID

pagination - object

필드명	타입	길이	필수여부	기본값	설명
total	integer		O		전체건수
offset	integer		O	0	조회 기준 위치
limit	integer		O	100	페이지 당 조회 건수

links - object

필드명	타입	길이	필수여부	기본값	설명
prev	string		O		이전페이지URL
next	string		O		다음페이지URL

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "groupId": null,
            "messagebaseId": "IBR.u720xwadx0-test20240620",
            "tmpltName": "SNS형 (중간버튼)",
            "messagebaseformId": "ITCRM3",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:33:23.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:33:23.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "IBR.u720xwadx0-test2024062010",
            "tmpltName": "이미지 강조형 (1:1)",
            "messagebaseformId": "ITHIMS",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:22:36.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:22:36.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "IBR.u720xwadx0-test2024062006",
            "tmpltName": "SNS형 (중간버튼)",
            "messagebaseformId": "ITSNSH",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:17:01.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:17:01.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test2024062004",
            "tmpltName": "썸네일형 (가로)",
            "messagebaseformId": "TATA001D",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:11:34.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:11:34.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "IBR.u720xwadx0-test2024062002",
            "tmpltName": "이미지 강조형 (1:1)",
            "messagebaseformId": "ITHITS",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:08:06.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:08:06.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "IBR.u720xwadx0-test2024062001",
            "tmpltName": "이미지 & 타이틀 강조형 (1:1)",
            "messagebaseformId": "ITHITS",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-20T10:01:14.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-20T10:01:14.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test2022072606",
            "tmpltName": "테마 강조형A 서술",
            "messagebaseformId": "TATA001C",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-19T11:11:39.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-19T11:11:39.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test2024061905",
            "tmpltName": "테마 강조형A 서술",
            "messagebaseformId": "TATA001D",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-19T11:06:48.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-19T11:06:48.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test202406183",
            "tmpltName": "테스트-출고(Cell)",
            "messagebaseformId": "CC001C",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": null,
            "registerDate": "2024-06-19T10:12:05.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-19T10:12:05.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test2024061901",
            "tmpltName": "인증desc",
            "messagebaseformId": "GG002D",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": null,
            "registerDate": "2024-06-19T10:06:02.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-19T10:06:02.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-60JruEbrS2kBP55tU9SLWW3p5",
            "tmpltName": "승인내역",
            "messagebaseformId": "FF001C",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-18T18:03:47.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-18T18:03:47.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-3p807611jWP61Rn1BlBMPA095",
            "tmpltName": "승인번호템플릿",
            "messagebaseformId": "TATA001D",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": "승인대기(신규)",
            "registerDate": "2024-06-18T17:47:44.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-18T17:47:44.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        },
        {
            "groupId": null,
            "messagebaseId": "UBR.u720xwadx0-test2022072604",
            "tmpltName": "테마 강조형A 서술",
            "messagebaseformId": "TATA001D",
            "brandId": "BR.u720xwadx0",
            "status": "ready",
            "approvalResult": "승인대기",
            "approvalReason": null,
            "registerDate": "2024-06-18T17:38:07.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-18T17:38:07.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 13
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

400

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "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 참조