# 브랜드 목록 조회

## Request

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

> 마스터 또는 매니저 계정으로 운영 권한이 있는 브랜드 목록을 조회합니다.  \
> &#x20; \+ \*\*계정 권한 : 마스터, 매니저\*\*\
> &#x20; \+ \*\*브랜드 권한 : 브랜드 대표운영자, 운영자\*\*<br>

```json
{"openapi":"3.0.0","info":{"title":"RCS Biz Center API 규격","version":"1.1.12"},"servers":[{"description":"RCS Biz Center API for Staging","url":"https://api-qa.rcsbizcenter.com/api/1.1"},{"description":"RCS Biz Center API for Production","url":"https://api.rcsbizcenter.com/api/1.1"}],"security":[{"jwtAuth":[]}],"components":{"securitySchemes":{"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.\n"}},"parameters":{"PersonId":{"name":"personId","in":"path","description":"maxLength: 20 - 브랜드 대표운영자 또는 운영자의 계정(마스터, 매니저) ID 입니다.\n","schema":{"type":"string","maxLength":20},"required":true},"Offset":{"name":"offset","in":"query","schema":{"type":"integer","default":0},"description":"시작 offset 번호(default: 0) 입니다."},"Limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":100,"maximum":1000,"default":100},"description":"minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'\n"}}},"paths":{"/corp/{personId}/brand":{"get":{"summary":"마스터 또는 매니저 계정으로 운영 권한이 있는 브랜드 목록을 조회합니다.\n","description":"마스터 또는 매니저 계정으로 운영 권한이 있는 브랜드 목록을 조회합니다.  \n  + **계정 권한 : 마스터, 매니저**\n  + **브랜드 권한 : 브랜드 대표운영자, 운영자**\n","parameters":[{"$ref":"#/components/parameters/PersonId"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"}],"responses":{"200":{"description":"페이지 내 Response 섹션 참조"}}}}}}
```

## **Response**

<table data-full-width="true"><thead><tr><th width="147">필드명</th><th width="141">타입</th><th width="68" align="center">길이</th><th width="108" align="center">필수여부</th><th width="120">기본값</th><th>설명</th></tr></thead><tbody><tr><td><a href="#result-array-less-than-object-greater-than"><mark style="color:blue;"><strong><code>result</code></strong></mark></a></td><td>array&#x3C;object></td><td align="center"></td><td align="center">O</td><td></td><td>브랜드 기본 정보 객체입니다.</td></tr><tr><td><strong><code>code</code></strong></td><td>string</td><td align="center">5</td><td align="center">O</td><td>20000000</td><td></td></tr><tr><td><strong><code>status</code></strong></td><td>integer</td><td align="center">3</td><td align="center">O</td><td>200</td><td></td></tr><tr><td><strong><code>desc</code></strong></td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td></td></tr><tr><td><a href="#pagination-object"><mark style="color:blue;"><strong><code>pagination</code></strong></mark></a></td><td>object</td><td align="center"></td><td align="center">O</td><td></td><td>전체 건수와 페이징 조건을 제공합니다.</td></tr><tr><td><a href="#links-object"><mark style="color:blue;"><strong><code>links</code></strong></mark></a></td><td>object</td><td align="center"></td><td align="center">O</td><td></td><td>이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.</td></tr></tbody></table>

### <mark style="color:blue;">result</mark> - array\<object>

