支付宝小程序API 联系人
支付宝小程序联系人
选择本地系统通信录中某个联系人的电话。
名称 |
类型 |
必填 |
描述 |
success |
Function |
否 |
调用成功的回调函数 |
fail |
Function |
否 |
调用失败的回调函数 |
complete |
Function |
否 |
调用结束的回调函数(调用成功、失败都会执行) |
名称 |
类型 |
描述 |
name |
String |
选中的联系人姓名 |
mobile |
String |
选中的联系人手机号 |
error |
描述 |
10 |
没有权限 |
11 |
用户取消操作(或设备未授权使用通讯录) |
my.choosePhoneContact({
success: (res) => {
my.alert({
content: '姓名:' + res.name + 'n号码:' + res.mobile
});
},
});
唤起支付宝通讯录,选择一个或者多个支付宝联系人。
名称 |
类型 |
必填 |
描述 |
count |
Number |
否 |
单次最多选择联系人个数,默认 1,最大 10 |
success |
Function |
否 |
调用成功的回调函数 |
fail |
Function |
否 |
调用失败的回调函数 |
complete |
Function |
否 |
调用结束的回调函数(调用成功、失败都会执行) |
名称 |
类型 |
描述 |
contacts |
Object Array |
选中的支付宝联系人数组,数组内部对象字段见下表 |
contacts 返回字段说明
名称 |
类型 |
描述 |
realName |
String |
账号的真实姓名 |
mobile |
String |
账号对应的手机号码 |
email |
String |
账号的邮箱 |
avatar |
String |
账号的头像链接 |
userId |
String |
支付宝账号 userId |
error |
描述 |
10 |
没有权限 |
11 |
用户取消操作(或设备未授权使用通讯录) |
my.chooseAlipayContact({
count: 2,
success: (res) => {
my.alert({
content: 'chooseAlipayContact response: ' + JSON.stringify(res)
});
},
fail: (res) => {
my.alert({
content: 'chooseAlipayContact response: ' + JSON.stringify(res)
});
}
});
返回的 mobile 和 email 字段不一定全有值,取决于所选取联系人的支付宝账号类型是手机号还是邮箱。
my.chooseContact
唤起选人组件,默认只包含支付宝联系人,可以通过修改参数包含手机通讯录联系人或者双向通讯录联系人。
入参
名称 |
类型 |
必填 |
描述 |
chooseType |
String |
是 |
选择类型,值为single(单选)或者 multi(多选) |
includeMobileContactMode |
String |
否 |
包含手机通讯录联系人的模式:默认为不包含(none)、或者仅仅包含双向通讯录联系人(known)、或者包含手机通讯录联系人(all) |
includeMe |
Boolean |
否 |
是否包含自己 |
multiChooseMax |
Number |
否 |
最大选择人数,仅 chooseType 为 multi 时才有效 |
multiChooseMaxTips |
String |
否 |
多选达到上限的文案,仅 chooseType 为 multi 时才有效 |
success |
Function |
否 |
调用成功的回调函数 |
fail |
Function |
否 |
调用失败的回调函数 |
complete |
Function |
否 |
调用结束的回调函数(调用成功、失败都会执行) |
success 返回值
注意:当用户没有选择任何联系人时,返回也是 success,只不过返回为空
名称 |
类型 |
描述 |
contactsDicArray |
StringArray |
选择返回的用户信息 |
contactsDicArray 类型说明
名称 |
类型 |
描述 |
userId |
String |
支付宝账号唯一 userId |
avatar |
String |
账号的头像链接 |
mobile |
String |
账号对应的手机号码 |
realName |
String |
账号的真实姓名 |
displayName |
String |
账号的显示名称:也即支付宝设置的备注名称,默认为朋友圈里面的昵称 |
代码示例
my.chooseContact({
chooseType: 'multi', // 多选模式
includeMe: true, // 包含自己
includeMobileContactMode: 'known',//仅包含双向手机通讯录联系人,也即双方手机通讯录都存有对方号码的联系人
multiChooseMax: 3, // 最多能选择三个联系人
multiChooseMaxTips: '超过选择的最大人数了',
success: (res) => {
my.alert({
content: 'chooseContact : ' + JSON.stringify(res)
});
},
fail: (res) => {
my.alert({
content: 'chooseContact : ' + JSON.stringify(res)
});
}
});