# wx.openChatTool(Object object)

> 基础库 3.7.8 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：支持
> 
> __小程序插件__：不支持

> 相关文档: [聊天工具模式](/miniprogram/dev/framework/open-ability/chatTool.md)

## 功能描述

进入聊天工具模式。

  1. 不传入聊天室id时，微信会拉起聊天列表让用户选择，用户选择后绑定聊天室进入聊天工具模式。
  2. 传入聊天室id时（群聊为opengid，单聊为open_single_roomid），会直接绑定该聊天室进入，此时必须传入对应的 chatType。
  3. 聊天室类型可从 [[getGroupEnterInfo]]((group/wx.getGroupEnterInfo)) 返回值中获取。

## 参数

### Object object


```json
[
  {
    "属性": "url",
    "类型": "string",
    "默认值": "",
    "必填": "是",
    "说明": "聊天工具分包内的页面路径"
  },
  {
    "属性": "roomid",
    "类型": "string",
    "默认值": "",
    "必填": "否",
    "说明": "聊天室 id，不传则拉起群选择框，可以传入多聊群的 opengid 值，或者单聊群的 open_single_roomid 值"
  },
  {
    "属性": "chatType",
    "类型": "number",
    "默认值": "",
    "必填": "否",
    "说明": "群聊类型",
    "子项": [
      {
        "合法值": "1",
        "说明": "微信联系人单聊"
      },
      {
        "合法值": "2",
        "说明": "企业微信联系人单聊"
      },
      {
        "合法值": "3",
        "说明": "普通微信群聊"
      },
      {
        "合法值": "4",
        "说明": "企业微信互通群聊"
      }
    ]
  },
  {
    "属性": "success",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用成功的回调函数"
  },
  {
    "属性": "fail",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用失败的回调函数"
  },
  {
    "属性": "complete",
    "类型": "function",
    "默认值": "",
    "必填": "否",
    "说明": "接口调用结束的回调函数（调用成功、失败都会执行）"
  }
]
```

## 示例代码

```javascript

  wx.openChatTool({
    roomid: 'open_single_roomid',
    chatType: 1
  })

```

```javascript

  wx.openChatTool({
    roomid: 'opengid',
    chatType: 3
  })

```