# 양방향 대화방 목록 조회

## Request

## 브랜드에 등록된 대화방(양방향) 목록을 조회합니다.<br>

> 브랜드에 등록된 양방향ID 또는 대화방메뉴, 양방향 대행사가 연결된 대화방 목록을 조회합니다.  \
> \
> &#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":{"BrandKey":{"name":"X-RCS-Brandkey","in":"header","schema":{"type":"string","maxLength":18},"description":"maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.  \n\n대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다.\n따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.\n"},"BrandId":{"name":"brandId","in":"path","schema":{"type":"string","maxLength":13},"required":true,"description":"maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.\n"},"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":{"/brand/{brandId}/bidirectional/chatbot":{"get":{"summary":"브랜드에 등록된 대화방(양방향) 목록을 조회합니다.\n","description":"브랜드에 등록된 양방향ID 또는 대화방메뉴, 양방향 대행사가 연결된 대화방 목록을 조회합니다.  \n\n  + **계정 권한 : 마스터, 매니저, 대행사**  \n  + **브랜드 권한 : 브랜드 대표운영자, 운영자**\n","parameters":[{"$ref":"#/components/parameters/BrandKey"},{"$ref":"#/components/parameters/BrandId"},{"$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="219">필드명</th><th width="141">타입</th><th width="68" align="center">길이</th><th width="108" align="center">필수여부</th><th width="91">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>groupId</code></strong></td><td>string</td><td align="center">10</td><td align="center"></td><td></td><td>대화방이 대량등록된 경우 그룹ID 입니다.</td></tr><tr><td><strong><code>chatbotId</code></strong></td><td>string</td><td align="center">15</td><td align="center">O</td><td></td><td>대화방(발신번호)ID, A2P의 경우 발신번호(mdn)과 동일합니다.</td></tr><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>subNum</code></strong></td><td>string</td><td align="center">40</td><td align="center"></td><td></td><td>회신번호 A2P의 경우 발신번호, 즉 chatbotId와 동일합니다.</td></tr><tr><td><strong><code>isMainNum</code></strong></td><td>boolean</td><td align="center"></td><td align="center"></td><td></td><td>대표번호 개념은 더 이상 유효하지 않습니다. 브랜드에 등록된 대화방 중 유효한 첫번째 대화방이 표시됩니다.</td></tr><tr><td><strong><code>subTitle</code></strong></td><td>string</td><td align="center">20</td><td align="center"></td><td></td><td>대화방명입니다.</td></tr><tr><td><strong><code>service</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td>a2p</td><td><p>대화방 유형입니다.</p><ul><li>a2p : 발신번호를 이용한 대화방</li><li>chat : 양방향ID를 이용한 대화방</li></ul></td></tr><tr><td><strong><code>display</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td><p>단말에서 대화방의 검색 및 RCS대화방 노출 여부를 설정합니다.<br>브랜드홈 전시로 설정되면 대화방은 RCS메시지 수신이 가능하게 되며, 반대로 브랜드홈 비전시 설정 시에는 RCS메시지 수신이 불가능합니다.</p><ul><li>'11' : 브랜드채널 노출 및 브랜드검색 허용 &#x26; 브랜드홈 전시</li><li>'10' : 브랜드채널 노출 및 브랜드검색 허용 &#x26; 브랜드홈 비전시</li><li>'01' : 브랜드채널 노출 및 브랜드검색 불허 &#x26; 브랜드홈 전시</li><li>'00' : 브랜드채널 노출 및 브랜드검색 불허 &#x26; 브랜드홈 비전시</li></ul></td></tr><tr><td><strong><code>inputField</code></strong></td><td>integer</td><td align="center"></td><td align="center"></td><td>1</td><td><p>단말 대화방에서 사용자 입력창을 활성화 또는 비활성화 합니다.</p><ul><li>0 : 비활성화</li><li>1 : 활성화</li></ul></td></tr><tr><td><strong><code>subDescr</code></strong></td><td>string</td><td align="center">50</td><td align="center"></td><td></td><td>대화방 검색 시 노출되는 소개글을 입력할 수 있습니다.</td></tr><tr><td><strong><code>botAgencyId</code></strong></td><td>string</td><td align="center">20</td><td align="center"></td><td></td><td>양방향 대화방 서비스 계약 관계에 있는 대행사ID(중계사)로 자동응답메시지 과금 및 챗봇 연동에 사용됩니다.</td></tr><tr><td><strong><code>saftyStatusYn</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td>Y</td><td><p>안심마크 지정된 기업에 한하여, 대화방의 안심마크 표시 여부를 지정합니다.</p><ul><li>Y : 안심마크 표시</li><li>N : 안심마크 미표시</li></ul></td></tr><tr><td><strong><code>psMenuUse</code></strong></td><td>boolean</td><td align="center"></td><td align="center"></td><td>false</td><td><p>대화방메뉴 사용 여부입니다.</p><ul><li>true : 사용</li><li>false : 미사용</li></ul></td></tr><tr><td><strong><code>approvalResult</code></strong></td><td>string</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>검수완료(수정) : 승인된 대화방의 이름을 변경하였으나 이통3사 정보 등록이 완료되지 않은 상태입니다.<br>현재 상태에서는 이통사에 따라 단말 표시 대화방 이름이 다를 수 있습니다.</li></ul></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>registerId</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>대화방 등록 계정 ID</td></tr><tr><td><strong><code>updateId</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>대화방 수정 계정 ID</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": [
        {
            "groupId": null,
            "chatbotId": "15330001",
            "brandId": "BR.u720xwadx0",
            "subNum": "15330001",
            "isMainNum": false,
            "subTitle": "테스트대화방",
            "service": "a2p",
            "display": "01",
            "inputField": 1,
            "subDescr": "테스트용 대화방입니다.",
            "botAgencyId": null,
            "saftyStatusYn": "N",
            "psMenuUse": false,
            "approvalResult": "저장",
            "registerDate": null,
            "approvalDate": null,
            "updateDate": "2024-06-25T11:08:10.000+09",
            "registerId": "hong",
            "updateId": "hong"
        },
        {
            "groupId": null,
            "chatbotId": "15330000",
            "brandId": "BR.u720xwadx0",
            "subNum": "15330000",
            "isMainNum": false,
            "subTitle": "테스트대화방",
            "service": "a2p",
            "display": "01",
            "inputField": 1,
            "subDescr": "테스트용 대화방입니다.",
            "botAgencyId": null,
            "saftyStatusYn": "N",
            "psMenuUse": false,
            "approvalResult": "저장",
            "registerDate": null,
            "approvalDate": null,
            "updateDate": "2024-06-25T11:08:29.000+09",
            "registerId": "hong",
            "updateId": "hong"
        },
        {
            "groupId": null,
            "chatbotId": "bot-l4tid2078py",
            "brandId": "BR.u720xwadx0",
            "subNum": "07082245290",
            "isMainNum": false,
            "subTitle": "테스트입니다.",
            "service": "chat",
            "display": "11",
            "inputField": 1,
            "subDescr": "소개입니다.",
            "botAgencyId": "twRcsCorpAgency",
            "saftyStatusYn": "N",
            "psMenuUse": false,
            "approvalResult": "승인",
            "registerDate": "2024-06-25T17:57:57.000+09",
            "approvalDate": "2024-06-25T17:58:17.000+09",
            "updateDate": "2024-06-25T17:58:15.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}
```

{% endtab %}

{% tab title="400" %}

```
{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}
```

{% endtab %}

{% tab title="401" %}

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

{% endtab %}

{% tab title="403" %}

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

{% 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 %}