企业微信API使用基本教程(企业微信的api接口)

本文介绍了如何在企业微信创建自建应用,包括获取API配置参数如corpid和corpsecret,使用云函数进行API开发,以及配置和使用Webhook来处理回调事件,特别是针对通讯录变更的处理流程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

在企业微信创建自建应用

1、登录企业微信后台,在“应用管理>自建”中点击“创建应用”,填写应用信息创建。

API配置表参数值获取

1、corpid:企业ID。在企业微信后台的“我的企业>企业信息”中获取。

2、corpsecret:应用凭证密匙。在自建应用详情中获取。

如果要使用通讯录相关API则corpsecret在“管理工具>通讯录同步”中获取。

3、AesKey及token:加密的AES KEY和消息token。

如果是接收外部联系人变更回调等事件信息,则在“自建应用详情>接收消息>设置API接收”中获取。

如果是接收通讯录相关回调事件信息,则在“管理工具>通讯录同步>设置接收事件服务器”中获取。

云函数使用

1、根据企业微信API模板创建云函数

2、参照上文填写配置参数。

3、在编程中编写API。可使用$modules.wcworkApi调用部分已封装API,使用$output输出。

鼠标移入可查看API说明。

4、保存测试。

编写完成后,点击右上方的保存按钮保存代码,并将此云函数开启。

在编程下方展开在线调试工具,点击测试,查看运行结果。

5、在功能中调用云函数。

确保云函数无误开启后,在功能中创建API步骤,选择“自定义API”,在选择对应云函数加以调用。

Webhook使用

1、以与云函数类似的方式创建webhook,并配置相关参数。

2、按照以下格式编写代码

async function hook($req, $resp, $modules = modules) {
     //get 请求用于验证有效性 
     if ($req.method == "GET") { 
     //处理已封装,可直接调用
         $resp.body = await modules.wxworkApi.getVerifyMsg($req);
     } else if ($req.method == "POST") {
         //无法保证在五秒内处理完成,先回复(企业微信服务器在五秒内收不到响应会断掉连接)
         $resp.body = "success"; 
        //处理
         let handle = async () => {
             //将数据转换成json
             let data = await modules.wxworkApi.getMsgData($req);  
           if (data.Event == "change_contact" && data.ChangeType == "create_party") { 
                 //TODO 处理添加部门事件
             } 
        }
         handle(); 
    } }

3、保存代码,复制webhook路径。

4、在企业微信后台的消息回调配置中(自建应用的API接收消息或通讯录同步中的接收消息服务器设置)将复制的webhook路径粘贴到url中。保存时将验证有效性。

5、在浏览器中直接打开webhook路径应显示“ok”。使用企业微信做相关操作触发回调以检测webhook处理结果。

### 如何通过企业微信API实现扫码添加微信功能 要通过企业微信API实现扫码添加微信的功能,主要涉及以下几个方面: #### 1. **创建外部联系人二维码** 创建一个带有参数的二维码,用户扫描该二维码后可直接关注企业的微信账号并成为其外部联系人。此过程依赖于企业微信提供的 `external_contact` 接口使用企业微信API文档中的方法为: - 获取带参二维码接口:`/cgi-bin/business/getcallbackurl?access_token=ACCESS_TOKEN` 需要注意的是,在调用上述接口前,需先获取访问令牌(Access Token)。以下是获取 Access Token 的代码示例[^3]: ```php function getAccessToken($corpId, $corpSecret) { $url = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=$corpId&corpsecret=$corpSecret"; $response = file_get_contents($url); $data = json_decode($response, true); return isset($data['access_token']) ? $data['access_token'] : null; } ``` 调用成功后返回的结果中会包含有效的 access token 值。 #### 2. **生成二维码图片** 利用第一步获得的 access token 来请求具体的二维码数据。下面是一个 PHP 示例函数用于生成二维码链接: ```php function createExternalContactQrCode($accessToken, $sceneStr){ $url = "https://qyapi.weixin.qq.com/cgi-bin/crm/addcontactway?access_token=" . $accessToken; $postData = array( 'type' => 1, 'scene' => 1, 'style' => '', 'remark' => '', 'skip_verify' => false, 'state' => $sceneStr ); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL,$url); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($postData)); curl_setopt($ch, CURLOPT_RETURNTRANSFER,true); $result=curl_exec ($ch); curl_close ($ch); return json_decode($result, true); } ``` 这里 `$sceneStr` 是自定义场景值,可用于区分不同的渠道来源或者活动标识等用途。 #### 3. **处理回调事件** 当客户完成扫码操作之后,企业微信服务器将会向预先设置好的URL发送通知消息。开发者需要解析这些推送过来的消息内容,并按照业务需求做出响应动作。具体流程可以参考官方说明文档关于接收事件的部分。 --- ### 注意事项 - 确保已经开通了企业微信的相关权限和服务。 - 如果希望进一步定制化显示效果,则可以通过修改 CSS 文件的方式调整样式布局。 ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

开源商城源码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值