完整的企业微信 API 接口调用教程:快速调用

2024-8-8 16:30| 发布者: 独行浪子| 查看: 234| 评论: 0

本文通过 access_token 凭证的方式来讲解怎么调用 企业微信 API,并一步步介绍如何获取企业微信 API 的 corpsecretcorpid、access_token 凭证以及怎么向企业微信的应用发送消息。 企业微信 API 在线地址为:https://qiyeweixin.apifox.cn/ ,这个在线地址的项目你可以克隆到 Apifox,以方便调试。话不多说,下面进入实操。

完整的企业微信 API 接口调用教程:快速调用-1.jpg

企业微信添加自建应用

1、如果你是企业微信的企业管理员,点击 “管理企业” 进入企业微信后台(不同版本可能不一样)

完整的企业微信 API 接口调用教程:快速调用-2.jpg

2、然后在 “应用管理” 下方,选择 “创建应用”

完整的企业微信 API 接口调用教程:快速调用-3.jpg

3、填写应用相关信息

完整的企业微信 API 接口调用教程:快速调用-4.jpg

4、创建成功后,即可看到 Secret 的信息,这个 Secret 就是等会儿要用的 corpsecret。

完整的企业微信 API 接口调用教程:快速调用-5.jpg

5、获取 corpid, 点击 “我的企业” 即可看到企业 ID ,这个企业 ID 就是 corpid

完整的企业微信 API 接口调用教程:快速调用-6.jpg

企业微信获取access_token 凭证

为方便企业微信 API 的调试,下面使用 Apifox 获取 access_token 凭证。企业微信API 的 access_token 是应用调用 api 的凭证,由 corpid 和 corpsecret 换取。
请求方式: GET(HTTPS
请求 URL: https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
使用 Apifox 发送 GET 请求即可得到 access_token(请把截图中的 corpid、corpsecret 换为自己的 corpid(企业 ID)、应用 secret)。企业微信 API 在线地址为:https://qiyeweixin.apifox.cn/ ,这个在线地址的项目你可以克隆到 Apifox,以方便调试。

完整的企业微信 API 接口调用教程:快速调用-7.jpg

企业微信发送应用消息

企业微信的应用支持推送文本、图片、视频、文件、图文等类型。
请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN
企业微信的 touser

获取 touser,通讯录列表的成员账号就是 touser。

完整的企业微信 API 接口调用教程:快速调用-8.jpg

企业微信的 agentid

每个应用都有唯一的 agentid。在“管理后台”->“应用管理”->“应用”,点进某个应用,即可看到 agentid。

完整的企业微信 API 接口调用教程:快速调用-9.jpg

构造消息体

可以发送文本、图片、视频等多种类型的应用消息,这里以最简单的文本消息为例:(注意修改 touser、agentid 为自己想要的接收者 userid 列表、应用 id)

{   "touser" : "abelzhu|ZhuShengben",   "msgtype" : "text",   "agentid" : 1000002,   "text" : {       "content" : "我就试一下"   },   "safe":0}发送消息

如下图示,有了 access_tokentouser、agentid消息体,在 Apifox 中发送 post 请求即可(红色箭头所指为需要注意的点)

完整的企业微信 API 接口调用教程:快速调用-10.jpg

如果报错返回"errcode": 60020,那么你需要配置可信任域名。在“应用管理”->“企业可信 IP”下配置即可。这里需要你下载WW_verify_7x7IN1QfqcsOLA6J.txt文件,并将其放到域名的根目录下,然后验证。

完整的企业微信 API 接口调用教程:快速调用-11.jpg

响应成功

如下图所示,在企业微信里,成功响应了消息回来。

完整的企业微信 API 接口调用教程:快速调用-12.jpg

使用 Apifox 调试、管理接口


  • Apifox: 我们团队深入使用两年的 API 接口调试工具
Apifox 是一个比 Postman 更强大的接口测试工具,Apifox = Postman + Swagger + Mock + JMeter,Apifox 支持调试 http (s)、WebSocket、Socket、gRPC、Dubbo 等协议的接口,并且集成了 IDEA 插件。在开发完接口后,可以通过 Apifox 的 IDEA 插件一键生成接口文档,多端同步,非常方便测试和维护。

  • 什么是 gRPC
  • 一个 HTTP 请求需要具备的 5 个要点

完整的企业微信 API 接口调用教程:快速调用-13.jpg


完整的企业微信 API 接口调用教程:快速调用-14.jpg
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

上一篇:企业微信如何通过短链接加友?

下一篇:企业微信如何完成认证?

交流热线
17501437970 周一至周日:09:00 - 21:00

创赢网-致力于帮助普通人在创业之路上披荆斩棘、走向成功的专业网站,汇聚创新智慧与成功机遇的网络天地,是创业者开启赢之征程的首选之地。

Powered by Discuz! X3.5 © 2023-2050 CHUANYING Team.

QQ|Archiver|手机版|小黑屋|创赢网 ( 湘ICP备17022177号-3 )

GMT+8, 2024-11-22 23:33 , Processed in 0.209948 second(s), 32 queries .

快速回复 返回顶部 返回列表