Skip to content

chooseContact

描述

打开联系人选择器,可以选择用户或部门,并返回选择的用户和部门信息。

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

支持说明

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

输入

名称数据类型是否必填描述
paramsobject
∟ dataSourceUsersarray<number>自定义显示成员wpsUid。选用此参数时,通讯录列表仅展示此参数下的人员清单
∟ dataSourceXZUsersarray<number>自定义显示成员协作xzUserId
∟ executiveboolean是否启用高管模式。
默认值false
∟ isSupportSelectDepartmentboolean是否可选择部门。
默认值true
∟ isSupportSelectGroupMemberboolean是否可以选择群聊成员。
默认值true
∟ maxUsersnumber多选时,最大选择人数。
默认值500

注意:需要multiple参数为true时生效
∟ multipleboolean是否多选。
默认值true
∟ pickedDepartmentsarray<number>已选部门 ID
∟ pickedUsersarray<number>已选成员 wpsUid。
∟ recentChatTypenumber最近联系人显示的会话类型,可能值有:
0:包含单聊、群聊
1: 单聊。
2: 群聊。
∟ relatedOrganizationsboolean是否展示关联组织。
默认值true
∟ returnUserOnlyboolean是否只返回用户列表。可能值:
• false:返回选中的成员和部门
• true:只返回用户列表,当选中部门时,会返回部门下的所有成员,而不返回选中的部门
默认值false
∟ showExternalContactEntranceboolean是否显示外部联系人。
默认值false
∟ showGroupEntranceboolean是否显示群聊入口。
默认值false
∟ showOutsourceEntranceboolean是否显示v7外部联系人。
默认值false
∟ showRecentEntranceboolean是否显示最近联系人。
默认值false
∟ titlestring选择页面展示的标题。

注意:PC该页面没有主标题,不支持该参数
onSuccessFunction
onErrorFunction

输出

名称类型描述
departmentsarray<object>选中的部门集合
∟ companyIdnumber企业id
∟ departmentIdstring部门id
∟ departmentNamestring部门名称
groupsarray<object>选中的群聊集合
∟ chatIdnumber群聊id
∟ chatNamestring群聊名称
usersarray<object>选中的用户集合
∟ avatarstring用户头像
∟ companyIdnumber企业 id
∟ userIdnumber用户id
∟ userNamestring用户姓名

示例代码

ts
const params = {
   maxUsers: 20,
   pickedUsers:[21866056,65446616],
   pickedDepartments:[10093492,10009041]
};
window.ksoxz_sdk.chooseContact({
params,
onSuccess, 
onError,
})

错误码

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

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