<table data-full-width="true"><thead><tr><th width="197">필드명</th><th width="144">타입</th><th width="86" align="center">길이</th><th width="108" align="center">필수여부</th><th width="84">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>brandId</code></strong></td><td>string</td><td align="center">13</td><td align="center">O</td><td></td><td>브랜드ID - 브랜드 등록 시 자동 생성됩니다.</td></tr><tr><td><strong><code>name</code></strong></td><td>string</td><td align="center">20</td><td align="center">O</td><td></td><td>브랜드 이름 - 브랜드 등록 시 지정합니다.</td></tr><tr><td><strong><code>brandKey</code></strong></td><td>string</td><td align="center">18</td><td align="center"></td><td></td><td>브랜드 Key - 브랜드 등록 시 자동 생성됩니다.</td></tr><tr><td><strong><code>registerDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>등록일시 - 브랜드 등록 일시입니다.</td></tr><tr><td><strong><code>approvalDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>승인일시 - 브랜드가 검수에서 승인된 일시입니다.</td></tr><tr><td><strong><code>updateDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>수정일시 - 브랜드의 정보가 수정된 일시입니다.</td></tr><tr><td><strong><code>status</code></strong></td><td></td><td align="center"></td><td align="center"></td><td></td><td><p>브랜드의 상태 입니다.</p><ul><li>저장 : RCS Biz Center 홈페이지에서 브랜드 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 브랜드는 승인요청을 해야 승인대기 상태로 변경됩니다.</li><li>승인대기 : 브랜드 등록 직후 검수 이전 상태입니다.</li><li>검수시작 : 브랜드 검수가 시작된 상태입니다.</li><li>승인 : 검수가 완료되어 이통3사에 브랜드 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다.</li><li>반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 브랜드는 수정 후 다시 승인요청 할 수 있습니다.</li><li>검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다.</li><li>승인대기(수정) : 승인된 브랜드 변경 시 검수 대상으로 판단되어 검수 요청된 상태입니다.</li><li>검수시작(수정) : 승인된 브랜드 변경으로 승인요청된 브랜드 검수가 시작된 상태입니다.</li><li>반려(수정) : 승인된 브랜드 변경 검수 처리 결과 반려된 상태입니다.</li><li>검수완료(수정) : 승인된 브랜드 변경 검수 승인은 되었으나 이통3사 정보 등록이 완료되지 않은 상태입니다.<br>현재 상태에서는 이통사에 따라 단말 브랜드 홈 정보가 다를 수 있습니다.<br>브랜드 조회 API 호출 시 수정 이전 브랜드 정보가 제공됩니다.</li></ul></td></tr><tr><td><a href="#mediaurl-array-less-than-object-greater-than"><mark style="color:blue;"><strong><code>mediaUrl</code></strong></mark></a></td><td>array&#x3C;object></td><td align="center"></td><td align="center"></td><td></td><td>이미지 파일ID와 URL 및 사용 유형 정보를 제공합니다.</td></tr><tr><td><strong><code>chatbotDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>브랜드 내 등록된 대화방 중 가장 최근에 변경된 대화방의 일시 정보 입니다.</td></tr><tr><td><strong><code>messagebaseDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>브랜드 내 등록된 템플릿 중 가장 최근에 변경된 템플릿의 일시 정보 입니다.</td></tr><tr><td><strong><code>logoDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>로고이미지 수정일</td></tr></tbody></table>

### <mark style="color:blue;">mediaUrl</mark> - array\<object>

<table data-full-width="true"><thead><tr><th width="142">필드명</th><th width="89">타입</th><th width="91" align="center">길이</th><th width="104" align="center">필수여부</th><th width="90">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>fileId</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td></td></tr><tr><td><strong><code>url</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td></td></tr><tr><td><strong><code>typeName</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td><p>이미지의 사용 유형을 구분합니다.</p><ul><li>icon - 템플릿 양식 아이콘 이미지</li><li>profile - 브랜드 프로필 이미지</li><li>background - 브랜드 백그라운드 이미지</li></ul></td></tr><tr><td><strong><code>fileName</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>등록한 파일의 이름입니다.</td></tr></tbody></table>

### <mark style="color:blue;">pagination</mark> - object

<table data-full-width="true"><thead><tr><th width="143">필드명</th><th width="91">타입</th><th width="98" align="center">길이</th><th width="112" align="center">필수여부</th><th width="93">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>total</code></strong></td><td>integer</td><td align="center"></td><td align="center">O</td><td></td><td>전체건수</td></tr><tr><td><strong><code>offset</code></strong></td><td>integer</td><td align="center"></td><td align="center">O</td><td>0</td><td>조회 기준 위치</td></tr><tr><td><strong><code>limit</code></strong></td><td>integer</td><td align="center"></td><td align="center">O</td><td>100</td><td>페이지 당 조회 건수</td></tr></tbody></table>

### <mark style="color:blue;">links</mark> - object

<table data-full-width="true"><thead><tr><th width="145">필드명</th><th width="89">타입</th><th width="99" align="center">길이</th><th width="112" align="center">필수여부</th><th width="90">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>prev</code></strong></td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td>이전페이지URL</td></tr><tr><td><strong><code>next</code></strong></td><td>string</td><td align="center"></td><td align="center">O</td><td></td><td>다음페이지URL</td></tr></tbody></table>

### ❖ response body sample

{% tabs %}
{% tab title="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
}
```

{% endtab %}

{% tab title="400" %}

```
{
    "error": {
        "code": "64104",
        "message": "Invalid personId on path parameter"
    },
    "status": 400
}
```

{% endtab %}

{% tab title="401" %}

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

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
error code는 [RCS Biz Center - Response body error code](https://apidocs.rcsbizcenter.com/error_code#rcs-biz-center-response-body-error-code) 참조
{% endhint %}