대행사 브랜드 상세 조회

Request

계약된 브랜드 정보를 개별 조회 합니다.

계약된 브랜드 정보를 개별 조회 합니다.
승인된 브랜드만 조회가 가능합니다.

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

get

/agency/{agencyId}/brand/{brandId}

Authorizations

Path parameters

agencyIdstring · max: 20required

maxLength: 20 - RCS Biz Center에 등록된 대행사 ID 입니다.

brandIdstring · max: 13required

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

cURL

JavaScript

Python

HTTP

cURL

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

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		브랜드 상세 정보 객체입니다.
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13	O		브랜드ID - 브랜드 등록 시 자동 생성됩니다.
name	string	20	O		브랜드 이름 - 브랜드 등록 시 지정합니다.
brandKey	string	18			브랜드 Key - 브랜드 등록 시 자동 생성됩니다.
registerDate	string				등록일시 - 브랜드 등록 일시입니다.
approvalDate	string				승인일시 - 브랜드가 검수에서 승인된 일시입니다.
updateDate	string				수정일시 - 브랜드의 정보가 수정된 일시입니다.
status	string				브랜드의 상태 입니다. 저장 : RCS Biz Center 홈페이지에서 브랜드 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 브랜드는 승인요청을 해야 승인대기 상태로 변경됩니다. 승인대기 : 브랜드 등록 직후 검수 이전 상태입니다. 검수시작 : 브랜드 검수가 시작된 상태입니다. 승인 : 검수가 완료되어 이통3사에 브랜드 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다. 반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 브랜드는 수정 후 다시 승인요청 할 수 있습니다. 검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다. 승인대기(수정) : 승인된 브랜드 변경 시 검수 대상으로 판단되어 검수 요청된 상태입니다. 검수시작(수정) : 승인된 브랜드 변경으로 승인요청된 브랜드 검수가 시작된 상태입니다. 반려(수정) : 승인된 브랜드 변경 검수 처리 결과 반려된 상태입니다. 검수완료(수정) : 승인된 브랜드 변경 검수 승인은 되었으나 이통3사 정보 등록이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 단말 브랜드 홈 정보가 다를 수 있습니다. 브랜드 조회 API 호출 시 수정 이전 브랜드 정보가 제공됩니다.
mediaUrl	array<object>				이미지 파일ID와 URL 및 사용 유형 정보를 제공합니다.
chatbotDate	string				브랜드 내 등록된 대화방 중 가장 최근에 변경된 대화방의 일시 정보 입니다.
messagebaseDate	string				브랜드 내 등록된 템플릿 중 가장 최근에 변경된 템플릿의 일시 정보 입니다.
description	string	150			브랜드 설명에 등록된 내용입니다.
tel	string	12			브랜드홈에 노출될 전화번호(대표발신번호와 별개) 입니다.
menus	array<object>	3			브랜드 홈에는 최대 4개까지 표시됩니다. chat은 기본 등록 되므로 지정할 수 있는 최대 menu는 3개이며, 등록 시 call을 포함하지 않고 2개 이하 지정할 경우 call을 기본 추가합니다.
categoryId	string	64			브랜드 카테고리 ID 입니다.
categoryName	string	64			브랜드 카테고리 명 입니다.
subCategoryId	string	64			브랜드 하위 카테고리 ID 입니다.
subCategoryName	string	64			브랜드 하위 카테고리 명 입니다.
categoryOpt	string	20			검색용 키워드 임의 등록 할 수 있습니다.
zipCode	string	5			브랜드 홈에 표시될 우편번호(5자리) 입니다.
roadAddress	string	200			브랜드 홈에 표시되는 도로명주소 입니다.
detailAddress	string	200			브랜드 홈에 표시되는 상세주소 입니다.
email	string	30			브랜드 홈에 표시되는 이메일주소 입니다.
webSiteUrl	string	128			브랜드 홈에 표시되는 홈페이지 주소 입니다.
approvalReason	string				검수 시 반려 사유가 제공됩니다.
brandFeedUrl	string				브랜드 소식 URL 입니다. 브랜드 소식을 최초 등록하거나 브랜드 홈 기본 탭을 소식탭(FEED)로 설정하면 자동 생성됩니다.
initTab	string	5		FEED	단말에 표시되는 브랜드 홈의 기본 탭을 지정하는 항목입니다. 미지정 시 기본값은 FEED 입니다. FEED: 소식탭을 기본 탭으로 지정합니다. INFO: 정보탭을 기본 탭으로 지정합니다. 브랜드 최초 승인 시에만 선택이 가능하며 승인 이후에는 수정이 불가합니다.
initFeedItem	array<object>	6			하위 호환성을 위해 필드는 유지되지만, 동일한 용도의 initFeedItems 사용을 권고합니다. TEL: 소식탭에 전화걸기(=퀵버튼 call) 버튼이 표시됩니다. HOME: 소식탭에 Web 연결(=퀵버튼 web) 버튼이 표시됩니다. SEARCH: 소식탭에 포털검색 버튼이 표시되며, 소식탭 전용 퀵버튼입니다.
initFeedItems	string				initTab FEED인 경우, 소식탭에 표시할 메뉴를 지정합니다. menus에서 설정한 항목 중 소식탭에 표시할 항목을 지정합니다. 즉, menus에 지정되지 않은 항목을 설정하면 error 처리 됩니다. menus는 최대 3개까지 지정할 수 있으며, menus에 설정한 3개항목과 소식탭에만 표시가능한 portalsearch를 추가로 등록할 경우 최대 4개가 등록됩니다. "call", "web", "store", "order", "buy", "tickets", "moreinfo", "portalsearch"
templateColor	string	10			브랜드 내 등록되는 템플릿의 버튼 컬러 값을 지정합니다. 컬러값은 Hex code 형식만 유효합니다.
bizInfoYn	string			N	브랜드 소식탭에 운영정보 사용 여부를 설정합니다.
bizInfoTitle	string	20			bizInfoYn = 'Y'인 경우, 운영정보 제목을 지정합니다.
bizInfoContent	string	200			bizInfoYn = 'Y'인 경우, 운영정보 내용을 지정합니다.
saftyStatusYn	string			N	안심마크 지정 기업 여부를 표시합니다. Y : 안심마크 지정 N : 안심마크 미지정

