资源工坊

chooseChat ​

描述 ​

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

网页应用需要完成鉴权后调用该接口。

支持说明 ​

客户端平台WPS协作版本要求
iOS>=5.24.0
Android>=5.24.0
PC>=5.24.0

输入 ​

名称数据类型是否必填描述
paramsobject是
∟ allowCreateGroupboolean否是否允许在选择会话列表内，创建群组并转发，取值：
true：允许
false：不允许
默认值为true。
∟ confirmDescstring否选中会话后，确认弹框的描述。该字段为空时，界面将不展示描述框。
∟ confirmTextstring否选中会话后，确认弹框的确认按钮文案。默认值："发送"
∟ confirmTitlestring否选中会话后，确认弹框的标题名称。
默认值："发送给"。
∟ multiSelectboolean否是否允许多选，取值为 true 时，支持在会话列表选择多个会话（最多可选择 10 个）。取值：
true：允许
false：不允许
默认值为false。
∟ selectTypenumber否选择模式，可选值：
0：选择单聊和群聊
1：只选择单聊
该模式下，allowCreateGroup 设置为 true 将不会生效
2：只选择群聊
默认值为0。
∟ showMessageInputboolean否选中会话后，确认弹框内是否显示留言输入框，取值：
true：显示
false：不显示
默认值为false。
onSuccessFunction否
onErrorFunction否

输出 ​

名称类型描述
dataarray<object>选择会话列表信息
∟ avatarUrlsarray<string>会话的头像 URL数组
∟ chatTypenumber会话类型
1：单聊
2：群聊
∟ idstring会话 ID（chat_id）
∟ namestring会话名称
messagestring用户输入的留言，当输入字段 showMessageInput 为 true 时才会输出该字段

示例代码 ​

ts
const params = {
   allowCreateGroup: true,
   multiSelect: true,
   selectType: 0,
   confirmTitle: '发送给',
   confirmText: '发送',
   confirmDesc: '请选择会话',
   showMessageInput: true  
};
window.ksoxz_sdk.chooseChat({params, onSuccess, onError});

错误码 ​

errnomsg含义
1041001User canceled用户取消操作

除以上错误外，还可能存在公共错误，参考：公共错误码