# chooseChat

打开用户会话列表选择会话

注意事项:

小程序调用前,请确保已经调用login接口成功登录;
网页应用调用前,需前置成功调用requestAuthCode

# 支持说明

应用能力 Android iOS PC 预览效果
小程序 3.3.0 3.3.0 3.4.0
扫码预览
用BoosHi扫码或PC端点击
网页应用 3.11.0 3.11.0 3.11.0 待补充

# 输入

继承标准对象输入,扩展属性描述:

名称 数据类型 必填 默认值 描述
allowCreateGroup boolean true 是否允许在选择会话列表支持创建群组返回
示例值:true
待开发
multiSelect boolean false 是否可以多选(默认最多可选10个)
示例值:false
ignoreSelf boolean false 是否在会话列表过滤掉自己
示例值:false
待开发
ignoreBot boolean false 是否在会话列表过滤掉机器人
示例值:false
待开发
selectType number 0 选择模式
示例值:0
可选值
0:选择单聊或群聊
1:只选择群聊
2:只选择单聊(此 type 下 allowCreateGroup 设置为 true 无效)
待开发
confirmTitle string 已选择 确认弹框的标题
待开发
示例值:已选择
confirmDesc string 确认弹框描述,空的时候不展示
待开发
showMessageInput boolean false 确认弹框是否显示留言输入框。
安卓、PC支持,IOS暂不支持
示例值:false

# 输出

success返回对象的扩展属性:

名称 数据类型 描述
data object[] 选择会话列表
  ∟ id string 3.10.0-:
单聊:明文bosshi userid
机器人:明文bosshi userid
示例:201027
3.10.0:
单聊:加密的bosshi userid
机器人:加密的bosshi userid
示例:89EDAB2A519AB20BDAFC43864D2957D91
3.11.0:
单聊:开放平台openid
机器人:加密的bosshi userid(开放平台目前没有属于机器人的openid
示例:ou_aea5df288c71a47af6ccd786c05be939
  ∟ chatType number 会话类型
可选值
0:单聊
1:群聊
  ∟ userType number 单聊类型
可选值
0:普通用户
1:机器人(仅在chatType为0时返回此参数)
  ∟ avatarUrls string[] 会话的头像url数组,包含多种图片分辨率
  ∟ name string 会话名称
  ∟ i18nNames object 国际化会话名
待开发
    ∟ zh_cn string 中文名,可能为空
    ∟ en_us string 英文名,可能为空
    ∟ ja_jp string 日文名,可能为空
message string 用户输入的留言(showMessageInput为true时才会有值)
安卓、PC支持,IOS暂不支持

# 示例代码

bz.chooseChat({
    allowCreateGroup: true,
    multiSelect: true,
    ignoreSelf: false,
    ignoreBot: false,
    selectType: 0,
    confirmTitle: "确认",
    confirmDesc: "确认发送?",
    showMessageInput: true,
    success(res) {
      console.log(JSON.stringify(res));
    },
    fail(res) {
      console.log(`chooseChat fail: ${JSON.stringify(res)}`);
    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

success返回对象示例:

{
    "errMsg": "chooseChat:ok",
    "message": "",
    "data": [
        {
            "name": "BossHi团队",
            "i18nNames": {
                "en_us": "",
                "zh_cn": "",
                "ja_jp": ""
            },
            "id": "",
            "avatarUrls": [
                ""
            ],
            "chatType": 0,
            "userType": 1
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
最后更新于 : 11/24/2023, 5:30:35 PM