getChatInfo

获取某个会话的信息

注意事项：

小程序调用前，请确保已经调用login接口成功登录；

支持说明

应用能力	Android	iOS	PC	预览效果
小程序	3.5.0	3.5.0	3.7.0	扫码预览 用BoosHi扫码或PC端点击
网页应用	待开发	待开发	待开发	待补充

输入

继承标准对象输入，扩展属性描述：

名称	数据类型	必填	默认值	描述
openid	string	否		用户 open_id 3.11.0支持 单聊：开放平台openid 机器人：加密的bosshi userid（开放平台目前没有属于机器人的openid） 示例：ou_aea5df288c71a47af6ccd786c05be939
openChatId	string	否		open_chat_id 3.10.0-： 单聊：明文bosshi userid 机器人：明文bosshi userid 群聊：明文bosshi群聊id 示例：201027 3.10.0： 单聊：加密的bosshi userid 机器人：加密的bosshi userid 群聊：加密的bosshi群聊id 示例：89EDAB2A519AB20BDAFC43864D2957D91 3.11.0： 仅支持开放平台 openChatId (群聊) 示例：ou_aea5df288c71a47af6ccd786c05be939
chatType	number	是		会话的类型 3.11.0开始废弃 示例值：0 可选值： * 0：单聊 * 1：群聊
userType	number	否		单聊用户类型 3.11.0开始废弃 示例值：0 可选值： * 0：用户 * 1：bot

输出

继承标准对象输出

success返回对象的扩展属性：

名称	数据类型	描述
i18nNames	object	国际化会话名(可能为空)
∟ zh_cn	string	中文名，可能为空
∟ en_us	string	英文名，可能为空
∟ ja_jp	string	日文名，可能为空
name	string	会话名称
avatarUrls	string[]	会话的头像url数组，包含多种图片分辨率
atCount	number	被at数量 暂不支持
badge	number	未读消息数

示例代码

bz.getChatInfo(
  {
    openChatId: '',
    openId: '',
    success (res) {
        console.log(JSON.stringify(res));
    },
    fail (res) {
        console.log(`getChatInfo fail:${JSON.stringify(res)}`);
    }
  }
)

success返回对象示例：

{
  "atCount": 0,
  "avatarUrls": [],
  "badge": 29,
  "i18nNames": {
    "en_us": "",
    "zh_cn": ""
  },
  "name": "ios群聊",
  "errMsg": "getChatInfo:ok"
}