> For the complete documentation index, see [llms.txt](https://apidocs.rcsbizcenter.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.rcsbizcenter.com/rbc-api/bidirect_agency/put_bidirect_chatbot_pause.md).

# 대화방 메뉴 사용 차단

## Request

## 중계사만 사용이 가능하며, 양방향 대화방의 대화방메뉴 사용을 중지 또는 재개합니다.<br>

> 양방향 대화방에 대화방메뉴 사용을 중지 또는 재개합니다.  \
> 양방향 대화방에 등록된 중계사만 사용이 가능합니다.  \
> 과금 미납 발생 등 특이사항이 발생한 경우 사용하며 대화방메뉴 중지에 대한 정보가 사용자에게 RBC 홈페이지에서 표시됩니다.  <br>

```json
{"openapi":"3.0.0","info":{"title":"RCS Biz Center API 규격","version":"1.1.15"},"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"},"ChatbotId":{"name":"chatbotId","in":"path","description":"브랜드 내 대화방 정보 접근시 사용되는 대화방ID Path Parameter 입니다.\n","schema":{"type":"string"},"required":true}},"schemas":{"PausePersistentMenu":{"type":"object","properties":{"isPause":{"type":"boolean","description":"대화방메뉴 중지 여부","default":true}}}}},"paths":{"/brand/{brandId}/bidirectional/chatbot/{chatbotId}/persistentmenu/pause":{"put":{"summary":"중계사만 사용이 가능하며, 양방향 대화방의 대화방메뉴 사용을 중지 또는 재개합니다.\n","description":"양방향 대화방에 대화방메뉴 사용을 중지 또는 재개합니다.  \n양방향 대화방에 등록된 중계사만 사용이 가능합니다.  \n과금 미납 발생 등 특이사항이 발생한 경우 사용하며 대화방메뉴 중지에 대한 정보가 사용자에게 RBC 홈페이지에서 표시됩니다.  \n","parameters":[{"$ref":"#/components/parameters/BrandKey"},{"$ref":"#/components/parameters/BrandId"},{"$ref":"#/components/parameters/ChatbotId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PausePersistentMenu"}}}},"responses":{"200":{"description":"페이지 내 Response 섹션 참조"}}}}}}
```

### ❖ request body sample

{% tabs %}
{% tab title="대화방메뉴 중지 여부" %}

```
  "isPause": true
}
```

{% endtab %}
{% endtabs %}

## 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="125">기본값</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></tbody></table>

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

<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="85">기본값</th><th>설명</th></tr></thead><tbody><tr><td><strong><code>chatbotId</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>대화방ID</td></tr><tr><td><strong><code>isPause</code></strong></td><td>boolean</td><td align="center"></td><td align="center"></td><td></td><td>중지여부</td></tr><tr><td><strong><code>pausedDate</code></strong></td><td>integer</td><td align="center"></td><td align="center"></td><td></td><td>isPause true 인 경우, 중지일시</td></tr><tr><td><strong><code>resumeDate</code></strong></td><td>string</td><td align="center"></td><td align="center"></td><td></td><td>isPause false인 경우, 재개일시</td></tr></tbody></table>

### ❖ response body sample

{% tabs %}
{% tab title="200" %}

```
{
    "code": "20000000",
    "desc": null
    "result": [
        {
            "chatbotId": "bot-aljr02btgnh",
            "isPause": true,
            "pausedDate": "2024-06-13T00:27:38.648Z",
            "resumeDate": "2024-06-13T00:27:38.648Z"
        }
    ],
    "status": 200
}
```

{% endtab %}

{% tab title="400" %}

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

{
    "error": {
        "code": "64360",
        "message": "chatbot is not bidirectional(twoway)"
    },
    "status": 400
}

{
    "error": {
        "code": "64385",
        "message": "This Menu dose not regist"
    },
    "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](/rbc-api/error_code.md#rcs-biz-center-response-body-error-code) 참조
{% endhint %}
