JSAPI

  • Since 8.3

    chooseContact

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

    使用方法

    AlipayJSBridge.call('chooseContact', {
        "type": "single",
        "title": "choose contacts",
        "multiMax": 20,
        "multiMaxText": "max!",
      },  function(result) {
        alert(JSON.stringify(result));
      }
    );
    

    代码演示

    基本功能

    <h1>点击选择多个联系人</h1>
    <a href="javascript:void(0)" class="btn contact">打开手机通信录</a>
    
    <script>
    function ready(callback) {
      // 如果jsbridge已经注入则直接调用
      if (window.AlipayJSBridge) {
        callback && callback();
      } else {
        // 如果没有注入则监听注入的事件
        document.addEventListener('AlipayJSBridgeReady', callback, false);
      }
    }
    ready(function(){
      document.querySelector('.contact').addEventListener('click', function() {
        AlipayJSBridge.call('chooseContact', {
          "title": "choose contacts", // title show on the title bar
          "multiMax": 2, // max contact items size, default 50
          "multiMaxText": "max!", // message if selected more than max
        }, function(result) {
          alert(JSON.stringify(result));
        });
      });
    });
    </script>
    

    API

    AlipayJSBridge.call('chooseContact', {
      title, type, multiMax, multiMaxText
    }, fn)
    

    入参

    名称类型描述必选默认值版本
    titlestring显示在联系人选择页面的标题N跟随系统默认
    typestring选择模式,多选(multi)或者单选(single)Nmulti
    multiMaxint单次最多选择联系人数(0或-1,表示无限制选择)N50
    multiMaxTextstring用户选择数超过上限的文案N跟随系统默认
    fnfunction回调函数N

    出参

    回调函数带入的参数result: {contacts: {email, mobile, headImageUrl, name, userId, from}}

    名称类型描述
    emailstring账号的邮箱
    mobilestring账号对应的手机号码
    headImageUrlstring账号的头像
    namestring账号的真实姓名
    fromstring账号来源

    错误

    error描述
    10操作无权限;
    11用户取消操作