브랜드 목록 조회

Request

마스터 또는 매니저 계정으로 운영 권한이 있는 브랜드 목록을 조회합니다.

get

https://api-qa.rcsbizcenter.com/api/1.1https://api.rcsbizcenter.com/api/1.1

/corp/{personId}/brand

마스터 또는 매니저 계정으로 운영 권한이 있는 브랜드 목록을 조회합니다.

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

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

Authorizations

jwtAuth

AuthorizationstringRequired

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

Path parameters

personIdstring · max: 20Required

maxLength: 20 - 브랜드 대표운영자 또는 운영자의 계정(마스터, 매니저) ID 입니다.

Query parameters

offsetintegerOptional

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

Default: 0

limitinteger · min: 100 · max: 1000Optional

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

Default: 100

Responses

200

페이지 내 Response 섹션 참조

No content

get

/corp/{personId}/brand

HTTPcURLJavaScriptPython

GET /api/1.1/corp/{personId}/brand HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

페이지 내 Response 섹션 참조

No content

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		브랜드 기본 정보 객체입니다.
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>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13	O		브랜드ID - 브랜드 등록 시 자동 생성됩니다.
name	string	20	O		브랜드 이름 - 브랜드 등록 시 지정합니다.
brandKey	string	18			브랜드 Key - 브랜드 등록 시 자동 생성됩니다.
registerDate	string				등록일시 - 브랜드 등록 일시입니다.
approvalDate	string				승인일시 - 브랜드가 검수에서 승인된 일시입니다.
updateDate	string				수정일시 - 브랜드의 정보가 수정된 일시입니다.
status					브랜드의 상태 입니다. 저장 : RCS Biz Center 홈페이지에서 브랜드 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 브랜드는 승인요청을 해야 승인대기 상태로 변경됩니다. 승인대기 : 브랜드 등록 직후 검수 이전 상태입니다. 검수시작 : 브랜드 검수가 시작된 상태입니다. 승인 : 검수가 완료되어 이통3사에 브랜드 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다. 반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 브랜드는 수정 후 다시 승인요청 할 수 있습니다. 검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다. 승인대기(수정) : 승인된 브랜드 변경 시 검수 대상으로 판단되어 검수 요청된 상태입니다. 검수시작(수정) : 승인된 브랜드 변경으로 승인요청된 브랜드 검수가 시작된 상태입니다. 반려(수정) : 승인된 브랜드 변경 검수 처리 결과 반려된 상태입니다. 검수완료(수정) : 승인된 브랜드 변경 검수 승인은 되었으나 이통3사 정보 등록이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 단말 브랜드 홈 정보가 다를 수 있습니다. 브랜드 조회 API 호출 시 수정 이전 브랜드 정보가 제공됩니다.
mediaUrl	array<object>				이미지 파일ID와 URL 및 사용 유형 정보를 제공합니다.
chatbotDate	string				브랜드 내 등록된 대화방 중 가장 최근에 변경된 대화방의 일시 정보 입니다.
messagebaseDate	string				브랜드 내 등록된 템플릿 중 가장 최근에 변경된 템플릿의 일시 정보 입니다.
logoDate	string				로고이미지 수정일

mediaUrl - array<object>

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

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": [
        {
            "brandId": "BR.i3gC1762pT",
            "name": "테스트브랜드",
            "brandKey": "BK.2G3Dar9X4j0yCEb",
            "status": "승인",
            "chatbotDate": null,
            "messagebaseDate": "2024-05-17T17:48:07.000+09",
            "logoDate": null,
            "registerDate": "2024-05-17T17:48:07.000+09",
            "updateDate": "2024-05-17T17:49:24.000+09",
            "approvalDate": "2024-05-17T17:49:24.000+09",
            "mediaUrl": [
                {
                    "fileId": "LT-common-1WUqPj",
                    "fileName": "통신.png",
                    "url": "https://file-dev.rcsbizcenter.com/brand/common/LT-common-1WUqPj_1.png",
                    "typeName": "background"
                },
                {
                    "fileId": "LT-common-1WUqPj",
                    "fileName": "통신.png",
                    "url": "https://file-dev.rcsbizcenter.com/brand/common/LT-common-1WUqPj_1.png",
                    "typeName": "profile"
                }
            ]
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 1
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

400

401

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