my.choosecontact(object object)
基础库 或更高版本; 且 支付宝客户端 10.1.8 或更高版本; 若版本较低,建议采取 兼容处理 。
支小宝客户端 支持
安诊儿客户端 支持
主体: 企业支付宝小程序 、 个人支付宝小程序
相关文档: my.opensetting
拉起通讯录,选择联系人。
object object
查看示例
属性 | 类型 | 默认值 | 必填 | 描述 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
choosetype | string | - | 是 | 选择类型 |
|||||||||||||
|
|||||||||||||||||
includemobilecontactmode | string | none | 否 | 选择手机通讯录联系人的模式 |
|||||||||||||
|
|||||||||||||||||
includeme | boolean | false | 否 | 是否包含自己 |
|||||||||||||
multichoosemax | number | 50 | 否 | 最大选择人数,仅 choosetype 为 multi 时才有效 |
|||||||||||||
multichoosemaxtips | string | 人数已达上限,无法选择更多朋友。 | 否 | 多选达到上限时提示的文案,仅 choosetype 为 multi 时才有效 |
|||||||||||||
success | function | - | 否 | 调用成功的回调函数 |
|||||||||||||
fail | function | - | 否 | 调用失败的回调函数 |
|||||||||||||
complete | function | - | 否 | 调用结束的回调函数(调用成功、失败都会执行) |
success 回调函数
参数
object res
注意:当用户没有选择任何联系人时,res
为 {}。
查看示例
属性 | 类型 | 描述 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
contactsdicarray | array | 选中的联系人 |
|||||||||||||||||||
|
fail 回调函数
参数
object err
查看示例
属性 | 类型 | 描述 |
---|---|---|
error | number | 错误码 |
errormessage | string | 错误信息 |
fail 回调的参数为 object,error
属性为错误码,errormessage
属性为错误消息。
错误码 | 错误消息 | 凯发app官方网站的解决方案 |
---|---|---|
2001 | 用户不允许授权。 |
用户拒绝为当前小程序授权。 |
2002 | 用户不允许授权。 |
用户拒绝为当前小程序授权,并勾选了“总是保持以上选择”后,再次调用授权接口产生的报错。 如有需要,提醒或引导用户手动授权:小程序右上角胶囊按钮->设置->打开权限开关;或者通过调用 my.opensetting 帮助用户打开设置页面。 |
2003 | 用户勾选了不允许授权选项。 |
用户拒绝为当前小程序授权,并勾选了“总是保持以上选择”。 如有需要,提醒或引导用户手动授权:小程序右上角胶囊按钮->设置->打开权限开关;或者通过调用 my.opensetting 帮助用户打开设置页面。 |
my.choosecontact({
choosetype: 'multi', // 多选模式
includeme: true, // 包含自己
includemobilecontactmode: 'known', //仅包含双向手机通讯录联系人,即双方手机通讯录都存有对方号码的联系人
multichoosemax: 3, // 最多能选择三个联系人
multichoosemaxtips: '超过选择的最大人数了',
success: (res) => {
console.log("choosecontact", res)
},
fail: (err) => {
console.log("choosecontact error", err)
},
});
{
"contactsdicarray": [
{
"avatar": "http://tfs.alipayobjects.com/images/partner/xxxxxxxxxx",
"displayname": "皮蛋",
"mobile": "13222223333",
"nickname": "皮蛋",
"userid": "2088123456789012",
"realname": "支小宝"
}
]
}
{
"error": "2001",
"errormessage": "用户不允许授权"
}