分享接口 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

客户端API

JS-SDK

界面

分享接口

最后更新：2023/03/17

获取“转发”按钮点击状态及自定义分享内容接口

获取“微信”按钮点击状态及自定义分享内容接口

获取“分享到朋友圈”按钮点击状态及自定义分享内容接口

自定义转发到会话

自定义转发到微信

权限说明

分享接口仅激活的成员数超过200人且已经认证的企业才可在微信上调用。
id转译功能仅供第三方应用使用，仅在企业微信4.0.20及以后版本支持。若要开启id转译功能，必须先成功调用agentConfig，否则使用分享接口时会报“no permission”错误

获取“转发”按钮点击状态及自定义分享内容接口

wx.onMenuShareAppMessage({
    title: '', // 分享标题
    desc: '', // 分享描述
    link: '', // 分享链接；在微信上分享时，该链接的域名必须与企业某个应用的可信域名一致
    imgUrl: '', // 分享图标
    enableIdTrans: 1, // 是否开启id转译，不填默认为0
    success: function () {
        // 用户确认分享后执行的回调函数
    },
    error: function(res) {
        if(res.errMsg.indexOf('no permission') > 0){
            alert('未agentConfig')
        }
    },
    cancel: function () {
        // 用户取消分享后执行的回调函数
    }
});

微信客户端即将废弃该接口

获取“微信”按钮点击状态及自定义分享内容接口

wx.onMenuShareWechat({
    title: '', // 分享标题
    desc: '', // 分享描述
    link: '', // 分享链接
    imgUrl: '', // 分享图标
    enableIdTrans: 1, // 是否开启id转译，不填默认为0
    success: function () {
        // 用户确认分享后执行的回调函数
    },
    error: function(res) {
        if(res.errMsg.indexOf('no permission') > 0){
            alert('未agentConfig')
        }
    },
    cancel: function () {
        // 用户取消分享后执行的回调函数
    }
});

此接口在企业微信支持，微信客户端不支持

获取“分享到朋友圈”按钮点击状态及自定义分享内容接口

wx.onMenuShareTimeline({
    title: '', // 分享标题
    link: '', // 分享链接；在微信上分享时，该链接的域名必须与企业某个应用的可信域名一致
    imgUrl: '', // 分享图标
    enableIdTrans: 1, // 是否开启id转译，不填默认为0
    success: function () {
        // 用户确认分享后执行的回调函数
    },
    error: function(res) {
        if(res.errMsg.indexOf('no permission') > 0){
            alert('未agentConfig')
        }
    },
    cancel: function () {
        // 用户取消分享后执行的回调函数
    }
});

微信客户端即将废弃该接口

自定义转发到会话

wx.invoke(
        "shareAppMessage", {
                title: '', // 分享标题
                desc: '', // 分享描述
                link: '', // 分享链接
                imgUrl: '', // 分享封面
                enableIdTrans: 1, // 是否开启id转译，不填默认为0
    }, function(res) {
        if (res.err_msg == "shareAppMessage:ok") {
                        //正确处理
        } else {
                        //错误处理
                }
    }
);

此接口在企业微信2.4.5及以后版本支持，微信客户端不支持（微信开发者工具也不支持）

自定义转发到微信

wx.invoke(
        "shareWechatMessage", {
                title: '', // 分享标题
                desc: '', // 分享描述
                link: '', // 分享链接
                imgUrl: '', // 分享封面
                enableIdTrans: 1, // 是否开启id转译，不填默认为0
    }, function(res) {
        if (res.err_msg == "shareWechatMessage:ok") {
                        //正确处理
        }else {
                        //错误处理
                }
    }
);

此接口在企业微信移动端2.4.5及以后版本支持，微信客户端不支持（微信开发者工具也不支持）

id转译模版语法

$departmentName=DEPARTMENT_ID$
$userName=USERID$
$userAlias=USERID$
$userAliasOrName=USERID$

其中 DEPARTMENT_ID 是数字类型的部门id，USERID 是成员账号。
譬如，
将 $departmentName=1$ 替换成部门id为1对应的部门名，如“企业微信部”；
将 $userName=lisi007$ 替换成userid为lisi007对应的用户姓名，如“李四”；
将 $userAlias=lisi007$ 替换成userid为lisi007对应的用户别名，如“lisi”；
将 $userAliasOrName=lisi007$ 替换成userid为lisi007对应的用户别名或姓名，别名优先级高于姓名，如"lisi"；