联系人

扫码体验:img.jpg

my.choosePhoneContact

选择本地系统通信录中某个联系人的电话。

入参

名称类型必填描述
successFunction调用成功的回调函数
failFunction调用失败的回调函数
completeFunction调用结束的回调函数(调用成功、失败都会执行)

success 返回值

名称类型描述
nameString选中的联系人姓名
mobileString选中的联系人手机号

错误码

error描述
10没有权限
11用户取消操作(或设备未授权使用通讯录)

代码示例

  1. my.choosePhoneContact({
  2. success: (res) => {
  3. my.alert({
  4. content: '姓名:' + res.name + '\n号码:' + res.mobile
  5. });
  6. },
  7. });

my.chooseAlipayContact

唤起支付宝通讯录,选择一个或者多个支付宝联系人。

入参

名称类型必填描述
countNumber单次最多选择联系人个数,默认 1,最大 10
successFunction调用成功的回调函数
failFunction调用失败的回调函数
completeFunction调用结束的回调函数(调用成功、失败都会执行)

success 返回值

名称类型描述
contactsObject Array选中的支付宝联系人数组,数组内部对象字段见下表

contacts 返回字段说明

名称类型描述
realNameString账号的真实姓名
mobileString账号对应的手机号码
emailString账号的邮箱
avatarString账号的头像链接
userIdString支付宝账号唯一 userId

错误码

error描述
10没有权限
11用户取消操作(或设备未授权使用通讯录)

代码示例

  1. my.chooseAlipayContact({
  2. count: 2,
  3. success: (res) => {
  4. my.alert({
  5. content: 'chooseAlipayContact response: ' + JSON.stringify(res)
  6. });
  7. },
  8. fail: (res) => {
  9. my.alert({
  10. content: 'chooseAlipayContact response: ' + JSON.stringify(res)
  11. });
  12. }
  13. });
返回的 mobile 和 email 字段不一定全有值,取决于所选取联系人的支付宝账号类型是手机号还是邮箱。

my.chooseContact

基础库版本 1.4.0 开始支持,低版本需做兼容处理

唤起选人组件,默认只包含支付宝联系人,可以通过修改参数包含手机通讯录联系人或者双向通讯录联系人。

入参

名称类型必填描述
chooseTypeString选择类型,值为single(单选)或者 multi(多选)
includeMobileContactModeString包含手机通讯录联系人的模式:默认为不包含(none)、或者仅仅包含双向通讯录联系人(known)、或者包含手机通讯录联系人(all)
includeMeBoolean是否包含自己
multiChooseMaxNumber最大选择人数,仅 chooseType 为 multi 时才有效
multiChooseMaxTipsString多选达到上限的文案,仅 chooseType 为 multi 时才有效
successFunction调用成功的回调函数
failFunction调用失败的回调函数
completeFunction调用结束的回调函数(调用成功、失败都会执行)

success 返回值

注意:当用户没有选择任何联系人时,返回也是 success,只不过返回为空
名称类型描述
contactsDicArrayStringArray选择返回的用户信息

contactsDicArray 类型说明

名称类型描述
userIdString支付宝账号唯一 userId
avatarString账号的头像链接
mobileString账号对应的手机号码
realNameString账号的真实姓名
displayNameString账号的显示名称:也即支付宝设置的备注名称,默认为朋友圈里面的昵称

代码示例

  1. my.chooseContact({
  2. chooseType: 'multi', // 多选模式
  3. includeMe: true, // 包含自己
  4. includeMobileContactMode: 'known',//仅包含双向手机通讯录联系人,也即双方手机通讯录都存有对方号码的联系人
  5. multiChooseMax: 3, // 最多能选择三个联系人
  6. multiChooseMaxTips: '超过选择的最大人数了',
  7. success: (res) => {
  8. my.alert({
  9. content: 'chooseContact : ' + JSON.stringify(res)
  10. });
  11. },
  12. fail: (res) => {
  13. my.alert({
  14. content: 'chooseContact : ' + JSON.stringify(res)
  15. });
  16. }
  17. });

原文: https://docs.alipay.com/mini/api/ui-contact