# chooseContact
打开用户联系人选择列表,可以选择用户或部门,并返回选定用户或部门的信息
注意事项:
小程序调用前,请确保已经调用login接口成功登录;
网页应用调用前,需前置成功调用requestAuthCode
# 支持说明
应用能力 | Android | iOS | PC | 预览效果 |
---|---|---|---|---|
小程序 | 3.3.0 | 3.3.0 | 3.4.0 | 扫码预览 用BoosHi扫码或PC端点击 |
网页应用 | 3.19.0 | 3.19.0 | 3.19.0 | - |
# 输入
继承标准对象输入,扩展属性描述:
名称 | 数据类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
multi | boolean | 否 | true | 是否多选 |
ignore | boolean | 否 | false | 选择列表中是否排除当前用户,true:排除,false:不排除 |
maxNum | number | 否 | 9 | 多选时候最大选人数量待开发 |
limitTips | string | 否 | 达到选人上限时的提示文案 示例值:提示文案 待开发 | |
enableChooseDepartment | boolean | 否 | false | 是否支持选择部门,默认不支持待开发 |
chosenIds | string[] | 否 | 3.11.0支持 指定已选取的 开放平台openid(用户) 数组,multi值为flase时不生效 示例值:["ou_aea5df288c71a47af6ccd786c05be939"] | |
disableChosenIds | string[] | 否 | 3.11.0支持 指定 开放平台openid(用户) 列表为置灰、不可选择状态。 单选暂不支持 示例值:["ou_aea5df288c71a47af6ccd786c05be939"] |
# 输出
success
返回对象的扩展属性:
名称 | 数据类型 | 描述 |
---|---|---|
data | user[] | 选择用户后,返回选中用户的信息 |
∟ openId | string | 用户 openId 3.10.0-: 明文bosshi userid 示例 :2010273.10.0: 加密的bosshi userid 示例 :89EDAB2A519AB20BDAFC43864D2957D913.11.0: 开放平台 openid 示例 :ou_aea5df288c71a47af6ccd786c05be939 |
∟ unionId | string | 3.11.0支持 用户开放平台 unionId |
∟ name | string | 用户姓名 |
∟ i18nNames | object | 国际化姓名待开发 |
∟ zh_cn | string | 中文名,可能为空 |
∟ en_us | string | 英文名,可能为空 |
∟ ja_jp | string | 日文名,可能为空 |
∟ avatarUrls | string[] | 联系人的头像url数组,包含多种图片分辨率 |
department_data | department[] | 选择部门后,返回选中部门的信息待开发 |
∟ departmentId | string | 部门departmentId。待开发 |
∟ openDepartmentId | string | 部门 openDepartmentId。待开发 |
# 示例代码
bz.chooseContact({
multi: true,
ignore: false,
maxNum: 10,
limitTips: "选择人数达到上限了",
enableChooseDepartment: true,
disableChosenIds: [''],
success(res) {
console.log(JSON.stringify(res));
},
fail(res) {
console.log(`chooseContact fail: ${JSON.stringify(res)}`);
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
success
返回对象示例:
{
"data": [
{
"avatarUrls": [],
"name": "汤姆",
"openId": "",
"unionId": "",
"i18nNames": {
"en_us": "Tom",
"ja_jp": "",
"zh_cn": "汤姆"
}
}
],
"department_data": [],
"errMsg": "chooseContact:ok"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17