开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
基础 api
基础
应用级事件
界面
导航栏
tabbar
路由
交互反馈
下拉刷新
联系人
选择城市
选择日期
动画
画布
地图
计算路径
键盘
滚动
节点查询
选项选择器
级联选择
设置窗口背景
设置页面是否支持下拉
字体
跳转
多媒体
缓存
文件
位置
网络
设备
worker
数据安全
分享
收藏
自定义通用菜单
更新管理
web-view组件控制
升级支付宝最新版本
隐私信息授权
小程序广告
开放能力 api
开发 > api > 基础 api > 界面 > 联系人 > my.choosecontact
评论
收藏
我的文档
设置

my.choosecontact(object object)

基础库  或更高版本; 且 支付宝客户端 10.1.8 或更高版本; 若版本较低,建议采取 兼容处理

主体: 企业支付宝小程序个人支付宝小程序

相关文档: my.opensetting

拉起通讯录,选择联系人。

object object

查看示例

属性 类型 默认值 必填 描述
choosetype string -

选择类型

枚举值 描述 兼容性
single

单选

-
multi

多选

-
includemobilecontactmode string none

选择手机通讯录联系人的模式

枚举值 描述 兼容性
none

只包含支付宝联系人,不包含手机通讯录联系人

-
known

仅包含双向通讯录联系人,即双方手机通讯录都存有对方号码的联系人

-
all

所有通讯录联系人,即包括支付宝通讯录、手机通讯录

-
includeme boolean false

是否包含自己

multichoosemax number 50

最大选择人数,仅 choosetype 为 multi 时才有效

multichoosemaxtips string 人数已达上限,无法选择更多朋友。

多选达到上限时提示的文案,仅 choosetype 为 multi 时才有效

success function -

调用成功的回调函数

fail function -

调用失败的回调函数

complete function -

调用结束的回调函数(调用成功、失败都会执行)

success 回调函数

参数

object res

注意:当用户没有选择任何联系人时,res 为 {}。

查看示例

属性 类型 描述
contactsdicarray array

选中的联系人

属性 类型 描述
userid string

支付宝账号唯一标识符

avatar string

账号的头像链接

mobile string

账号对应的手机号码
注意:
1、请在手机端开启支付宝客户端 app 的通讯录权限,否则可能出现获取不到手机号码的情况
2、手机本地系统通讯录号码需要与支付宝好友手机号码一致,否则可能出现获取不到手机号码的情况

realname string

账号的真实姓名

displayname string

账号的显示名称,即支付宝设置的备注名称,默认为朋友圈里面的昵称

fail 回调函数

参数

object err

查看示例

属性 类型 描述
error number

错误码

errormessage string

错误信息

fail 回调的参数为 object,error 属性为错误码,errormessage 属性为错误消息。

错误码 错误消息 凯发app官方网站的解决方案
2001 用户不允许授权。

用户拒绝为当前小程序授权。
请在交互中考虑此情况,如有需要,请向用户强调该授权的必要性。

2002 用户不允许授权。

用户拒绝为当前小程序授权,并勾选了“总是保持以上选择”后,再次调用授权接口产生的报错。

如有需要,提醒或引导用户手动授权:小程序右上角胶囊按钮->设置->打开权限开关;或者通过调用 my.opensetting 帮助用户打开设置页面。

2003 用户勾选了不允许授权选项。

用户拒绝为当前小程序授权,并勾选了“总是保持以上选择”。

如有需要,提醒或引导用户手动授权:小程序右上角胶囊按钮->设置->打开权限开关;或者通过调用 my.opensetting 帮助用户打开设置页面。

my.choosecontact(object object)
success 回调
fail 回调
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": "用户不允许授权"
}
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图