mediaUrl - array<object>

필드명	타입	길이	필수여부	기본값	설명
fileId	string
url	string
typeName	string				이미지의 사용 유형을 구분합니다. icon - 템플릿 양식 아이콘 이미지 profile - 브랜드 프로필 이미지 background - 브랜드 백그라운드 이미지
fileName	string	256			등록한 파일의 이름입니다.

menus - array<object>

필드명	타입	길이	필수여부	기본값	설명
buttonType	string	20	O		버튼 유형 "call", "web", "app", "store", "order", "buy", "tickets", "moreinfo"
applink	array<object>				APP Link의 패키지 Name, Action, URL 정보 객체입니다.
weblink	string				buttonType call 을 제외한 모든 버튼은 Web URL을 입력해야 합니다. URL은 http:// 또는 https:// 로 시작하여야 합니다.

applink - array<object>

필드명	타입	길이	필수여부	기본값	설명
packageName	string	40	O		App 실행을 위한 package name
action	string	40	O		App 실행을 위한 Action
url	string	40	O		App 실행을 위한 URI

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "brandId": "BR.i3gC1762pT",
            "name": "테스트브랜드",
            "brandKey": "BK.2G3Dar9X4j0yCEb",
            "status": "검수완료(수정)",
            "chatbotDate": "2024-06-05T15:27:17.000+09",
            "messagebaseDate": "2024-06-05T15:27:21.000+09",
            "logoDate": null,
            "registerDate": "2024-05-17T17:48:07.000+09",
            "updateDate": "2024-06-10T10:16:59.000+09",
            "approvalDate": "2024-06-10T10:16:59.000+09",
            "mediaUrl": [
                {
                    "fileId": "LT-common-1WUqPj",
                    "fileName": "통신.png",
                    "url": "https://file-dev.rcsbizcenter.com/brand/common/LT-common-1WUqPj_1.png",
                    "typeName": "profile"
                }
            ],
            "menus": [
                {
                    "buttonType": "tickets",
                    "weblink": "http://www.naver.com",
                    "feedinfoYn": "N"
                }
            ],
            "description": "테스트브랜드",
            "tel": "30000800",
            "categoryId": "EDU",
            "categoryName": "교육",
            "subCategoryId": "EDU007",
            "subCategoryName": "유학/연수",
            "categoryOpt": null,
            "zipCode": "55110",
            "roadAddress": "서울특별시",
            "detailAddress": "109-5",
            "email": "[e-mail]",
            "webSiteUrl": "http://www.google.com",
            "brandFeedUrl": "https://biz-dev.chatplus.co.kr/brand/BR.i3gC1762pT",
            "initTab": "INFO",
            "initFeedItems": [],
            "templateColor": null,
            "bizInfoYn": "N",
            "bizInfoTitle": null,
            "bizInfoContent": null,
            "saftyStatusYn": "N"
        }
    ],
    "status": 200
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

{
    "error": {
        "code": "61005",
        "message": "Invalid client id"
    },
    "status": 401
}

{
    "error": {
        "code": "61007",
        "message": "not allowed IP. unregistered 0.0.0.0"
    },
    "status": 401
}

403

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

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