diff --git a/doc/api/README.md b/doc/api/README.md new file mode 100644 index 0000000..eec6650 --- /dev/null +++ b/doc/api/README.md @@ -0,0 +1,18 @@ +# API 文档 +已完成以及未完成API列表汇总 + +如果有兴趣参与贡献，可以在具体的API表格后面标识自己为贡献者以及完成时间，例如： + + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者|完成时间| +| :---------------------: | -------- | :------------------------- | ---------- | -------- |-------- |-------- | +| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | NO | |silenceper| 2021-12-20| + + +- [微信公众号](./officialaccount.md) +- [小程序](./miniprogram.md) +- [小游戏](./minigame.md) +- [开放平台](./oplatform.md) +- [微信支付](./wxpay.md) +- [企业微信](./work.md) +- [智能对话](./aispeech.md) diff --git a/doc/api/aispeech.md b/doc/api/aispeech.md new file mode 100644 index 0000000..37d758f --- /dev/null +++ b/doc/api/aispeech.md @@ -0,0 +1,2 @@ +# 智能对话 +TODO diff --git a/doc/api/minigame.md b/doc/api/minigame.md new file mode 100644 index 0000000..db5697d --- /dev/null +++ b/doc/api/minigame.md @@ -0,0 +1,2 @@ +# 小游戏 +TODO \ No newline at end of file diff --git a/doc/api/miniprogram.md b/doc/api/miniprogram.md new file mode 100644 index 0000000..dbc422f --- /dev/null +++ b/doc/api/miniprogram.md @@ -0,0 +1,2 @@ +# 小程序 +TODO \ No newline at end of file diff --git a/doc/api/officialaccount.md b/doc/api/officialaccount.md new file mode 100644 index 0000000..b1d2543 --- /dev/null +++ b/doc/api/officialaccount.md @@ -0,0 +1,180 @@ +# 微信公众号API列表 + +## 基础接口 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| :---------------------: | -------- | :------------------------- | ---------- | -------- | +| 获取Access token | GET | /cgi-bin/token | YES | | +| 获取微信服务器IP地址 | GET | /cgi-bin/get_api_domain_ip | YES | | +| 获取微信callback IP地址 | GET | /cgi-bin/getcallbackip | YES | | +| 清理接口调用次数 | POST | /cgi-bin/clear_quota | YES | | + +## 订阅通知 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| -------------------- | -------- | -------------------------------------- | ---------- | ----------------------- | +| 选用模板 | POST | /wxaapi/newtmpl/addtemplate | YES | (tpl *Subscribe) Add | +| 删除模板 | POST | /wxaapi/newtmpl/deltemplate | YES | (tpl *Subscribe) Delete | +| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | NO | | +| 获取模板中的关键词 | GET | /wxaapi/newtmpl/getpubtemplatekeywords | NO | | +| 获取类目下的公共模板 | GET | /wxaapi/newtmpl/getpubtemplatetitles | NO | | +| 获取私有模板列表 | GET | /wxaapi/newtmpl/gettemplate | YES | (tpl *Subscribe) List() | +| 发送订阅通知 | POST | /cgi-bin/message/subscribe/bizsend | YES | (tpl *Subscribe) Send | + +## 客服消息 + +### PC 客服能力 + +#### 客服管理 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Customer_Service_Management.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ---------------- | --------- | -------------------------------------- | ---------- | -------- | +| 获取客服基本信息 | GET | /cgi-bin/customservice/getkflist | NO | | +| 添加客服帐号 | POST | /customservice/kfaccount/add | NO | | +| 邀请绑定客服帐号 | POST | /customservice/kfaccount/inviteworker | NO | | +| 设置客服信息 | POST | /customservice/kfaccount/update | NO | | +| 上传客服头像 | POST/FORM | /customservice/kfaccount/uploadheadimg | NO | | +| 删除客服帐号 | GET | /customservice/kfaccount/del | NO | | + +#### 会话控制 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Session_control.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------ | -------- | --------------------------------------- | ---------- | -------- | +| 创建会话 | POST | /customservice/kfsession/create | NO | | +| 获取客户会话状态 | GET | /customservice/kfsession/getsession | NO | | +| 获取客服会话列表 | GET | /customservice/kfsession/getsessionlist | NO | | +| 获取未接入会话列表 | POST | /customservice/kfsession/getwaitcase | NO | | + +#### 获取聊天记录 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Obtain_chat_transcript.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------ | -------- | ----------------------------------- | ---------- | -------- | +| 获取聊天记录 | POST | /customservice/msgrecord/getmsglist | NO | | + +### 对话能力 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide.html) + +#### 顾问管理 + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------------------ | -------- | -------------------------------------- | ---------- | -------- | +| 添加顾问 | POST | /cgi-bin/guide/addguideacct | NO | | +| 获取顾问信息 | POST | /cgi-bin/guide/getguideacct | NO | | +| 修改顾问信息 | POST | /cgi-bin/guide/updateguideacct | NO | | +| 删除顾问 | POST | /cgi-bin/guide/delguideacct | NO | | +| 获取服务号顾问列表 | POST | /cgi-bin/guide/getguideacctlist | NO | | +| 生成顾问二维码 | POST | /cgi-bin/guide/guidecreateqrcode | NO | | +| 获取顾问聊天记录 | POST | /cgi-bin/guide/getguidebuyerchatrecord | NO | | +| 设置快捷回复与关注自动回复 | POST | /cgi-bin/guide/setguideconfig | NO | | +| 获取快捷回复与关注自动回复 | POST | /cgi-bin/guide/getguideconfig | NO | | +| 设置敏感词与离线自动回复 | POST | /cgi-bin/guide/setguideacctconfig | NO | | +| 获取离线自动回复与敏感词 | POST | /cgi-bin/guide/getguideacctconfig | NO | | +| 允许微信用户复制小程序页面路径 | POST | /cgi-bin/guide/pushshowwxapathmenu | NO | | +| 新建顾问分组 | POST | /cgi-bin/guide/newguidegroup | NO | | +| 获取顾问分组列表 | POST | /cgi-bin/guide/getguidegrouplist | NO | | +| 获取顾问分组信息 | POST | /cgi-bin/guide/getgroupinfo | NO | | +| 分组内添加顾问 | POST | /cgi-bin/guide/addguide2guidegroup | NO | | +| 分组内删除顾问 | POST | /cgi-bin/guide/delguide2guidegroup | NO | | +| 获取顾问所在分组 | POST | /cgi-bin/guide/getgroupbyguide | NO | | +| 删除指定顾问分组 | POST | /cgi-bin/guide/delguidegroup | NO | | + +#### 客户管理 + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------------ | -------- | ------------------------------------------- | ---------- | -------- | +| 为顾问分配客户 | POST | /cgi-bin/guide/addguidebuyerrelation | NO | | +| 为顾问移除客户 | POST | /cgi-bin/guide/delguidebuyerrelation | NO | | +| 获取顾问的客户列表 | POST | /cgi-bin/guide/getguidebuyerrelationlist | NO | | +| 为客户更换顾问 | POST | /cgi-bin/guide/rebindguideacctforbuyer | NO | | +| 修改客户昵称 | POST | /cgi-bin/guide/updateguidebuyerrelation | NO | | +| 查询客户所属顾问 | POST | /cgi-bin/guide/getguidebuyerrelationbybuyer | NO | | +| 查询指定顾问和客户的关系 | POST | /cgi-bin/guide/getguidebuyerrelation | NO | | + +#### 标签管理 + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------ | -------- | -------------------------------------- | ---------- | -------- | +| 新建标签类型 | POST | /cgi-bin/guide/newguidetagoption | NO | | +| 删除标签类型 | POST | /cgi-bin/guide/delguidetagoption | NO | | +| 为标签添加可选值 | POST | /cgi-bin/guide/addguidetagoption | NO | | +| 获取标签和可选值 | POST | /cgi-bin/guide/getguidetagoption | NO | | +| 为客户设置标签 | POST | /cgi-bin/guide/addguidebuyertag | NO | | +| 查询客户标签 | POST | /cgi-bin/guide/getguidebuyertag | NO | | +| 根据标签值筛选客户 | POST | /cgi-bin/guide/queryguidebuyerbytag | NO | | +| 删除客户标签 | POST | /cgi-bin/guide/delguidebuyertag | NO | | +| 设置自定义客户信息 | POST | /cgi-bin/guide/addguidebuyerdisplaytag | NO | | +| 获取自定义客户信息 | POST | /cgi-bin/guide/getguidebuyerdisplaytag | NO | | + +#### 素材管理 + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------ | -------- | ------------------------------------ | ---------- | -------- | +| 添加小程序卡片素材 | POST | /cgi-bin/guide/setguidecardmaterial | NO | | +| 查询小程序卡片素材 | POST | /cgi-bin/guide/getguidecardmaterial | NO | | +| 删除小程序卡片素材 | POST | /cgi-bin/guide/delguidecardmaterial | NO | | +| 添加图片素材 | POST | /cgi-bin/guide/setguideimagematerial | NO | | +| 查询图片素材 | POST | /cgi-bin/guide/getguideimagematerial | NO | | +| 删除图片素材 | POST | /cgi-bin/guide/delguideimagematerial | NO | | +| 添加文字素材 | POST | /cgi-bin/guide/setguidewordmaterial | NO | | +| 查询文字素材 | POST | /cgi-bin/guide/getguidewordmaterial | NO | | +| 删除文字素材 | POST | /cgi-bin/guide/delguidewordmaterial | NO | | + +#### 群发任务管理 + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| -------------------- | -------- | ------------------------------------- | ---------- | -------- | +| 添加群发任务 | POST | /cgi-bin/guide/addguidemassendjob | NO | | +| 获取群发任务列表 | POST | /cgi-bin/guide/getguidemassendjoblist | NO | | +| 获取指定群发任务信息 | POST | /cgi-bin/guide/getguidemassendjob | NO | | +| 修改群发任务 | POST | /cgi-bin/guide/updateguidemassendjob | NO | | +| 取消群发任务 | POST | /cgi-bin/guide/cancelguidemassendjob | NO | | + +## 微信网页开发 + +[官方文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html) + +| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | +| ------------------------------------------------------------ | -------- | --------------------------------------------------- | ---------- | ----------------------------------- | +| 获取跳转的url地址 | GET | https://open.weixin.qq.com/connect/oauth2/authorize | YES | (oauth *Oauth) GetRedirectURL | +| 获取网页应用跳转的url地址 | GET | https://open.weixin.qq.com/connect/qrconnect | YES | (oauth *Oauth) GetWebAppRedirectURL | +| 通过网页授权的code 换取access_token(区别于context中的access_token) | GET | /sns/oauth2/access_token | YES | (oauth *Oauth) GetUserAccessToken | +| 刷新access_token | GET | /sns/oauth2/refresh_token? | YES | (oauth *Oauth) RefreshAccessToken | +| 检验access_token是否有效 | GET | /sns/auth | YES | (oauth *Oauth) CheckAccessToken( | +| 拉取用户信息(需scope为 snsapi_userinfo) | GET | /sns/userinfo | YES | (oauth *Oauth) GetUserInfo | +| 获取jssdk需要的配置参数 | GET | /cgi-bin/ticket/getticket | YES | (js *Js) GetConfig | + +## 素材管理 + +## 图文消息留言管理 + +## 用户管理 + +## 账号管理 + +## 数据统计 + +## 微信卡券 + +## 微信门店 + +## 智能接口 + +## 微信设备功能 + +## 微信“一物一码” + +## 微信发票 + +## 微信非税缴费 + diff --git a/doc/api/oplatform.md b/doc/api/oplatform.md new file mode 100644 index 0000000..69f56ae --- /dev/null +++ b/doc/api/oplatform.md @@ -0,0 +1 @@ +# 开放平台 diff --git a/doc/api/work.md b/doc/api/work.md new file mode 100644 index 0000000..882856e --- /dev/null +++ b/doc/api/work.md @@ -0,0 +1,2 @@ +# 企业微信 +TODO \ No newline at end of file diff --git a/doc/api/wxpay.md b/doc/api/wxpay.md new file mode 100644 index 0000000..6fce640 --- /dev/null +++ b/doc/api/wxpay.md @@ -0,0 +1,2 @@ +# 微信支付 +TODO