Skip to content

Y
yzg-util
Commit 179ac129 authored by xianjun's avatar xianjun
Browse files
Options

创建微信小程序接口文档

parent 7ab504bc
Hide whitespace changes
Inline Side-by-side
Showing with 7306 additions and 586 deletions
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/login/code2Session.md deleted 100644 → 0
View file @ 7ab504bc
# auth.code2Session
> 本接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
登录凭证校验。通过 [wx.login](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html) 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)。
### 请求地址
```text
GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
```
### 请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
| :--------- | :----- | :----- | :--- | :---------------------------------------- |
| appid | string | | 是 | 小程序 appId |
| secret | string | | 是 | 小程序 appSecret |
| js_code | string | | 是 | 登录时获取的 code |
| grant_type | string | | 是 | 授权类型，此处只需填写 authorization_code |
### 返回值
### Object
返回的 JSON 数据包
| 属性 | 类型 | 说明 |
| :---------- | :----- | :----------------------------------------------------------- |
| openid | string | 用户唯一标识 |
| session_key | string | 会话密钥 |
| unionid | string | 用户在开放平台的唯一标识符，若当前小程序已绑定到微信开放平台帐号下会返回，详见 [UnionID 机制说明](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/union-id.html)。 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
**errcode 的合法值**
| 值 | 说明 | 最低版本 |
| :---- | :----------------------------------------------------------- | :------- |
| -1 | 系统繁忙，此时请开发者稍候再试 | |
| 0 | 请求成功 | |
| 40029 | code 无效 | |
| 45011 | 频率限制，每个用户每分钟100次 | |
| 40226 | 高风险等级用户，小程序登录拦截 。风险等级详见[用户安全解方案](https://developers.weixin.qq.com/miniprogram/dev/framework/operation.html#%E7%94%A8%E6%88%B7%E5%AE%89%E5%85%A8%E8%A7%A3%E5%86%B3%E6%96%B9%E6%A1%88) | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/checkEncryptedData.md deleted 100644 → 0
View file @ 7ab504bc
用户信息 /checkEncryptedData
# auth.checkEncryptedData
> 本接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据
调用方式：
- [HTTPS 调用](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html#method-http)
- [云调用](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html#method-cloud)
## HTTPS 调用
### 请求地址
```text
POST https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=ACCESS_TOKEN
```
### 请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
| :----------------- | :----- | :----- | :--- | :------------------------------------------------ |
| encrypted_msg_hash | string | | 是 | 加密数据的sha256，通过Hex（Base16）编码后的字符串 |
### 返回值
### Object
返回的 JSON 数据
| 属性 | 类型 | 说明 |
| :---------- | :------ | :------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误提示信息 |
| vaild | boolean | 是否是合法的数据 |
| create_time | number | 加密数据生成的时间戳 |
**errcode 的合法值**
| 值 | 说明 | 最低版本 |
| :---- | :----------------------------------------------------------- | :------- |
| 0 | 请求成功 | |
| -1 | 系统繁忙，此时请开发者稍候再试 | |
| 1 | 加密数据不存在，数据生成的时间超过保存的限制（3天）或者 key 不存在 | |
| 40097 | 请求里的encrypted_msg_hash参数无效 | |
| 44002 | 传入的数据为空 | |
| 47001 | 传入的数据格式错误 | |
### 调用示例
```text
加密数据为: hsSuSUsePBqSQw2rYMtf9Nvha603xX8f2BMQBcYRoJiMNwOqt/UEhrqekebG5ar0LFNAm5MD4Uz6zorRwiXJwbySJ/FEJHav4NsobBIU1PwdjbJWVQLFy7+YFkHB32OnQXWMh6ugW7Dyk2KS5BXp1f5lniKPp1KNLyNLlFlNZ2mgJCJmWvHj5AI7BLpWwoRvqRyZvVXo+9FsWqvBdxmAPA==
sha256: 657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c
curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"encrypted_msg_hash": "657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c"}' http://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=ACCESS_TOKEN
```
### 返回结果示例
```json
{
"errcode": 0,
"errmsg": "ok",
"vaild": true,
"create_time" :1629121902
}
```
## 云调用
> [云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 `wx-server-sdk` 使用。
### 接口方法
```js
openapi.auth.checkEncryptedData
```
> 需在 `config.json` 中配置 `auth.checkEncryptedData` API 的权限，[详情](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html#usage-3)
### 请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
| :--------------- | :----- | :----- | :--- | :------------------------------------------------ |
| encryptedMsgHash | string | | 是 | 加密数据的sha256，通过Hex（Base16）编码后的字符串 |
### 返回值
### Object
返回的 JSON 数据
| 属性 | 类型 | 说明 |
| :--------- | :------ | :------------------- |
| errCode | number | 错误码 |
| errMsg | string | 错误提示信息 |
| vaild | boolean | 是否是合法的数据 |
| createTime | number | 加密数据生成的时间戳 |
**errCode 的合法值**
| 值 | 说明 | 最低版本 |
| :--- | :--- | :------- |
| 0 | 成功 | |
### 异常
### Object
抛出的异常
| 属性 | 类型 | 说明 |
| :------ | :----- | :----------- |
| errCode | number | 错误码 |
| errMsg | string | 错误提示信息 |
**errCode 的合法值**
| 值 | 说明 | 最低版本 |
| :---- | :----------------------------------------------------------- | :------- |
| -1 | 系统繁忙，此时请开发者稍候再试 | |
| 1 | 加密数据不存在，数据生成的时间超过保存的限制（3天）或者 key 不存在 | |
| 40097 | 请求里的encrypted_msg_hash参数无效 | |
| 44002 | 传入的数据为空 | |
| 47001 | 传入的数据格式错误 | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/base/WxXcxConfig.java
View file @ 179ac129
...@@ -47,6 +47,18 @@ public class WxXcxConfig { ...@@ -47,6 +47,18 @@ public class WxXcxConfig {
@Value("${yzg.wx.xcx.authGetPaidUnionId:/wxa/getpaidunionid}") @Value("${yzg.wx.xcx.authGetPaidUnionId:/wxa/getpaidunionid}")
private String authGetPaidUnionId; private String authGetPaidUnionId;
/**
* 用户支付完成后，获取该用户的 UnionId
*/
@Value("${yzg.wx.xcx.getUserEncryptKey:/wxa/business/getuserencryptkey}")
private String getUserEncryptKey;
/**
* 用户支付完成后，获取该用户的 UnionId
*/
@Value("${yzg.wx.xcx.getPhoneNumber:/wxa/business/getuserphonenumber}")
private String getPhoneNumber;
/** /**
* 换取插件用户的唯一标识 openpid * 换取插件用户的唯一标识 openpid
*/ */
...@@ -306,6 +318,14 @@ public class WxXcxConfig { ...@@ -306,6 +318,14 @@ public class WxXcxConfig {
@Value("${yzg.wx.xcx.clearQuota:/cgi-bin/openapi/rid/get}") @Value("${yzg.wx.xcx.clearQuota:/cgi-bin/openapi/rid/get}")
private String getRidInfo; private String getRidInfo;
public String getGetPhoneNumber() {
return getPhoneNumber;
}
public String getGetUserEncryptKey() {
return getUserEncryptKey;
}
public String getGetApiQuota() { public String getGetApiQuota() {
return getApiQuota; return getApiQuota;
} }
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkGenerateReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkGenerateReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
/** /**
* 获取小程序 URL Link 请求 * 获取小程序 URL Link 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkGenerateRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkGenerateRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkGenerateRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkGenerateRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkQueryReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkQueryReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
/** /**
* 查询小程序 url_link 配置 请求 * 查询小程序 url_link 配置 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkQueryRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkQueryRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/WxXcxUrlLinkQueryRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/WxXcxUrlLinkQueryRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink; package com.yanzuoguang.wxxcx.codeorlink.urllink;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/generateUrlLink.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /URL Link /获取 URL Link
# 获取 URL Link
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
generateUrlLink
### 功能描述
获取小程序 URL Link，适用于短信、邮件、网页、微信内等拉起小程序的业务场景。通过该接口，可以选择生成到期失效和永久有效的小程序链接，有数量限制，目前仅针对国内非个人主体的小程序开放，详见[获取 URL Link](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/url-link.html)
### 注意事项
#### 调用上限
Link 将根据是否为到期有效与失效时间参数，分为短期有效Link 与 长期有效Link：
- 单个小程序每日生成 Link 上限为50万个（包含短期有效 Link 与长期有效 Link ）
- 有效时间超过180天的 Link 或永久有效的 Link 为长期有效Link，单个小程序总共可生成长期有效 Link 上限为10万个，请谨慎调用
- 有效时间不超过180天的 Link 为短期有效Link，单个小程序生成短期有效 Link 不设上限
#### 返回值说明
- 如果调用成功，会直接返回生成的小程序 URL Link。如果请求失败，会返回 JSON 格式的数据。
#### 其他注意事项
- 只能生成已发布的小程序的 URL Link。
- 在微信内或者安卓手机打开 URL Link 时，默认会先跳转官方 H5 中间页，如果需要定制 H5 内容，可以使用云开发静态网站。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/generate_urllink?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.urllink.generate
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：88、115
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :------ | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | path | string | 否 | 通过 URL Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query 。path 为空时会跳转小程序主页 |
| | query | string | 否 | 通过 URL Link 进入小程序时的query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~% |
| | is_expire | boolean | 否 | 默认值false。生成的 URL Link 类型，到期失效：true，永久有效：false。注意，永久有效 Link 和有效时间超过180天的到期失效 Link 的总数上限为10万个，详见[获取 URL Link](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/url-link.html)，生成 Link 前请仔细确认。 |
| | expire_type | number | 否 | 默认值0.小程序 URL Link 失效类型，失效时间：0，失效间隔天数：1 |
| | expire_time | number | 否 | 到期失效的 URL Link 的失效时间，为 Unix 时间戳。生成的到期失效 URL Link 在该时间前有效。最长有效期为1年。expire_type 为 0 必填 |
| | expire_interval | number | 否 | 到期失效的URL Link的失效间隔天数。生成的到期失效URL Link在该间隔时间到达前有效。最长间隔天数为365天。expire_type 为 1 必填 |
| | cloud_base | object | 否 | 云开发静态网站自定义 H5 配置参数，可配置中转的云开发 H5 页面。不填默认用官方 H5 页面 |
| | 属性类型必填说明envstring是云开发环境domainstring否静态网站自定义域名，不填则使用默认域名pathstring否云开发静态网站 H5 页面路径，不可携带 queryquerystring否云开发静态网站 H5 页面 query 参数，最大 1024 个字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~%``resource_appidstring否第三方批量代云开发时必填，表示创建该 env 的 appid （小程序/第三方平台） | | | |
| | env_version | string | 否 | 默认值"release"。要打开的小程序版本。正式版为 "release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------- | :----- | :-------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| url_link | string | 生成的小程序 URL Link |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"path": "/pages/publishHomework/publishHomework",
"query": "",
"is_expire":true,
"expire_type":1,
"expire_interval":1,
"env_version": "release",
"cloud_base":
{
"env": "xxx",
"domain": "xxx.xx",
"path": "/jump-wxa.html",
"query": "a=1&b=2"
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"url_link": "URL Link"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.urllink.generate({
"path": '/pages/publishHomework/publishHomework',
"query": '',
"isExpire": true,
"expireType": 1,
"expireInterval": 1,
"envVersion": 'release',
"cloudBase": {
"env": 'xxx',
"domain": 'xxx.xx',
"path": '/jump-wxa.html',
"query": 'a=1&b=2'
}
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "ok",
"urlLink": "URL Link"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------------------------------------------------------- | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40013 | invalid appid | 不合法的 AppID ，请开发者检查 AppID 的正确性，避免异常字符，注意大小写 |
| 40002 | 暂无生成权限（非个人主体小程序无权限，未申请 NFC 能力的小程序无权限） | |
| 40013 | 生成权限被封禁 | |
| 85079 | miniprogram has no online release | 小程序没有线上版本，即小程序尚未发布，不可进行该操作 |
| 40165 | invalid weapp pagepath | 参数 path 填写错误，更正后重试 |
| 40212 | invalid query | 参数 query 填写错误 ，query格式遵循 URL 标准，即k1=v1&k2=v2 |
| 85401 | time limit between 1min and 1year | 参数expire_time填写错误，时间间隔大于1分钟且小于1年，更正后重试 |
| 85402 | invalid env_version | 参数env_version填写错误，更正后重试 |
| 44990 | reach max api second frequence limit | 频率过快，超过100次/秒；降低调用频率 |
| 44993 | reach max api day frequence limit | 单天生成Scheme+URL Link数量超过上限50万 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/queryUrlLink.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /URL Link /查询 URL Link
# 查询 URL Link
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
queryUrlLink
### 功能描述
该接口用于查询小程序 url_link 配置，及长期有效 quota
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/query_urllink?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.urllink.query
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：88、115
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| url_link | string | 否 | 小程序 url_link |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :------------ |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | url_link_info | object | url_link 配置 |
| | 属性类型说明appidstring小程序 appidpathstring小程序页面路径querystring小程序页面querycreate_timenumber创建时间，为 Unix 时间戳expire_timenumber到期失效时间，为 Unix 时间戳，0 表示永久生效env_versionstring要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop" | | |
| | url_link_quota | object | quota 配置 |
| | 属性类型说明long_time_usednumber长期有效 url_link 已生成次数long_time_limitnumber长期有效 url_link 生成次数上限 | | |
| | visit_openid | string | |
## 调用示例
> 示例说明: HTTPS调用示例
### 请求数据示例
```json
{
"url_link": "https://wxaurl.cn/BQZRrcFCPvg"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"url_link_info": {
"appid": "appid",
"path": "",
"query": "",
"create_time": 611928113,
"expire_time": 0,
"env_version": "release",
"cloud_base" : {
"env": "",
"doamin": "",
"path": "",
"query": "",
"resource_appid": ""
}
},
"url_link_quota": {
"long_time_used": 100,
"long_time_limit": 100000
}
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.urllink.query({
"urlLink": 'https://wxaurl.cn/BQZRrcFCPvg'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"urlLinkInfo": {
"appid": "appid",
"path": "",
"query": "",
"createTime": 611928113,
"expireTime": 0,
"envVersion": "release",
"cloudBase" : {
"env": "",
"doamin": "",
"path": "",
"query": "",
"resourceAppid": ""
}
},
"urlLinkQuota": {
"longTimeUsed": 100,
"longTimeLimit": 100000
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40097 | invalid args | 参数错误 |
| 85403 | not found | scheme/url link不存在 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/service/WxXcxUrlLinkGenerateService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/service/WxXcxUrlLinkGenerateService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink.service; package com.yanzuoguang.wxxcx.codeorlink.urllink.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkGenerateReq; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkGenerateReq;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkGenerateRes; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkGenerateRes;
/** /**
* 获取小程序 URL Link 接口 * 获取小程序 URL Link 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/service/WxXcxUrlLinkQueryService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/service/WxXcxUrlLinkQueryService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink.service; package com.yanzuoguang.wxxcx.codeorlink.urllink.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkQueryReq; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkQueryReq;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkQueryRes; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkQueryRes;
/** /**
* 查询小程序 url_link 配置 接口 * 查询小程序 url_link 配置 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/service/impl/WxXcxUrlLinkGenerateServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/service/impl/WxXcxUrlLinkGenerateServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink.service.impl; package com.yanzuoguang.wxxcx.codeorlink.urllink.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkGenerateReq; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkGenerateReq;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkGenerateRequest; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkGenerateRequest;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkGenerateRes; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkGenerateRes;
import com.yanzuoguang.wxxcx.urllink.service.WxXcxUrlLinkGenerateService; import com.yanzuoguang.wxxcx.codeorlink.urllink.service.WxXcxUrlLinkGenerateService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urllink/service/impl/WxXcxUrlLinkQueryServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urllink/service/impl/WxXcxUrlLinkQueryServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urllink.service.impl; package com.yanzuoguang.wxxcx.codeorlink.urllink.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkQueryReq; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkQueryReq;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkQueryRequest; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkQueryRequest;
import com.yanzuoguang.wxxcx.urllink.WxXcxUrlLinkQueryRes; import com.yanzuoguang.wxxcx.codeorlink.urllink.WxXcxUrlLinkQueryRes;
import com.yanzuoguang.wxxcx.urllink.service.WxXcxUrlLinkQueryService; import com.yanzuoguang.wxxcx.codeorlink.urllink.service.WxXcxUrlLinkQueryService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateJumpWxaReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateJumpWxaReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
/** /**
* 获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放 * 获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateNfcReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateNfcReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
/** /**
* 获取用于 NFC 的小程序 scheme 码 请求 * 获取用于 NFC 的小程序 scheme 码 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateNfcRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateNfcRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateNfcRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateNfcRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
/** /**
* 获取小程序 scheme 码 请求 * 获取小程序 scheme 码 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeGenerateRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeGenerateRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeQueryRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeQueryRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/WxXcxUrlSchemeQueryRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/WxXcxUrlSchemeQueryRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme; package com.yanzuoguang.wxxcx.codeorlink.urlscheme;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/generateNFCScheme.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /URL Scheme /获取 NFC 的小程序 scheme
# 获取 NFC 的小程序 scheme
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
generateNFCScheme
### 功能描述
该接口用于获取用于 NFC 的小程序 scheme 码，适用于 NFC 拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放，详见 [NFC 标签打开小程序](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/NFC.html)。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/generatenfcscheme?access_token=ACCESS_TOKEN
```
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证,access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | jump_wxa | object | 否 | 跳转到的目标小程序信息。 |
| | 属性类型必填说明pathstring否通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页querystring否通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~%``env_versionstring否要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效 | | | |
| | model_id | string | 是 | scheme对应的设备model_id |
| | sn | string | 否 | scheme对应的设备sn，仅一机一码时填写 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------- | :----- | :--------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| openlink | string | 生成的小程序 scheme 码 |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"jump_wxa":
{
"path": "/pages/publishHomework/publishHomework",
"query": ""
},
"sn": "xxx",
"model_id": "xxx"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"openlink": "Scheme"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :------ | :----------------------------------------------------------- | :---------------------------------------------------------- |
| 40002 | 暂无生成权限（非个人主体小程序无权限，未申请 NFC 能力的小程序无权限） | |
| 40013 | 生成权限被封禁 | |
| 85079 | miniprogram has no online release | 小程序没有线上版本，即小程序尚未发布，不可进行该操作 |
| 40165 | invalid weapp pagepath | 参数 path 填写错误，更正后重试 |
| 40212 | invalid query | 参数 query 填写错误 ，query格式遵循 URL 标准，即k1=v1&k2=v2 |
| 85402 | invalid env_version | 参数env_version填写错误，更正后重试 |
| 44990 | reach max api second frequence limit | 频率过快，超过100次/秒；降低调用频率 |
| 44993 | reach max api day frequence limit | 单天生成Scheme+URL Link数量超过上限50万 |
| 9800003 | model_id检查不通过 | |
| 9800007 | 此model_id尚未获得该能力，请能力申请通过后再试 | |
| 9800008 | 能力类型为一机一码，sn不能为空 | |
| 9800009 | 能力类型为一型一码，sn需为空 | |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/generateScheme.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /URL Scheme /获取scheme码
# 获取 scheme 码
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
generateScheme
### 功能描述
- 该接口用于获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。通过该接口，可以选择生成到期失效和永久有效的小程序码，有数量限制，目前仅针对国内非个人主体的小程序开放，详见[获取 URL scheme](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/url-scheme.html)。
### 注意事项
#### 调用上限
Scheme 将根据是否为到期有效与失效时间参数，分为短期有效 Scheme 与长期有效Scheme：
- 单个小程序每日生成 Scheme 上限为50万个（包含短期有效 Scheme 与长期有效 Scheme）
- 有效时间超过180天的 Scheme 或永久有效的 Scheme 为长期有效Scheme，单个小程序总共可生成长期有效 Scheme 上限为10万个，请谨慎调用
- 有效时间不超过180天的 Scheme 为短期有效Scheme，单个小程序生成短期有效 Scheme 不设上限
### 其他注意事项
- 微信内的网页如需打开小程序请使用微信开放标签 - 小程序跳转按钮，无公众号也可以直接使用小程序身份开发网页并免鉴权跳转小程序，见云开发静态网站跳转小程序。符合开放范围的小程序可以下发支持打开小程序的短信
- 该功能基本覆盖当前用户正在使用的微信版本，开发者无需进行低版本兼容
- 只能生成已发布的小程序的 URL Scheme
- 通过 URL Scheme 跳转到微信时，可能会触发系统弹框询问，若用户选择不跳转，则无法打开小程序。请开发者妥善处理用户选择不跳转的场景
- 部分浏览器会限制打开网页直接跳转，可参考示例网页设置跳转按钮
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/generatescheme?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.urlscheme.generate
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：88、115
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :------ | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | jump_wxa | object | 否 | 跳转到的目标小程序信息。 |
| | 属性类型必填说明pathstring否通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。querystring否通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`!#$&'()*+,/:;=?@-._~%``env_versionstring否默认值"release"。要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop"，仅在微信外打开时生效。 | | | |
| | is_expire | boolean | 否 | 默认值false。生成的 scheme 码类型，到期失效：true，永久有效：false。注意，永久有效 scheme 和有效时间超过180天的到期失效 scheme 的总数上限为10万个，详见[获取 URL scheme](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/url-scheme.html)，生成 scheme 码前请仔细确认。 |
| | expire_time | number | 否 | 到期失效的 scheme 码的失效时间，为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为1年。is_expire 为 true 且 expire_type 为 0 时必填 |
| | expire_type | number | 否 | 默认值0，到期失效的 scheme 码失效类型，失效时间：0，失效间隔天数：1 |
| | expire_interval | number | 否 | 到期失效的 scheme 码的失效间隔天数。生成的到期失效 scheme 码在该间隔时间到达前有效。最长间隔天数为365天。is_expire 为 true 且 expire_type 为 1 时必填 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------- | :----- | :--------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| openlink | string | 生成的小程序 scheme 码 |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"jump_wxa":
{
"path": "/pages/publishHomework/publishHomework",
"query": ""
},
"is_expire":true,
"expire_time":1606737600
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"openlink": "Scheme"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.urlscheme.generate({
"jumpWxa": {
"path": '/pages/publishHomework/publishHomework',
"query": ''
},
"isExpire": true,
"expireTime": 1606737600
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"openlink": "Scheme"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 85079 | miniprogram has no online release | 小程序没有线上版本，不能进行灰度 |
| 40165 | invalid weapp pagepath | 参数 path 填写错误，更正后重试 |
| 40212 | invalid query | 参数 query 填写错误 ，query格式遵循 URL 标准，即k1=v1&k2=v2 |
| 85401 | time limit between 1min and 1year | 参数expire_time填写错误，时间间隔大于1分钟且小于1年，更正后重试 |
| 85402 | invalid env_version | 参数env_version填写错误，更正后重试 |
| 44990 | reach max api second frequence limit | 频率过快，超过100次/秒；降低调用频率 |
| 85400 | reach max long time quota limit | 长期有效 Scheme 达到生成上限10万，不可再生成。 |
| 45009 | reach max api daily quota limit | 调用超过天级别频率限制。可调用clear_quota接口恢复调用额度。 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/queryScheme.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /URL Scheme /查询scheme码
# 查询 scheme 码
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
queryScheme
### 功能描述
该接口用于查询小程序 scheme 码，及长期有效 quota。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/queryscheme?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.urlscheme.query
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：88、115
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| scheme | string | 是 | 小程序 scheme 码 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :---------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | scheme_info | object | scheme 配置 |
| | 属性类型说明appidstring小程序 appidpathstring小程序页面路径querystring小程序页面querycreate_timenumber创建时间，为 Unix 时间戳expire_timenumber到期失效时间，为 Unix 时间戳，0 表示永久生效env_versionstring要打开的小程序版本。正式版为"release"，体验版为"trial"，开发版为"develop" | | |
| | scheme_quota | object | quota 配置 |
| | 属性类型说明long_time_usednumber长期有效 scheme 已生成次数long_time_limitnumber长期有效 scheme 生成次数上限 | | |
## 调用示例
> 示例说明: HTTPS请求示例
### 请求数据示例
```json
{
"scheme": "weixin://dl/business/?t=XTSkBZlzqmn"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"scheme_info": {
"appid": "appid",
"path": "",
"query": "",
"create_time": 611928113,
"expire_time": 0,
"env_version": "release"
},
"scheme_quota": {
"long_time_used": 100,
"long_time_limit": 100000
}
}
```
> 示例说明: 云函数调用示例
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.urlscheme.query({
"scheme": 'weixin://dl/business/?t=XTSkBZlzqmn'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "ok",
"schemeInfo": {
"appid": "appid",
"path": "",
"query": "",
"createTime": 611928113,
"expireTime": 0,
"envVersion": "release"
},
"schemeQuota": {
"longTimeUsed": 100,
"longTimeLimit": 100000
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 85403 | not found | scheme/url link不存在 |
| 40097 | invalid args | 参数错误 |
| 0 | ok | ok |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/WxXcxUrlSchemeGenerateNfcService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/WxXcxUrlSchemeGenerateNfcService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateNfcReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateNfcReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateNfcRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateNfcRes;
/** /**
* 获取用于 NFC 的小程序 scheme 码 接口 * 获取用于 NFC 的小程序 scheme 码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/WxXcxUrlSchemeGenerateService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/WxXcxUrlSchemeGenerateService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateRes;
/** /**
* 获取小程序 scheme 码 接口 * 获取小程序 scheme 码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/WxXcxUrlSchemeQueryService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/WxXcxUrlSchemeQueryService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeQueryReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeQueryReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeQueryRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeQueryRes;
/** /**
* 查询小程序 scheme 码 接口 * 查询小程序 scheme 码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/impl/WxXcxUrlSchemeGenerateNfcServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/impl/WxXcxUrlSchemeGenerateNfcServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service.impl; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateNfcReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateNfcReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateNfcRequest; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateNfcRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateNfcRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateNfcRes;
import com.yanzuoguang.wxxcx.urlscheme.service.WxXcxUrlSchemeGenerateNfcService; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.WxXcxUrlSchemeGenerateNfcService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/impl/WxXcxUrlSchemeGenerateServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/impl/WxXcxUrlSchemeGenerateServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service.impl; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateRequest; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeGenerateRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeGenerateRes;
import com.yanzuoguang.wxxcx.urlscheme.service.WxXcxUrlSchemeGenerateService; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.WxXcxUrlSchemeGenerateService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/urlscheme/service/impl/WxXcxUrlSchemeQueryServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/urlscheme/service/impl/WxXcxUrlSchemeQueryServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.urlscheme.service.impl; package com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeQueryReq; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeQueryReq;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeQueryRequest; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeQueryRequest;
import com.yanzuoguang.wxxcx.urlscheme.WxXcxUrlSchemeQueryRes; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.WxXcxUrlSchemeQueryRes;
import com.yanzuoguang.wxxcx.urlscheme.service.WxXcxUrlSchemeQueryService; import com.yanzuoguang.wxxcx.codeorlink.urlscheme.service.WxXcxUrlSchemeQueryService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeCreateQrCodeRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeCreateQrCodeRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeCreateQrCodeRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeCreateQrCodeRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetLineColorReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetLineColorReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
/** /**
* auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 * auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
/** /**
* 获取小程序码 请求 * 获取小程序码 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetUnlimitedReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetUnlimitedReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
/** /**
* 获取小程序码 请求 * 获取小程序码 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetUnlimitedRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetUnlimitedRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/WxXcxWxaCodeGetUnlimitedRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/WxXcxWxaCodeGetUnlimitedRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode; package com.yanzuoguang.wxxcx.codeorlink.wxacode;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/createQRCode.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /小程序码 /获取小程序二维码
# 获取小程序二维码
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
createQRCode
### 功能描述
获取小程序二维码，适用于需要的码数量较少的业务场景。通过该接口生成的小程序码，永久有效，有数量限制，详见[获取二维码](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/qr-code.html)。
### 注意事项
- POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
- 接口只能生成已发布的小程序的二维码。开发版的带参二维码可以在开发者工具预览时生成。
- 与 [wxacode.get](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/qr-code/wxacode.get.html) 总共生成的码数量限制为 100,000，请谨慎调用。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.wxacode.create
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：17、58
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| path | string | 是 | 扫码进入的小程序页面路径，最大长度 128 字节，不能为空；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。 |
| width | number | 否 | 二维码的宽度，单位 px。最小 280px，最大 1280px;默认是430 |
### 返回参数
| 属性 | 类型 | 说明 |
| :---------- | :----- | :---------- |
| buffer | Buffer | 图片 Buffer |
| contentType | string | contentType |
| errcode | int | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS调用示例
### 请求数据示例
```json
{
"path":"page/index/index",
"width":430
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
> 示例说明: 云调用示例
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.wxacode.createQRCode({
"path": 'page/index/index',
"width": 430
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------ | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 45029 | qrcode count out of limit | 生成码个数总和到达最大个数限制 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/getQRCode.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /小程序码 /获取小程序码
# 获取小程序码
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getQRCode
### 功能描述
该接口用于获取小程序码，适用于需要的码数量较少的业务场景。通过该接口生成的小程序码，永久有效，有数量限制，详见[获取小程序码](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/qr-code.html)。
### 注意事项
- 如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 JSON 格式的数据。
- POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
- 接口只能生成已发布的小程序码
- 与 createQRCode 总共生成的码数量限制为 100,000，请谨慎调用。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/getwxacode?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.wxacode.get
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：17、58
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :------ | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | path | string | 是 | 扫码进入的小程序页面路径，最大长度 128 字节，不能为空；对于小游戏，可以只传入 query 部分，来实现传参效果，如：传入 "?foo=bar"，即可在 wx.getLaunchOptionsSync 接口中的 query 参数获取到 {foo:"bar"}。 |
| | width | number | 否 | 二维码的宽度，单位 px。默认值为430，最小 280px，最大 1280px |
| | auto_color | boolean | 否 | 默认值false；自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调 |
| | line_color | object | 否 | 默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 |
| | 属性类型必填说明r是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示g是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示b是默认值{"r":0,"g":0,"b":0} ；auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 | | | |
| | is_hyaline | boolean | 否 | 默认值false；是否需要透明底色，为 true 时，生成透明底色的小程序码 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :---------------------- |
| buffer | Buffer | 成功时返回的图片 Buffer |
| errcode | number | 失败时返回错误码 |
| errmsg | string | 失败时返回错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"path":"funpackage/questionsWall/questionInfo?question_id=22579",
"width":280
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.wxacode.get({
"path": 'page/index/index',
"width": 430
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/getUnlimitedQRCode.md 0 → 100644
View file @ 179ac129
小程序码与小程序链接 /小程序码 /获取不限制的小程序码
# 获取不限制的小程序码
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getUnlimitedQRCode
### 功能描述
该接口用于获取小程序码，适用于需要的码数量极多的业务场景。通过该接口生成的小程序码，永久有效，数量暂无限制。 更多用法详见 [获取小程序码](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/qr-code.html)。
### 注意事项
- 如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 JSON 格式的数据。
- POST 参数需要转成 JSON 字符串，不支持 form 表单提交。
- 接口只能生成已发布的小程序码
- 调用分钟频率受限（5000次/分钟），如需大量小程序码，建议预生成
#### 获取 scene 值
- scene 字段的值会作为 query 参数传递给小程序/小游戏。用户扫描该码进入小程序/小游戏后，开发者可以获取到二维码中的 scene 值，再做处理逻辑。
- 调试阶段可以使用开发工具的条件编译自定义参数 scene=xxxx 进行模拟，开发工具模拟时的 scene 的参数值需要进行 encodeURIComponent
##### 小程序
```text
Page({
onLoad (query) {
// scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
const scene = decodeURIComponent(query.scene)
}
})
```
##### 小游戏
```text
// 在首次启动时通过 wx.getLaunchOptionsSync 接口获取
const {query} = wx.getLaunchOptionsSync()
const scene = decodeURIComponent(query.scene)
// 或者在 wx.onShow 事件中获取
wx.onShow(function ({query}) {
// scene 需要使用 decodeURIComponent 才能获取到生成二维码时传入的 scene
const scene = decodeURIComponent(query.scene)
})
```
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.wxacode.getUnlimited
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：17、58
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | scene | string | 是 | 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式） |
| | page | string | 否 | 默认是主页，页面 page，例如 pages/index/index，根路径前不要填加 /，不能携带参数（参数请放在 scene 字段里），如果不填写这个字段，默认跳主页面。 |
| | check_path | bool | 否 | 默认是true，检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用。 |
| | env_version | string | 否 | 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"。默认是正式版。 |
| | width | number | 否 | 默认430，二维码的宽度，单位 px，最小 280px，最大 1280px |
| | auto_color | bool | 否 | 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false |
| | line_color | object | 否 | 默认是{"r":0,"g":0,"b":0} 。auto_color 为 false 时生效，使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"} 十进制表示 |
| | 属性类型必填说明 | | | |
| | is_hyaline | bool | 否 | 默认是false，是否需要透明底色，为 true 时，生成透明底色的小程序 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :---------------------- |
| buffer | Buffer | 成功时返回的图片 Buffer |
| errcode | number | 失败时返回错误码 |
| errmsg | string | 失败时返回错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"page": "pages/index/index",
"scene": "a=1",
"check_path": true,
"env_version": "release"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.wxacode.getUnlimited({
"page": 'pages/index/index',
"scene": 'a=1',
"checkPath": true,
"envVersion": 'release'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/WxXcxWxaCodeCreateQrCodeService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/WxXcxWxaCodeCreateQrCodeService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeCreateQrCodeReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeCreateQrCodeReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeCreateQrCodeRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeCreateQrCodeRes;
/** /**
* 获取小程序二维码 接口 * 获取小程序二维码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/WxXcxWxaCodeGetService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/WxXcxWxaCodeGetService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetRes;
/** /**
* 获取小程序码 接口 * 获取小程序码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/WxXcxWxaCodeGetUnlimitedService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/WxXcxWxaCodeGetUnlimitedService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetUnlimitedReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetUnlimitedReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetUnlimitedRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetUnlimitedRes;
/** /**
* 获取小程序码 接口 * 获取小程序码 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/impl/WxXcxWxaCodeCreateQrCodeServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/impl/WxXcxWxaCodeCreateQrCodeServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service.impl; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeCreateQrCodeReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeCreateQrCodeReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeCreateQrCodeRequest; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeCreateQrCodeRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeCreateQrCodeRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeCreateQrCodeRes;
import com.yanzuoguang.wxxcx.wxacode.service.WxXcxWxaCodeCreateQrCodeService; import com.yanzuoguang.wxxcx.codeorlink.wxacode.service.WxXcxWxaCodeCreateQrCodeService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/impl/WxXcxWxaCodeGetServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/impl/WxXcxWxaCodeGetServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service.impl; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetRequest; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetRes;
import com.yanzuoguang.wxxcx.wxacode.service.WxXcxWxaCodeGetService; import com.yanzuoguang.wxxcx.codeorlink.wxacode.service.WxXcxWxaCodeGetService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/wxacode/service/impl/WxXcxWxaCodeGetUnlimitedServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/codeorlink/wxacode/service/impl/WxXcxWxaCodeGetUnlimitedServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.wxacode.service.impl; package com.yanzuoguang.wxxcx.codeorlink.wxacode.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetUnlimitedReq; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetUnlimitedReq;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetUnlimitedRequest; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetUnlimitedRequest;
import com.yanzuoguang.wxxcx.wxacode.WxXcxWxaCodeGetUnlimitedRes; import com.yanzuoguang.wxxcx.codeorlink.wxacode.WxXcxWxaCodeGetUnlimitedRes;
import com.yanzuoguang.wxxcx.wxacode.service.WxXcxWxaCodeGetUnlimitedService; import com.yanzuoguang.wxxcx.codeorlink.wxacode.service.WxXcxWxaCodeGetUnlimitedService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/WxXcxAnalysisGetPerformanceDataLinesRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/WxXcxAnalysisGetPerformanceDataLinesRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data; package com.yanzuoguang.wxxcx.dataanalysis.data;
/** /**
* 按时间排列的性能数据 * 按时间排列的性能数据
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/WxXcxAnalysisGetPerformanceDataReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/WxXcxAnalysisGetPerformanceDataReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data; package com.yanzuoguang.wxxcx.dataanalysis.data;
/** /**
* 获取小程序启动性能，运行性能等数据 请求 * 获取小程序启动性能，运行性能等数据 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/WxXcxAnalysisGetPerformanceDataRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/WxXcxAnalysisGetPerformanceDataRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data; package com.yanzuoguang.wxxcx.dataanalysis.data;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/WxXcxAnalysisGetPerformanceDataRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/WxXcxAnalysisGetPerformanceDataRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data; package com.yanzuoguang.wxxcx.dataanalysis.data;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/getPerformanceData.md 0 → 100644
View file @ 179ac129
数据分析 /其他 /获取小程序性能数据
# 获取小程序性能数据
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getPerformanceData
### 功能描述
该接口用于获取小程序启动性能，运行性能等数据。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/business/performance/boot?access_token=ACCESS_TOKEN
```
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证,access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | module | number | 是 | 查询数据的类型 |
| | time | object | 是 | 开始和结束日期的时间戳，时间跨度不能超过30天 |
| | 属性类型必填说明begin_timestampnumber是开始日期时间戳end_timestampnumber是结束日期时间戳 | | | |
| | params | array<object> | 是 | 查询条件，比如机型，网络类型等等 |
| | 属性类型必填说明fieldstring是查询条件valuestring是查询条件值 | | | |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | data | object | 返回的性能数据 |
| | 属性类型说明bodyobject返回的性能数据属性类型说明tablesarray<object>返回的数据数组属性类型说明idstring性能数据指标idlinesarray<object>按时间排列的性能数据属性类型说明fieldsarray<object>单天的性能数据属性类型说明refdatestring日期valuestring性能数据值zhstring性能数据指标中文名countnumber数组大小 | | |
## 其他说明
### module 的合法值
| 值 | 说明 |
| :---- | :--------------------------------------------- |
| 10016 | 打开率, params字段可传入网络类型和机型 |
| 10017 | 启动各阶段耗时，params字段可传入网络类型和机型 |
| 10021 | 页面切换耗时，params数组字段可传入机型 |
| 10022 | 内存指标，params数组字段可传入机型 |
| 10023 | 内存异常，params数组字段可传入机型 |
### field 的合法值
| 值 | 说明 |
| :----------- | :----------------------------------------------------------- |
| networktype | 网络类型作为查询条件，value=“-1,3g,4g,wifi”分别表示 全部网络类型，3G，4G，WIFI,不传 networktype 默认为全部网络类型 |
| device_level | 机型作为查询条件，此时value=“-1,1,2,3”分别表示 全部机型，高档机，中档机，低档机,不传device_level默认为全部机型 |
| device | 平台作为查询条件，此时value="-1,1,2"分别表示 全部平台，IOS平台，安卓平台,不传 device 默认为全部平台 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"time": {
"end_timestamp": 1609689600,
"begin_timestamp": 1609603200
},
"module": "10022",
"params": [{
"field": "networktype",
"value": "wifi"
}, {
"field": "device_level",
"value": "1"
}, {
"field": "device",
"value": "1"
}]
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"data": {
"body": {
"tables": [
{
"id": "memorydiff",
"lines": [
{
"fields": [
{
"refdate": "20210103",
"value": "70.7778"
},
{
"refdate": "20210104",
"value": "72.0446"
}
]
}
],
"zh": "内存增长均值"
},
{
"id": "memory",
"lines": [
{
"fields": [
{
"refdate": "20210103",
"value": "314"
},
{
"refdate": "20210104",
"value": "302.3218"
}
]
}
],
"zh": "内存均值"
}
],
"count": 2
}
}
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getPerformanceData({
"time": {
"endTimestamp": 1609689600,
"beginTimestamp": 1609603200
},
"module": '10022',
"params": [
{
"field": 'networktype',
"value": 'wifi'
},
{
"field": 'device_level',
"value": '1'
},
{
"field": 'device',
"value": '1'
}
]
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "openapi.analysis.getPerformanceData:ok",
"data": {
"body": {
"tables": [
{
"id": "memorydiff",
"lines": [
{
"fields": [
{
"refdate": "20210103",
"value": "70.7778"
},
{
"refdate": "20210104",
"value": "72.0446"
}
]
}
],
"zh": "内存增长均值"
},
{
"id": "memory",
"lines": [
{
"fields": [
{
"refdate": "20210103",
"value": "314"
},
{
"refdate": "20210104",
"value": "302.3218"
}
]
}
],
"zh": "内存均值"
}
],
"count": 2
}
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/service/WxXcxAnalysisGetPerformanceDataService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/service/WxXcxAnalysisGetPerformanceDataService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data.service; package com.yanzuoguang.wxxcx.dataanalysis.data.service;
import com.yanzuoguang.wxxcx.analysis.data.WxXcxAnalysisGetPerformanceDataReq; import com.yanzuoguang.wxxcx.dataanalysis.data.WxXcxAnalysisGetPerformanceDataReq;
import com.yanzuoguang.wxxcx.analysis.data.WxXcxAnalysisGetPerformanceDataRes; import com.yanzuoguang.wxxcx.dataanalysis.data.WxXcxAnalysisGetPerformanceDataRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/data/service/impl/WxXcxAnalysisGetPerformanceDataServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/data/service/impl/WxXcxAnalysisGetPerformanceDataServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.data.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.data.service.impl;
import com.yanzuoguang.wxxcx.analysis.data.WxXcxAnalysisGetPerformanceDataReq; import com.yanzuoguang.wxxcx.dataanalysis.data.WxXcxAnalysisGetPerformanceDataReq;
import com.yanzuoguang.wxxcx.analysis.data.WxXcxAnalysisGetPerformanceDataRequest; import com.yanzuoguang.wxxcx.dataanalysis.data.WxXcxAnalysisGetPerformanceDataRequest;
import com.yanzuoguang.wxxcx.analysis.data.WxXcxAnalysisGetPerformanceDataRes; import com.yanzuoguang.wxxcx.dataanalysis.data.WxXcxAnalysisGetPerformanceDataRes;
import com.yanzuoguang.wxxcx.analysis.data.service.WxXcxAnalysisGetPerformanceDataService; import com.yanzuoguang.wxxcx.dataanalysis.data.service.WxXcxAnalysisGetPerformanceDataService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/WxXcxAnalysisGetVisitDistributionItemListRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/WxXcxAnalysisGetVisitDistributionItemListRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution; package com.yanzuoguang.wxxcx.dataanalysis.distribution;
/** /**
* 获取用户小程序访问分布数据 响应列表项 * 获取用户小程序访问分布数据 响应列表项
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/WxXcxAnalysisGetVisitDistributionListRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/WxXcxAnalysisGetVisitDistributionListRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution; package com.yanzuoguang.wxxcx.dataanalysis.distribution;
/** /**
* 获取用户小程序访问分布数据 响应列表 * 获取用户小程序访问分布数据 响应列表
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/WxXcxAnalysisGetVisitDistributionReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/WxXcxAnalysisGetVisitDistributionReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution; package com.yanzuoguang.wxxcx.dataanalysis.distribution;
/** /**
* 获取用户小程序访问分布数据 请求 * 获取用户小程序访问分布数据 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/WxXcxAnalysisGetVisitDistributionRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/WxXcxAnalysisGetVisitDistributionRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution; package com.yanzuoguang.wxxcx.dataanalysis.distribution;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/WxXcxAnalysisGetVisitDistributionRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/WxXcxAnalysisGetVisitDistributionRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution; package com.yanzuoguang.wxxcx.dataanalysis.distribution;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/getVisitDistribution.md 0 → 100644
View file @ 179ac129
数据分析 /其他 /获取用户小程序访问分布数据
# 获取用户小程序访问分布数据
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getVisitDistribution
### 功能描述
该接口用于获取用户小程序访问分布数据。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getVisitDistribution
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，限定查询 1 天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :-------------------- |
| | ref_date | string | 日期，格式为 yyyymmdd |
| | list | array<object> | 数据列表 |
| | 属性类型说明indexstring分布类型。枚举值为：access_source_session_cnt（访问来源分布）、access_staytime_info（访问时长分布）、access_depth_info（访问深度的分布 ）item_listarray<object>分布数据列表属性类型说明keynumber场景 id，定义在各个 index 下不同，具体参见下方表格valuenumber该场景 id 访问 pv | | |
## 其他说明
## index 的合法值
| 值 | 说明 |
| :------------------------ | :------------- |
| access_source_session_cnt | 访问来源分布 |
| access_staytime_info | 访问时长分布 |
| access_depth_info | 访问深度的分布 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
```
### 返回数据示例
```json
{
"ref_date": "20170313",
"list": [
{
"index": "access_source_session_cnt",
"item_list": [
{
"key": 10,
"value": 5
},
{
"key": 8,
"value": 687
},
{
"key": 7,
"value": 10740
},
{
"key": 6,
"value": 1961
},
{
"key": 5,
"value": 677
},
{
"key": 4,
"value": 653
},
{
"key": 3,
"value": 1120
},
{
"key": 2,
"value": 10243
},
{
"key": 1,
"value": 116578
}
]
},
{
"index": "access_staytime_info",
"item_list": [
{
"key": 8,
"value": 16329
},
{
"key": 7,
"value": 19322
},
{
"key": 6,
"value": 21832
},
{
"key": 5,
"value": 19539
},
{
"key": 4,
"value": 29670
},
{
"key": 3,
"value": 19667
},
{
"key": 2,
"value": 11794
},
{
"key": 1,
"value": 4511
}
]
},
{
"index": "access_depth_info",
"item_list": [
{
"key": 5,
"value": 217
},
{
"key": 4,
"value": 3259
},
{
"key": 3,
"value": 32445
},
{
"key": 2,
"value": 63542
},
{
"key": 1,
"value": 43201
}
]
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getVisitDistribution({
"beginDate": '20170313',
"endDate": '20170313'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "20170313",
"list": [
{
"index": "access_source_session_cnt",
"itemList": [
{
"key": 10,
"value": 5
},
{
"key": 8,
"value": 687
},
{
"key": 7,
"value": 10740
},
{
"key": 6,
"value": 1961
},
{
"key": 5,
"value": 677
},
{
"key": 4,
"value": 653
},
{
"key": 3,
"value": 1120
},
{
"key": 2,
"value": 10243
},
{
"key": 1,
"value": 116578
}
]
},
{
"index": "access_staytime_info",
"itemList": [
{
"key": 8,
"value": 16329
},
{
"key": 7,
"value": 19322
},
{
"key": 6,
"value": 21832
},
{
"key": 5,
"value": 19539
},
{
"key": 4,
"value": 29670
},
{
"key": 3,
"value": 19667
},
{
"key": 2,
"value": 11794
},
{
"key": 1,
"value": 4511
}
]
},
{
"index": "access_depth_info",
"itemList": [
{
"key": 5,
"value": 217
},
{
"key": 4,
"value": 3259
},
{
"key": 3,
"value": 32445
},
{
"key": 2,
"value": 63542
},
{
"key": 1,
"value": 43201
}
]
}
],
"errMsg": "openapi.analysis.getVisitDistribution:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/service/WxXcxAnalysisGetVisitDistributionService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/service/WxXcxAnalysisGetVisitDistributionService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution.service; package com.yanzuoguang.wxxcx.dataanalysis.distribution.service;
import com.yanzuoguang.wxxcx.analysis.distribution.WxXcxAnalysisGetVisitDistributionReq; import com.yanzuoguang.wxxcx.dataanalysis.distribution.WxXcxAnalysisGetVisitDistributionReq;
import com.yanzuoguang.wxxcx.analysis.distribution.WxXcxAnalysisGetVisitDistributionRes; import com.yanzuoguang.wxxcx.dataanalysis.distribution.WxXcxAnalysisGetVisitDistributionRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/distribution/service/impl/WxXcxAnalysisGetVisitDistributionServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/distribution/service/impl/WxXcxAnalysisGetVisitDistributionServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.distribution.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.distribution.service.impl;
import com.yanzuoguang.wxxcx.analysis.distribution.WxXcxAnalysisGetVisitDistributionReq; import com.yanzuoguang.wxxcx.dataanalysis.distribution.WxXcxAnalysisGetVisitDistributionReq;
import com.yanzuoguang.wxxcx.analysis.distribution.WxXcxAnalysisGetVisitDistributionRequest; import com.yanzuoguang.wxxcx.dataanalysis.distribution.WxXcxAnalysisGetVisitDistributionRequest;
import com.yanzuoguang.wxxcx.analysis.distribution.WxXcxAnalysisGetVisitDistributionRes; import com.yanzuoguang.wxxcx.dataanalysis.distribution.WxXcxAnalysisGetVisitDistributionRes;
import com.yanzuoguang.wxxcx.analysis.distribution.service.WxXcxAnalysisGetVisitDistributionService; import com.yanzuoguang.wxxcx.dataanalysis.distribution.service.WxXcxAnalysisGetVisitDistributionService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/page/WxXcxAnalysisGetVisitPageReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/WxXcxAnalysisGetVisitPageReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.page; package com.yanzuoguang.wxxcx.dataanalysis.page;
/** /**
* 访问页面 请求 * 访问页面 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/page/WxXcxAnalysisGetVisitPageRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/WxXcxAnalysisGetVisitPageRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.page; package com.yanzuoguang.wxxcx.dataanalysis.page;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/page/WxXcxAnalysisGetVisitPageRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/WxXcxAnalysisGetVisitPageRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.page; package com.yanzuoguang.wxxcx.dataanalysis.page;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/getVisitPage.md 0 → 100644
View file @ 179ac129
数据分析 /其他 /获取访问页面数据
# 获取访问页面数据
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getVisitPage
### 功能描述
该接口用于访问页面。目前只提供按 page_visit_pv 排序的 top200。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getVisitPage
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，限定查询1天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :-------------------- |
| | ref_date | string | 日期，格式为 yyyymmdd |
| | list | array<object> | 数据列表 |
| | 属性类型说明page_pathstring页面路径page_visit_pvnumber访问次数page_visit_uvnumber访问人数page_staytime_pvnumber次均停留时长entrypage_pvnumber进入页次数exitpage_pvnumber退出页次数page_share_pvnumber转发次数page_share_uvnumber转发人数 | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
```
### 返回数据示例
```json
{
"ref_date": "20170313",
"list": [
{
"page_path": "pages/main/main.html",
"page_visit_pv": 213429,
"page_visit_uv": 55423,
"page_staytime_pv": 8.139198,
"entrypage_pv": 117922,
"exitpage_pv": 61304,
"page_share_pv": 180,
"page_share_uv": 166
},
{
"page_path": "pages/linedetail/linedetail.html",
"page_visit_pv": 155030,
"page_visit_uv": 42195,
"page_staytime_pv": 35.462395,
"entrypage_pv": 21101,
"exitpage_pv": 47051,
"page_share_pv": 47,
"page_share_uv": 42
},
{
"page_path": "pages/search/search.html",
"page_visit_pv": 65011,
"page_visit_uv": 24716,
"page_staytime_pv": 6.889634,
"entrypage_pv": 1811,
"exitpage_pv": 3198,
"page_share_pv": 0,
"page_share_uv": 0
},
{
"page_path": "pages/stationdetail/stationdetail.html",
"page_visit_pv": 29953,
"page_visit_uv": 9695,
"page_staytime_pv": 7.558508,
"entrypage_pv": 1386,
"exitpage_pv": 2285,
"page_share_pv": 0,
"page_share_uv": 0
},
{
"page_path": "pages/switch-city/switch-city.html",
"page_visit_pv": 8928,
"page_visit_uv": 4017,
"page_staytime_pv": 9.22659,
"entrypage_pv": 748,
"exitpage_pv": 1613,
"page_share_pv": 0,
"page_share_uv": 0
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getVisitPage({
"beginDate": '20170313',
"endDate": '20170313'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "20170313",
"list": [
{
"pagePath": "pages/main/main.html",
"pageVisitPv": 213429,
"pageVisitUv": 55423,
"pageStaytimePv": 8.139198,
"entrypagePv": 117922,
"exitpagePv": 61304,
"pageSharePv": 180,
"pageShareUv": 166
},
{
"pagePath": "pages/linedetail/linedetail.html",
"pageVisitPv": 155030,
"pageVisitUv": 42195,
"pageStaytimePv": 35.462395,
"entrypagePv": 21101,
"exitpagePv": 47051,
"pageSharePv": 47,
"pageShareUv": 42
},
{
"pagePath": "pages/search/search.html",
"pageVisitPv": 65011,
"pageVisitUv": 24716,
"pageStaytimePv": 6.889634,
"entrypagePv": 1811,
"exitpagePv": 3198,
"pageSharePv": 0,
"pageShareUv": 0
},
{
"pagePath": "pages/stationdetail/stationdetail.html",
"pageVisitPv": 29953,
"pageVisitUv": 9695,
"pageStaytimePv": 7.558508,
"entrypagePv": 1386,
"exitpagePv": 2285,
"pageSharePv": 0,
"pageShareUv": 0
},
{
"pagePath": "pages/switch-city/switch-city.html",
"pageVisitPv": 8928,
"pageVisitUv": 4017,
"pageStaytimePv": 9.22659,
"entrypagePv": 748,
"exitpagePv": 1613,
"pageSharePv": 0,
"pageShareUv": 0
}
],
"errMsg": "openapi.analysis.getVisitPage:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/page/service/WxXcxAnalysisGetVisitPageService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/service/WxXcxAnalysisGetVisitPageService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.page.service; package com.yanzuoguang.wxxcx.dataanalysis.page.service;
import com.yanzuoguang.wxxcx.analysis.page.WxXcxAnalysisGetVisitPageReq; import com.yanzuoguang.wxxcx.dataanalysis.page.WxXcxAnalysisGetVisitPageReq;
import com.yanzuoguang.wxxcx.analysis.page.WxXcxAnalysisGetVisitPageRes; import com.yanzuoguang.wxxcx.dataanalysis.page.WxXcxAnalysisGetVisitPageRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/page/service/impl/WxXcxAnalysisGetVisitPageServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/page/service/impl/WxXcxAnalysisGetVisitPageServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.page.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.page.service.impl;
import com.yanzuoguang.wxxcx.analysis.page.WxXcxAnalysisGetVisitPageReq; import com.yanzuoguang.wxxcx.dataanalysis.page.WxXcxAnalysisGetVisitPageReq;
import com.yanzuoguang.wxxcx.analysis.page.WxXcxAnalysisGetVisitPageRequest; import com.yanzuoguang.wxxcx.dataanalysis.page.WxXcxAnalysisGetVisitPageRequest;
import com.yanzuoguang.wxxcx.analysis.page.WxXcxAnalysisGetVisitPageRes; import com.yanzuoguang.wxxcx.dataanalysis.page.WxXcxAnalysisGetVisitPageRes;
import com.yanzuoguang.wxxcx.analysis.page.service.WxXcxAnalysisGetVisitPageService; import com.yanzuoguang.wxxcx.dataanalysis.page.service.WxXcxAnalysisGetVisitPageService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
/** /**
* 获取小程序新增或活跃用户的画像分布数据 请求 * 获取小程序新增或活跃用户的画像分布数据 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvNewObjectRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvNewObjectRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
/** /**
* 获取小程序新增或活跃用户的画像分布数据 新用户画像响应对象 * 获取小程序新增或活跃用户的画像分布数据 新用户画像响应对象
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvNewRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvNewRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
/** /**
* 获取小程序新增或活跃用户的画像分布数据 新用户画像响应 * 获取小程序新增或活跃用户的画像分布数据 新用户画像响应
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/WxXcxAnalysisGetUserPortraitVisitUvRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait; package com.yanzuoguang.wxxcx.dataanalysis.portrait;
/** /**
* 获取小程序新增或活跃用户的画像分布数据 活跃用户画像响应 * 获取小程序新增或活跃用户的画像分布数据 活跃用户画像响应
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/getUserPortrait.md 0 → 100644
View file @ 179ac129
数据分析 /其他 /获取小程序用户画像分布
# 获取小程序用户画像分布
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getUserPortrait
### 功能描述
该接口用于获取小程序新增或活跃用户的画像分布数据。时间范围支持昨天、最近7天、最近30天。其中，新增用户数为时间范围内首次访问小程序的去重用户数，活跃用户数为时间范围内访问过小程序的去重用户数。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappiduserportrait?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getUserPortrait
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :-------------------------------- |
| | ref_date | string | 时间范围，如："20170611-20170617" |
| | visit_uv_new | object | 新用户画像 |
| | 属性类型说明provincearray<object>分布类型属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvcityarray<object>省份，如北京、广东等属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvgendersarray<object>城市，如北京、广州等属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvplatformsarray<object>性别，包括男、女、未知属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvdevicesarray<object>终端类型，包括 iPhone，android，其他属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvagesarray<object>年龄，包括17岁以下、18-24岁等区间属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uv | | |
| | visit_uv | object | 活跃用户画像 |
| | 属性类型说明provincearray<object>分布类型属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvcityarray<object>省份，如北京、广东等属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvgendersarray<object>城市，如北京、广州等属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvplatformsarray<object>性别，包括男、女、未知属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvdevicesarray<object>终端类型，包括 iPhone，android，其他属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uvagesarray<object>年龄，包括17岁以下、18-24岁等区间属性类型说明idnumber属性值idnamestring属性值名称，与 id 对应。属性值为province、 city、 genders 、 platforms、devices 、 ages。valuenumber该场景访问uv | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170611",
"end_date" : "20170617"
}
```
### 返回数据示例
```json
{
"ref_date": "20170611",
"visit_uv_new": {
"province": [
{
"id": 31,
"name": "广东省",
"value": 215
}
],
"city": [
{
"id": 3102,
"name": "广州",
"value": 78
}
],
"genders": [
{
"id": 1,
"name": "男",
"value": 2146
}
],
"platforms": [
{
"id": 1,
"name": "iPhone",
"value": 27642
}
],
"devices": [
{
"name": "OPPO R9",
"value": 61
}
],
"ages": [
{
"id": 1,
"name": "17岁以下",
"value": 151
}
]
},
"visit_uv": {
"province": [
{
"id": 31,
"name": "广东省",
"value": 1341
}
],
"city": [
{
"id": 3102,
"name": "广州",
"value": 234
}
],
"genders": [
{
"id": 1,
"name": "男",
"value": 14534
}
],
"platforms": [
{
"id": 1,
"name": "iPhone",
"value": 21750
}
],
"devices": [
{
"name": "OPPO R9",
"value": 617
}
],
"ages": [
{
"id": 1,
"name": "17岁以下",
"value": 3156
}
]
}
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getUserPortrait({
"beginDate": '20170611',
"endDate": '20170617'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "20170611",
"visitUvNew": {
"province": [
{
"id": 31,
"name": "广东省",
"value": 215
}
],
"city": [
{
"id": 3102,
"name": "广州",
"value": 78
}
],
"genders": [
{
"id": 1,
"name": "男",
"value": 2146
}
],
"platforms": [
{
"id": 1,
"name": "iPhone",
"value": 27642
}
],
"devices": [
{
"name": "OPPO R9",
"value": 61
}
],
"ages": [
{
"id": 1,
"name": "17岁以下",
"value": 151
}
]
},
"visitUv": {
"province": [
{
"id": 31,
"name": "广东省",
"value": 1341
}
],
"city": [
{
"id": 3102,
"name": "广州",
"value": 234
}
],
"genders": [
{
"id": 1,
"name": "男",
"value": 14534
}
],
"platforms": [
{
"id": 1,
"name": "iPhone",
"value": 21750
}
],
"devices": [
{
"name": "OPPO R9",
"value": 617
}
],
"ages": [
{
"id": 1,
"name": "17岁以下",
"value": 3156
}
]
},
"errMsg": "openapi.analysis.getUserPortrait:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/service/WxXcxAnalysisGetUserPortraitService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/service/WxXcxAnalysisGetUserPortraitService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait.service; package com.yanzuoguang.wxxcx.dataanalysis.portrait.service;
import com.yanzuoguang.wxxcx.analysis.portrait.WxXcxAnalysisGetUserPortraitReq; import com.yanzuoguang.wxxcx.dataanalysis.portrait.WxXcxAnalysisGetUserPortraitReq;
import com.yanzuoguang.wxxcx.analysis.portrait.WxXcxAnalysisGetUserPortraitRes; import com.yanzuoguang.wxxcx.dataanalysis.portrait.WxXcxAnalysisGetUserPortraitRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/portrait/service/impl/WxXcxAnalysisGetUserPortraitServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/portrait/service/impl/WxXcxAnalysisGetUserPortraitServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.portrait.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.portrait.service.impl;
import com.yanzuoguang.wxxcx.analysis.portrait.WxXcxAnalysisGetUserPortraitReq; import com.yanzuoguang.wxxcx.dataanalysis.portrait.WxXcxAnalysisGetUserPortraitReq;
import com.yanzuoguang.wxxcx.analysis.portrait.WxXcxAnalysisGetUserPortraitRequest; import com.yanzuoguang.wxxcx.dataanalysis.portrait.WxXcxAnalysisGetUserPortraitRequest;
import com.yanzuoguang.wxxcx.analysis.portrait.WxXcxAnalysisGetUserPortraitRes; import com.yanzuoguang.wxxcx.dataanalysis.portrait.WxXcxAnalysisGetUserPortraitRes;
import com.yanzuoguang.wxxcx.analysis.portrait.service.WxXcxAnalysisGetUserPortraitService; import com.yanzuoguang.wxxcx.dataanalysis.portrait.service.WxXcxAnalysisGetUserPortraitService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetDailyRetainReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetDailyRetainReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
/** /**
* 获取用户访问小程序日留存 请求 * 获取用户访问小程序日留存 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetDailyRetainRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetDailyRetainRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetDailyRetainRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetDailyRetainRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetMonthlyRetainReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetMonthlyRetainReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
/** /**
* 获取用户访问小程序月留存 请求 * 获取用户访问小程序月留存 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetMonthlyRetainRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetMonthlyRetainRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetMonthlyRetainRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetMonthlyRetainRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetWeeklyRetainReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetWeeklyRetainReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
/** /**
* 获取用户访问小程序周留存 请求 * 获取用户访问小程序周留存 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetWeeklyRetainRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetWeeklyRetainRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/WxXcxAnalysisGetWeeklyRetainRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/WxXcxAnalysisGetWeeklyRetainRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain; package com.yanzuoguang.wxxcx.dataanalysis.retain;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/getDailyRetain.md 0 → 100644
View file @ 179ac129
数据分析 /访问留存 /获取用户访问小程序日留存
# 获取用户访问小程序日留存
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getDailyRetain
### 功能描述
该接口用于获取用户访问小程序日留存。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyretaininfo?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.undefined
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，限定查询1天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :----------- |
| | ref_date | string | 日期 |
| | visit_uv_new | array<object> | 新增用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当天，1表示1天后。依此类推，key取值分别是：0,1,2,3,4,5,6,7,14,30valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
| | visit_uv | array<object> | 活跃用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当天，1表示1天后。依此类推，key取值分别是：0,1,2,3,4,5,6,7,14,30valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
```
### 返回数据示例
```json
{
"ref_date": "20170313",
"visit_uv_new": [
{
"key": 0,
"value": 5464
}
],
"visit_uv": [
{
"key": 0,
"value": 55500
}
]
}
```
> 示例说明: 云函数调用示例
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getDailyRetain({
"beginDate": '20170313',
"endDate": '20170313'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "20170313",
"visitUvNew": [
{
"key": 0,
"value": 5464
}
],
"visitUv": [
{
"key": 0,
"value": 55500
}
],
"errMsg": "openapi.analysis.getDailyRetain:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/getMonthlyRetain.md 0 → 100644
View file @ 179ac129
数据分析 /访问留存 /获取用户访问小程序月留存
# 获取用户访问小程序月留存
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getMonthlyRetain
### 功能描述
该接口用于获取用户访问小程序月留存。
### 注意事项
请求 json 和返回 json 与天的一致，这里限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyretaininfo?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getMonthlyRetain
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期，为自然月第一天。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，为自然月最后一天，限定查询一个月数据。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :----------------- |
| | ref_date | string | 时间，如："201702" |
| | visit_uv_new | array<object> | 新增用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当月，1表示1月后。key取值分别是：0,1valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
| | visit_uv | array<object> | 活跃用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当月，1表示1月后。key取值分别是：0,1valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
## 调用示例
> 示例说明: HTTPS调用示例
### 请求数据示例
```json
{
"begin_date" : "20170201",
"end_date" : "20170228"
}
```
### 返回数据示例
```json
{
"ref_date": "201702",
"visit_uv_new": [
{
"key": 0,
"value": 346249
}
],
"visit_uv": [
{
"key": 0,
"value": 346249
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getMonthlyRetain({
"beginDate": '20170201',
"endDate": '20170228'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "201702",
"visitUvNew": [
{
"key": 0,
"value": 346249
}
],
"visitUv": [
{
"key": 0,
"value": 346249
}
],
"errMsg": "openapi.analysis.getMonthlyRetain:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/getWeeklyRetain.md 0 → 100644
View file @ 179ac129
数据分析 /访问留存 /获取用户访问小程序周留存
# 获取用户访问小程序周留存
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getWeeklyRetain
### 功能描述
该接口用于获取用户访问小程序周留存。
### 注意事项
请求 json 和返回 json 与天的一致，这里限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidweeklyretaininfo?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getWeeklyRetain
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期，为周一日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，为周日日期，限定查询一周数据。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :---------------------------- |
| | ref_date | string | 时间，如："20170306-20170312" |
| | visit_uv_new | array<object> | 新增用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当周，1表示1周后。依此类推，取值分别是：0,1,2,3,4valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
| | visit_uv | array<object> | 活跃用户留存 |
| | 属性类型说明keynumber标识，0开始，表示当周，1表示1周后。依此类推，取值分别是：0,1,2,3,4valuenumberkey对应日期的新增用户数/活跃用户数（key=0时）或留存用户数（k>0时） | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170306",
"end_date" : "20170312"
}
```
### 返回数据示例
```json
{
"ref_date": "20170306-20170312",
"visit_uv_new": [
{
"key": 0,
"value": 0
},
{
"key": 1,
"value": 16853
}
],
"visit_uv": [
{
"key": 0,
"value": 0
},
{
"key": 1,
"value": 99310
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getWeeklyRetain({
"beginDate": '20170306',
"endDate": '20170312'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"refDate": "20170306-20170312",
"visitUvNew": [
{
"key": 0,
"value": 0
},
{
"key": 1,
"value": 16853
}
],
"visitUv": [
{
"key": 0,
"value": 0
},
{
"key": 1,
"value": 99310
}
],
"errMsg": "openapi.analysis.getWeeklyRetain:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/WxXcxAnalysisGetDailyRetainService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/WxXcxAnalysisGetDailyRetainService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service; package com.yanzuoguang.wxxcx.dataanalysis.retain.service;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetDailyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetDailyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetDailyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetDailyRetainRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/WxXcxAnalysisGetMonthlyRetainService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/WxXcxAnalysisGetMonthlyRetainService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service; package com.yanzuoguang.wxxcx.dataanalysis.retain.service;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetMonthlyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetMonthlyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetMonthlyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetMonthlyRetainRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/WxXcxAnalysisGetWeeklyRetainService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/WxXcxAnalysisGetWeeklyRetainService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service; package com.yanzuoguang.wxxcx.dataanalysis.retain.service;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetWeeklyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetWeeklyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetWeeklyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetWeeklyRetainRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/impl/WxXcxAnalysisGetDailyRetainServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/impl/WxXcxAnalysisGetDailyRetainServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.retain.service.impl;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetDailyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetDailyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetDailyRetainRequest; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetDailyRetainRequest;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetDailyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetDailyRetainRes;
import com.yanzuoguang.wxxcx.analysis.retain.service.WxXcxAnalysisGetDailyRetainService; import com.yanzuoguang.wxxcx.dataanalysis.retain.service.WxXcxAnalysisGetDailyRetainService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/impl/WxXcxAnalysisGetMonthlyRetainServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/impl/WxXcxAnalysisGetMonthlyRetainServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.retain.service.impl;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetMonthlyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetMonthlyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetMonthlyRetainRequest; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetMonthlyRetainRequest;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetMonthlyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetMonthlyRetainRes;
import com.yanzuoguang.wxxcx.analysis.retain.service.WxXcxAnalysisGetMonthlyRetainService; import com.yanzuoguang.wxxcx.dataanalysis.retain.service.WxXcxAnalysisGetMonthlyRetainService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/retain/service/impl/WxXcxAnalysisGetWeeklyRetainServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/retain/service/impl/WxXcxAnalysisGetWeeklyRetainServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.retain.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.retain.service.impl;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetWeeklyRetainReq; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetWeeklyRetainReq;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetWeeklyRetainRequest; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetWeeklyRetainRequest;
import com.yanzuoguang.wxxcx.analysis.retain.WxXcxAnalysisGetWeeklyRetainRes; import com.yanzuoguang.wxxcx.dataanalysis.retain.WxXcxAnalysisGetWeeklyRetainRes;
import com.yanzuoguang.wxxcx.analysis.retain.service.WxXcxAnalysisGetWeeklyRetainService; import com.yanzuoguang.wxxcx.dataanalysis.retain.service.WxXcxAnalysisGetWeeklyRetainService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/summary/WxXcxAnalysisGetDailySummaryItemRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/WxXcxAnalysisGetDailySummaryItemRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.summary; package com.yanzuoguang.wxxcx.dataanalysis.summary;
/** /**
* 获取用户访问小程序数据概况 响应项 * 获取用户访问小程序数据概况 响应项
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/summary/WxXcxAnalysisGetDailySummaryRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/WxXcxAnalysisGetDailySummaryRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.summary; package com.yanzuoguang.wxxcx.dataanalysis.summary;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/summary/WxXcxAnalysisGetDailySummaryRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/WxXcxAnalysisGetDailySummaryRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.summary; package com.yanzuoguang.wxxcx.dataanalysis.summary;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/getDailySummary.md 0 → 100644
View file @ 179ac129
数据分析 /其他 /获取用户访问小程序数据概况
# 获取用户访问小程序数据概况
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getDailySummary
### 功能描述
该接口用于获取用户访问小程序数据概况。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailysummarytrend?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getDailySummary
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，限定查询1天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :------- |
| | list | array<object> | 数据列表 |
| | 属性类型说明ref_datestring日期，格式为 yyyymmddvisit_totalnumber累计用户数share_pvnumber转发次数share_uvnumber转发人数 | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
```
### 返回数据示例
```json
{
"list": [
{
"ref_date": "20170313",
"visit_total": 391,
"share_pv": 572,
"share_uv": 383
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getDailySummary({
"beginDate": '20170313',
"endDate": '20170313'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"list": [
{
"refDate": "20170313",
"visitTotal": 391,
"sharePv": 572,
"shareUv": 383
}
],
"errMsg": "openapi.analysis.getDailySummary:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/summary/service/WxXcxAnalysisGetDailySummaryService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/service/WxXcxAnalysisGetDailySummaryService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.summary.service; package com.yanzuoguang.wxxcx.dataanalysis.summary.service;
import com.yanzuoguang.wxxcx.analysis.summary.WxXcxAnalysisGetDailySummaryReq; import com.yanzuoguang.wxxcx.dataanalysis.summary.WxXcxAnalysisGetDailySummaryReq;
import com.yanzuoguang.wxxcx.analysis.summary.WxXcxAnalysisGetDailySummaryRes; import com.yanzuoguang.wxxcx.dataanalysis.summary.WxXcxAnalysisGetDailySummaryRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/summary/service/impl/WxXcxAnalysisGetDailySummaryServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/summary/service/impl/WxXcxAnalysisGetDailySummaryServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.summary.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.summary.service.impl;
import com.yanzuoguang.wxxcx.analysis.summary.WxXcxAnalysisGetDailySummaryReq; import com.yanzuoguang.wxxcx.dataanalysis.summary.WxXcxAnalysisGetDailySummaryReq;
import com.yanzuoguang.wxxcx.analysis.summary.WxXcxAnalysisGetDailySummaryRequest; import com.yanzuoguang.wxxcx.dataanalysis.summary.WxXcxAnalysisGetDailySummaryRequest;
import com.yanzuoguang.wxxcx.analysis.summary.WxXcxAnalysisGetDailySummaryRes; import com.yanzuoguang.wxxcx.dataanalysis.summary.WxXcxAnalysisGetDailySummaryRes;
import com.yanzuoguang.wxxcx.analysis.summary.service.WxXcxAnalysisGetDailySummaryService; import com.yanzuoguang.wxxcx.dataanalysis.summary.service.WxXcxAnalysisGetDailySummaryService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetDailyVisitTrendReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetDailyVisitTrendReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
/** /**
* 获取用户访问小程序数据日趋势 请求 * 获取用户访问小程序数据日趋势 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetDailyVisitTrendRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetDailyVisitTrendRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetDailyVisitTrendRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetDailyVisitTrendRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetMonthlyVisitTrendItemRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetMonthlyVisitTrendItemRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
/** /**
* 获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据) 响应项 * 获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据) 响应项
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetMonthlyVisitTrendReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetMonthlyVisitTrendReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
/** /**
* 获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据) 请求 * 获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据) 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetMonthlyVisitTrendRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetMonthlyVisitTrendRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetMonthlyVisitTrendRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetMonthlyVisitTrendRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetWeeklyVisitTrendReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetWeeklyVisitTrendReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
/** /**
* 获取用户访问小程序数据周趋势 请求 * 获取用户访问小程序数据周趋势 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetWeeklyVisitTrendRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetWeeklyVisitTrendRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/WxXcxAnalysisGetWeeklyVisitTrendRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/WxXcxAnalysisGetWeeklyVisitTrendRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend; package com.yanzuoguang.wxxcx.dataanalysis.trend;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/getDailyVisitTrend.md 0 → 100644
View file @ 179ac129
数据分析 /访问趋势 /获取用户访问小程序数据日趋势
# 获取用户访问小程序数据日趋势
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getDailyVisitTrend
### 功能描述
该接口用于获取用户访问小程序数据日趋势。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappiddailyvisittrend?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getDailyVisitTrend
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，限定查询1天数据，允许设置的最大值为昨日。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :------- |
| | list | array<object> | 数据列表 |
| | 属性类型说明ref_datestring日期，格式为 yyyymmddsession_cntnumber打开次数visit_pvnumber访问次数visit_uvnumber访问人数visit_uv_newnumber新用户数stay_time_uvnumber人均停留时长 (浮点型，单位：秒)stay_time_sessionnumber次均停留时长 (浮点型，单位：秒)visit_depthnumber平均访问深度 (浮点型) | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170313",
"end_date" : "20170313"
}
```
### 返回数据示例
```json
{
"list": [
{
"ref_date": "20170313",
"session_cnt": 142549,
"visit_pv": 472351,
"visit_uv": 55500,
"visit_uv_new": 5464,
"stay_time_session": 0,
"visit_depth": 1.9838
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getDailyVisitTrend({
"beginDate": '20170313',
"endDate": '20170313'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"list": [
{
"refDate": "20170313",
"sessionCnt": 142549,
"visitPv": 472351,
"visitUv": 55500,
"visitUvNew": 5464,
"stayTimeSession": 0,
"visitDepth": 1.9838
}
],
"errMsg": "openapi.analysis.getDailyVisitTrend:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/getMonthlyVisitTrend.md 0 → 100644
View file @ 179ac129
数据分析 /访问趋势 /获取用户访问小程序数据月趋势
# 获取用户访问小程序数据月趋势
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getMonthlyVisitTrend
### 功能描述
该接口用于获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据)。
### 注意事项
限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170301, 20170331
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidmonthlyvisittrend?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getMonthlyVisitTrend
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期，为自然月第一天。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，为自然月最后一天，限定查询一个月的数据。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :------- |
| | list | array<object> | 数据列表 |
| | 属性类型说明ref_datestring时间，格式为 yyyymm，如："201702"session_cntnumber打开次数（自然月内汇总）visit_pvnumber访问次数（自然月内汇总）visit_uvnumber访问人数（自然月内去重）visit_uv_newnumber新用户数（自然月内去重）stay_time_uvnumber人均停留时长 (浮点型，单位：秒)stay_time_sessionnumber次均停留时长 (浮点型，单位：秒)visit_depthnumber平均访问深度 (浮点型) | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170301",
"end_date" : "20170331"
}
```
### 返回数据示例
```text
{
"list": [
{
"ref_date": "201703",
"session_cnt": 126513,
"visit_pv": 426113,
"visit_uv": 48659,
"visit_uv_new": 6726,
"stay_time_session": 56.4112,
"visit_depth": 2.0189
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getMonthlyVisitTrend({
"beginDate": '20170301',
"endDate": '20170331'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"list": [
{
"refDate": "201703",
"sessionCnt": 126513,
"visitPv": 426113,
"visitUv": 48659,
"visitUvNew": 6726,
"stayTimeSession": 56.4112,
"visitDepth": 2.0189
}
],
"errMsg": "openapi.analysis.getMonthlyVisitTrend:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/getWeeklyVisitTrend.md 0 → 100644
View file @ 179ac129
数据分析 /访问趋势 /获取用户访问小程序数据周趋势
# 获取用户访问小程序数据周趋势
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getWeeklyVisitTrend
### 功能描述
该接口用于获取用户访问小程序数据周趋势
### 注意事项
限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/datacube/getweanalysisappidweeklyvisittrend?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.analysis.getWeeklyVisitTrend
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18、21
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| begin_date | string | 是 | 开始日期，为周一日期。格式为 yyyymmdd |
| end_date | string | 是 | 结束日期，为周日日期，限定查询一周数据。格式为 yyyymmdd |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :------- |
| | list | array<object> | 数据列表 |
| | 属性类型说明ref_datestring时间，格式为 yyyymmdd-yyyymmdd，如："20170306-20170312"session_cntnumber打开次数（自然周内汇总）visit_pvnumber访问次数（自然周内汇总）visit_uvnumber访问人数（自然周内去重）visit_uv_newnumber新用户数（自然周内去重）stay_time_uvnumber人均停留时长 (浮点型，单位：秒)stay_time_sessionnumber次均停留时长 (浮点型，单位：秒)visit_depthnumber平均访问深度 (浮点型) | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"begin_date" : "20170306",
"end_date" : "20170312"
}
```
### 返回数据示例
```json
{
"list": [
{
"ref_date": "20170306-20170312",
"session_cnt": 986780,
"visit_pv": 3251840,
"visit_uv": 189405,
"visit_uv_new": 45592,
"stay_time_session": 54.5346,
"visit_depth": 1.9735
}
]
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.analysis.getWeeklyVisitTrend({
"beginDate": '20170306',
"endDate": '20170312'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"list": [
{
"refDate": "20170306-20170312",
"sessionCnt": 986780,
"visitPv": 3251840,
"visitUv": 189405,
"visitUvNew": 45592,
"stayTimeSession": 54.5346,
"visitDepth": 1.9735
}
],
"errMsg": "openapi.analysis.getWeeklyVisitTrend:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/WxXcxAnalysisGetDailyVisitTrendService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/WxXcxAnalysisGetDailyVisitTrendService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service; package com.yanzuoguang.wxxcx.dataanalysis.trend.service;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetDailyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetDailyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetDailyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetDailyVisitTrendRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/WxXcxAnalysisGetMonthlyVisitTrendService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/WxXcxAnalysisGetMonthlyVisitTrendService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service; package com.yanzuoguang.wxxcx.dataanalysis.trend.service;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetMonthlyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetMonthlyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/WxXcxAnalysisGetWeeklyVisitTrendService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/WxXcxAnalysisGetWeeklyVisitTrendService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service; package com.yanzuoguang.wxxcx.dataanalysis.trend.service;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetWeeklyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetWeeklyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/impl/WxXcxAnalysisGetDailyVisitTrendServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/impl/WxXcxAnalysisGetDailyVisitTrendServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.trend.service.impl;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetDailyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetDailyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetDailyVisitTrendRequest; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetDailyVisitTrendRequest;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetDailyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetDailyVisitTrendRes;
import com.yanzuoguang.wxxcx.analysis.trend.service.WxXcxAnalysisGetDailyVisitTrendService; import com.yanzuoguang.wxxcx.dataanalysis.trend.service.WxXcxAnalysisGetDailyVisitTrendService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/impl/WxXcxAnalysisGetMonthlyVisitTrendServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/impl/WxXcxAnalysisGetMonthlyVisitTrendServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.trend.service.impl;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetMonthlyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetMonthlyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRequest; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRequest;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetMonthlyVisitTrendRes;
import com.yanzuoguang.wxxcx.analysis.trend.service.WxXcxAnalysisGetMonthlyVisitTrendService; import com.yanzuoguang.wxxcx.dataanalysis.trend.service.WxXcxAnalysisGetMonthlyVisitTrendService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/analysis/trend/service/impl/WxXcxAnalysisGetWeeklyVisitTrendServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/dataanalysis/trend/service/impl/WxXcxAnalysisGetWeeklyVisitTrendServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.analysis.trend.service.impl; package com.yanzuoguang.wxxcx.dataanalysis.trend.service.impl;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetWeeklyVisitTrendReq; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetWeeklyVisitTrendReq;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRequest; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRequest;
import com.yanzuoguang.wxxcx.analysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRes; import com.yanzuoguang.wxxcx.dataanalysis.trend.WxXcxAnalysisGetWeeklyVisitTrendRes;
import com.yanzuoguang.wxxcx.analysis.trend.service.WxXcxAnalysisGetWeeklyVisitTrendService; import com.yanzuoguang.wxxcx.dataanalysis.trend.service.WxXcxAnalysisGetWeeklyVisitTrendService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/login/WxXcxAuthCode2SessionRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/login/WxXcxAuthCode2SessionRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.login; package com.yanzuoguang.wxxcx.login;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/login/WxXcxAuthCode2SessionRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/login/WxXcxAuthCode2SessionRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.login; package com.yanzuoguang.wxxcx.login;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/login/code2Session.md 0 → 100644
View file @ 179ac129
小程序登录 /小程序登录
# 小程序登录
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
code2Session
### 功能描述
登录凭证校验。通过 wx.login 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。更多使用方法详见[小程序登录。](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/login.html)
## 调用方式
### HTTPS 调用
```text
GET https://api.weixin.qq.com/sns/jscode2session
```
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :--------- | :----- | :--- | :----------------------------------------------------------- |
| appid | string | 是 | 小程序 appId |
| secret | string | 是 | 小程序 appSecret |
| js_code | string | 是 | 登录时获取的 code，可通过[wx.login](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html)获取 |
| grant_type | string | 是 | 授权类型，此处只需填写 authorization_code |
### 返回参数
| 属性 | 类型 | 说明 |
| :---------- | :----- | :----------------------------------------------------------- |
| session_key | string | 会话密钥 |
| unionid | string | 用户在开放平台的唯一标识符，若当前小程序已绑定到微信开放平台帐号下会返回，详见 [UnionID 机制说明](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/union-id.html)。 |
| errmsg | string | 错误信息 |
| openid | string | 用户唯一标识 |
| errcode | int32 | 错误码 |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```text
GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
```
### 返回数据示例
```json
{
"openid":"xxxxxx",
"session_key":"xxxxx",
"unionid":"xxxxx",
"errcode":0,
"errmsg":"xxxxx"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :-------------------------------------------------------- | :----------------------------------------------------------- |
| 40029 | code 无效 | js_code无效 |
| 45011 | api minute-quota reach limit mustslower retry next minute | API 调用太频繁，请稍候再试 |
| 40226 | code blocked | 高风险等级用户，小程序登录拦截 。风险等级详见[用户安全解方案](https://developers.weixin.qq.com/miniprogram/dev/framework/operation.html) |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/login/service/WxXcxAuthCode2SessionService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/login/service/WxXcxAuthCode2SessionService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.login.service; package com.yanzuoguang.wxxcx.login.service;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionReq; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionReq;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRes; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/login/service/impl/WxXcxAuthCode2SessionServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/login/service/impl/WxXcxAuthCode2SessionServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.login.service.impl; package com.yanzuoguang.wxxcx.login.service.impl;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionReq; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionReq;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRequest; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRequest;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRes; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRes;
import com.yanzuoguang.wxxcx.auth.login.service.WxXcxAuthCode2SessionService; import com.yanzuoguang.wxxcx.login.service.WxXcxAuthCode2SessionService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/WxXcxUniformMessageSendMpTemplateMsgReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/WxXcxUniformMessageSendMpTemplateMsgReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage;
/** /**
* 公众号模板消息相关的信息，可以参考公众号模板消息接口；有此节点并且没有weapp_template_msg节点时，发送公众号模板消息 * 公众号模板消息相关的信息，可以参考公众号模板消息接口；有此节点并且没有weapp_template_msg节点时，发送公众号模板消息
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/WxXcxUniformMessageSendReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/WxXcxUniformMessageSendReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage;
/** /**
* 下发小程序和公众号统一的服务消息 请求 * 下发小程序和公众号统一的服务消息 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/WxXcxUniformMessageSendRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/WxXcxUniformMessageSendRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/WxXcxUniformMessageSendRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/WxXcxUniformMessageSendRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/WxXcxUniformMessageSendWeAppTemplateMsgReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/WxXcxUniformMessageSendWeAppTemplateMsgReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage;
/** /**
* 小程序模板消息相关的信息，可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息；（小程序模板消息已下线，不用传此节点） * 小程序模板消息相关的信息，可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息；（小程序模板消息已下线，不用传此节点）
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/sendUniformMessage.md 0 → 100644
View file @ 179ac129
消息相关 /统一服务消息 /下发统一消息
# 下发统一消息
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
sendUniformMessage
### 功能描述
该接口用于下发小程序和公众号统一的服务消息。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.uniformMessage.send
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | touser | string | 是 | 用户openid，可以是小程序的openid，也可以是mp_template_msg.appid对应的公众号的openid |
| | weapp_template_msg | object | 是 | 小程序模板消息相关的信息，可以参考小程序模板消息接口; 有此节点则优先发送小程序模板消息；（小程序模板消息已下线，不用传此节点） |
| | 属性类型必填说明template_idstring是小程序模板IDpagestring是小程序页面路径form_idstring是小程序模板消息formidemphasis_keywordstring是小程序模板放大关键词datastring是小程序模板数据 | | | |
| | mp_template_msg | object | 是 | 公众号模板消息相关的信息，可以参考公众号模板消息接口；有此节点并且没有weapp_template_msg节点时，发送公众号模板消息 |
| | 属性类型必填说明appidstring是公众号appid，要求与小程序有绑定且同主体template_idstring是公众号模板idurlstring是公众号模板消息所要跳转的urlminiprogramstring是公众号模板消息所要跳转的小程序，小程序的必须与公众号具有绑定关系datastring是公众号模板消息的数据 | | | |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"touser":"OPENID",
"weapp_template_msg":{
"template_id":"TEMPLATE_ID",
"page":"page/page/index",
"form_id":"FORMID",
"data":{
"keyword1":{
"value":"339208499"
},
"keyword2":{
"value":"2015年01月05日 12:30"
},
"keyword3":{
"value":"腾讯微信总部"
},
"keyword4":{
"value":"广州市海珠区新港中路397号"
}
},
"emphasis_keyword":"keyword1.DATA"
},
"mp_template_msg":{
"appid":"APPID ",
"template_id":"TEMPLATE_ID",
"url":"http://weixin.qq.com/download",
"miniprogram":{
"appid":"xiaochengxuappid12345",
"pagepath":"index?foo=bar"
},
"data":{
"first":{
"value":"恭喜你购买成功！",
"color":"#173177"
},
"keyword1":{
"value":"巧克力",
"color":"#173177"
},
"keyword2":{
"value":"39.8元",
"color":"#173177"
},
"keyword3":{
"value":"2014年9月22日",
"color":"#173177"
},
"remark":{
"value":"欢迎再次购买！",
"color":"#173177"
}
}
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.uniformMessage.send({
"touser": 'OPENID',
"weappTemplateMsg": {
"page": 'page/page/index',
"data": {
"keyword1": {
"value": '339208499'
},
"keyword2": {
"value": '2015年01月05日 12:30'
},
"keyword3": {
"value": '腾讯微信总部'
},
"keyword4": {
"value": '广州市海珠区新港中路397号'
}
},
"templateId": 'TEMPLATE_ID',
"formId": 'FORMID',
"emphasisKeyword": 'keyword1.DATA'
},
"mpTemplateMsg": {
"appid": 'APPID ',
"url": 'http://weixin.qq.com/download',
"miniprogram": {
"appid": 'xiaochengxuappid12345',
"pagepath": 'index?foo=bar'
},
"data": {
"first": {
"value": '恭喜你购买成功！',
"color": '#173177'
},
"keyword1": {
"value": '巧克力',
"color": '#173177'
},
"keyword2": {
"value": '39.8元',
"color": '#173177'
},
"keyword3": {
"value": '2014年9月22日',
"color": '#173177'
},
"remark": {
"value": '欢迎再次购买！',
"color": '#173177'
}
},
"templateId": 'TEMPLATE_ID'
}
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "openapi.uniformMessage.send:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40013 | appid不正确，或者不符合绑定关系要求 | |
| 40037 | invalid template_id | 不合法的 template_id |
| 41028 | invalid form id | form_id过期或者不正确 |
| 41029 | form id used count reach limit | form_id已被使用 |
| 41030 | invalid page | page路径不正确，需要保证在现网版本小程序中存在，与 app.json 保持一致 |
| 45009 | reach max api daily quota limit | 调用超过天级别频率限制。可调用clear_quota接口恢复调用额度。 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/service/WxXcxUniformMessageSendService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/service/WxXcxUniformMessageSendService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage.service; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.uniformmessage.WxXcxUniformMessageSendReq; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.WxXcxUniformMessageSendReq;
import com.yanzuoguang.wxxcx.uniformmessage.WxXcxUniformMessageSendRes; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.WxXcxUniformMessageSendRes;
/** /**
* 下发小程序和公众号统一的服务消息 接口 * 下发小程序和公众号统一的服务消息 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/uniformmessage/service/impl/WxXcxUniformMessageSendServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/uniformmessage/service/impl/WxXcxUniformMessageSendServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.uniformmessage.service.impl; package com.yanzuoguang.wxxcx.messagemanage.uniformmessage.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.uniformmessage.WxXcxUniformMessageSendReq; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.WxXcxUniformMessageSendReq;
import com.yanzuoguang.wxxcx.uniformmessage.WxXcxUniformMessageSendRequest; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.WxXcxUniformMessageSendRequest;
import com.yanzuoguang.wxxcx.uniformmessage.WxXcxUniformMessageSendRes; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.WxXcxUniformMessageSendRes;
import com.yanzuoguang.wxxcx.uniformmessage.service.WxXcxUniformMessageSendService; import com.yanzuoguang.wxxcx.messagemanage.uniformmessage.service.WxXcxUniformMessageSendService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageCreateActivityIdReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageCreateActivityIdReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
/** /**
* 创建被分享动态消息或私密消息的 activity_id 请求 * 创建被分享动态消息或私密消息的 activity_id 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageCreateActivityIdRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageCreateActivityIdRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageCreateActivityIdRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageCreateActivityIdRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgParameterListReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgParameterListReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
/** /**
* 修改被分享的动态消息 请求项 * 修改被分享的动态消息 请求项
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
/** /**
* 修改被分享的动态消息 请求 * 修改被分享的动态消息 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/WxXcxUpdatableMessageSetUpdatableMsgRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/createActivityId.md 0 → 100644
View file @ 179ac129
消息相关 /动态消息 /创建activity_id
# 创建activity_id
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
createActivityId
### 功能描述
该接口用于创建被分享动态消息或私密消息的 activity_id。详见[动态消息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share/updatable-message.html)。
## 调用方式
### HTTPS 调用
```text
GET https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.updatableMessage.createActivityId
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| unionid | string | 否 | 为私密消息创建activity_id时，指定分享者为 unionid 用户。其余用户不能用此activity_id分享私密消息。openid与 unionid 填一个即可。私密消息暂不支持云函数生成activity id。 |
| openid | string | 否 | 为私密消息创建activity_id时，指定分享者为 openid 用户。其余用户不能用此activity_id分享私密消息。openid与 unionid 填一个即可。私密消息暂不支持云函数生成activity id。 |
### 返回参数
| 属性 | 类型 | 说明 |
| :-------------- | :----- | :------------------------------------------- |
| activity_id | string | 动态消息的 ID |
| expiration_time | number | activity_id 的过期时间戳。默认24小时后过期。 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"unionid":"oHAUs6LSuwgHq-mlnFrffKXw3QYM",
"openid":"OPENID"
}
```
### 返回数据示例
```json
{
"errcode": "42001",
"errmsg": "access_token 过期"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/service/WxXcxUpdatableMessageCreateActivityIdService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/service/WxXcxUpdatableMessageCreateActivityIdService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage.service; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageCreateActivityIdReq; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageCreateActivityIdReq;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRes; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRes;
/** /**
* 创建被分享动态消息或私密消息的 activity_id 接口 * 创建被分享动态消息或私密消息的 activity_id 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/service/WxXcxUpdatableMessageSetUpdatableMsgService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/service/WxXcxUpdatableMessageSetUpdatableMsgService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage.service; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgReq; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgReq;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRes; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRes;
/** /**
* 修改被分享的动态消息 接口 * 修改被分享的动态消息 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/service/impl/WxXcxUpdatableMessageCreateActivityIdServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/service/impl/WxXcxUpdatableMessageCreateActivityIdServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage.service.impl; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageCreateActivityIdReq; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageCreateActivityIdReq;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRequest; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRequest;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRes; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageCreateActivityIdRes;
import com.yanzuoguang.wxxcx.updatablemessage.service.WxXcxUpdatableMessageCreateActivityIdService; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service.WxXcxUpdatableMessageCreateActivityIdService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/updatablemessage/service/impl/WxXcxUpdatableMessageSetUpdatableMsgServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/service/impl/WxXcxUpdatableMessageSetUpdatableMsgServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.updatablemessage.service.impl; package com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgReq; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgReq;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRequest; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRequest;
import com.yanzuoguang.wxxcx.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRes; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.WxXcxUpdatableMessageSetUpdatableMsgRes;
import com.yanzuoguang.wxxcx.updatablemessage.service.WxXcxUpdatableMessageSetUpdatableMsgService; import com.yanzuoguang.wxxcx.messagemanage.updatablemessage.service.WxXcxUpdatableMessageSetUpdatableMsgService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/messagemanage/updatablemessage/setUpdatableMsg.md 0 → 100644
View file @ 179ac129
消息相关 /动态消息 /修改动态消息
# 修改动态消息
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
setUpdatableMsg
### 功能描述
该接口用于修改被分享的动态消息。详见[动态消息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share/updatable-message.html)。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.updatableMessage.setUpdatableMsg
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
## 其他说明
### target_state 的合法值
| 值 | 说明 |
| :--- | :----- |
| 0 | 未开始 |
| 1 | 已开始 |
### name 的合法值
| 值 | 说明 |
| :----------- | :----------------------------------------------------------- |
| member_count | `target_state = 0` 时必填，文字内容模板中 `member_count` 的值 |
| room_limit | `target_state = 0` 时必填，文字内容模板中 `room_limit` 的值 |
| path | `target_state = 1` 时必填，点击「进入」启动小程序时使用的路径。 对于小游戏，没有页面的概念，可以用于传递查询字符串（query），如 `"?foo=bar"` |
| version_type | `target_state = 1` 时必填，点击「进入」启动小程序时使用的版本。 有效参数值为：`develop`（开发版），`trial`（体验版），`release`（正式版） |
### 消息状态
消息有两个状态（target_state），分别有其对应的文字内容和颜色。文字内容模板和颜色不支持变更。
| 状态 | 文字内容 | 颜色 | 允许转移的状态 |
| :--- | :-------------------------------------------------- | :------ | :------------- |
| 0 | "成员正在加入，当前 {member_count}/{room_limit} 人" | #FA9D39 | 0, 1 |
| 1 | "已开始" | #CCCCCC | 无 |
活动的默认有效期是 24 小时。活动结束后，消息内容会变成统一的样式：
- 文字内容：“已结束”
- 文字颜色：`#00ff00`
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"activity_id": "966_NGiqxxxxxxxxx...xxxxxxxxE33BlwX",
"target_state": 0,
"template_info": {
"parameter_list": [
{"name": "member_count",
"value": "2"},
{"name":"room_limit",
"value": "5"}
]
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 42001 | access_token expired | access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明 |
| 44002 | empty post data | POST 的数据包为空 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
| 47501 | activity_id error | 参数 activity_id 错误 |
| 47502 | target_state error | 参数 target_state 错误 |
| 47503 | version_type error | 参数 version_type 错误，调整后重试 |
| 47504 | activity_id expired time | activity_id 过期 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/nearbypoi/addNearbyPoi.md 0 → 100644
View file @ 179ac129
附近小程序 /添加地点
# 添加地点
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
addNearbyPoi
### 功能描述
该接口用于添加附近小程序的地点。
### 注意事项
- 添加请求暂不支持并发调用，建议使用时间隔1s进行串行调用
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/addnearbypoi?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.nearbyPoi.add
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：37
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| kf_info | string | 是 | 客服信息 选填，可自定义服务头像与昵称，具体填写字段见下方示例kf_info pic_list是字符串，内容是一个json |
| pic_list | string | 是 | 门店图片，最多9张，最少1张，上传门店图片如门店外景、环境设施、商品服务等，图片将展示在微信客户端的门店页。图片链接通过文档https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1444738729中的《上传图文消息内的图片获取URL》接口获取。必填，文件格式为bmp、png、jpeg、jpg或gif，大小不超过5M pic_list是字符串，内容是一个json |
| service_infos | string | 是 | 必服务标签列表 必填，需要填写 1、 服务标签ID 2、 服务类型tpye 3、 服务名称name 详细字段格式见下方《服务标签 id 编号、类型与服务名称表》 4、 APPID 5、 对应服务落地页的 path 路径：path路径页面要与对应的服务标签一致，例如选取外卖服务，path路径应该是小程序的外卖对应的那个页面，path路径获取咨询开发或者到小程序管理后台 - 工具 - 生成小程序码页面获取 6、新增服务描述desc：描述服务内容，例如满减、折扣等优惠信息或新品、爆品等商品信息，仅标准服务都可添加，10个字符以内。 service_infos是字符串，内容是一个json |
| store_name | string | 是 | 门店名字 必填，门店名称需按照所选地理位置自动拉取腾讯地图门店名称，不可修改，如需修改请重现选择地图地点或重新创建地点。 |
| contract_phone | string | 是 | 门店电话 |
| hour | string | 是 | 营业时间，格式11:11-12:12 |
| company_name | string | 是 | 主体名字 |
| credential | string | 是 | 资质号, 15位营业执照注册号或9位组织机构代码 |
| address | string | 是 | 地址 |
| qualification_list | string | 是 | 证明材料 必填 如果company_name和该小程序主体不一致，需要填qualification_list，详细规则见附近的小程序使用指南 - 如何证明门店的经营主体跟公众号或小程序帐号主体相关http://kf.qq.com/faq/170401MbUnim17040122m2qY.html |
| is_comm_nearby | string | 是 | 必填,写死为"1" |
| poi_id | string | 是 | 如果创建新的门店，poi_id字段为空 如果更新门店，poi_id参数则填对应门店的poi_id 选填 |
| map_poi_id | string | 是 | 对应《在腾讯地图中搜索门店》中的sosomap_poi_uid字段 腾讯地图那边有些数据不一致，如果不填map_poi_id的话，小概率会提交失败！ 注： poi_id与map_poi_id关系： map_poi_id是腾讯地图对于 poi 的唯一标识 poi_id是门店进驻附近后的门店唯一标识 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :--------------- |
| | errcode | number | |
| | errmsg | string | |
| | data | object | 附近小程序的数据 |
| | 属性类型说明audit_idnumber审核单 IDpoi_idnumber附近地点 IDrelated_credentialstring经营资质证件号 | | |
## 其他说明
### 一、服务标签 id 编号、类型与服务名称表
| ID | type | name(服务名称) |
| :--- | :--- | :--------------------------------------- |
| 0 | 2 | 自定义服务，可自定义名称（10个字符以内） |
| 1 | 1 | 外送 |
| 2 | 1 | 快递 |
| 3 | 1 | 充电 |
| 4 | 1 | 预约 |
| 5 | 1 | 挂号 |
| 6 | 1 | 点餐 |
| 7 | 1 | 优惠 |
| 8 | 1 | 乘车 |
| 9 | 1 | 会员 |
| 10 | 1 | 买单 |
| 11 | 1 | 排队 |
| 12 | 1 | 缴费 |
| 13 | 1 | 购票 |
| 14 | 1 | 到店自提 |
| 15 | 1 | 预订 |
### 二、审核状态通知格式如下：
审核结果将推送至消息服务器 URL 地址，如果是第三方服务商代添加，则推送至第三方平台“消息与事件URL”.
```text
<xml>
<ToUserName><![CDATA[gh_4346ac1514d8]]></ToUserName>
<FromUserName><![CDATA[od1P50M-fNQI5Gcq-trm4a7apsU8]]></FromUserName>
<CreateTime>1488856741</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[add_nearby_poi_audit_info]]></Event>
<audit_id>11111</audit_id> //审核单id
<status>3</status> // 2: 审核失败 3: 审核通过
<reason><![CDATA[xxx]]></reason> //审核失败的理由
<poi_id>111111</poi_id>
</xml>
```
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"is_comm_nearby":1,
"pic_list":"{\"list\":[\"http:\/\/mmbiz.qpic.cn\/mmbiz_jpg\/xdtQKcpj6RuwiafT12xxxxxxxxxibSVYicfUicy2fRqiacjriatWVZPeZsVlI0eztm5Mzjfdy4wcQVicscfapoqlzQ2g\/0\"]}",
"store_name":"xxx黄焖鸡米饭(xxxx店)",
"hour":"00:00-23:59",
"credential":"92321324MA24xxxxxxx",
"address":"江苏省宿迁市泗洪县尚城府邸xxxxxxxx",
"company_name":"xxxx县阿庆小吃部",
"service_infos":"{\"service_infos\":[{\"id\":\"1\",\"type\":\"1\",\"name\":\"外卖\",\"appid\":\"wx4e96615821xxxxxx\",\"path\":\"\/pages\/index\/store\/store?scene=148897\"}]}",
"qualification_list":"rNdNSNGaFDIGsyhucEPyANpW9_OIMa9iXSh-CdEXqL8pkqxxxxxx",
"kf_info":"{\"open_kf\":false}",
"contract_phone":"18071xxxxxx",
"map_poi_id":"30323090226254xxxxx"
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok",
"data":{
"audit_id":416620525,
"poi_id": 112333
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/nearbypoi/deleteNearbyPoi.md 0 → 100644
View file @ 179ac129
附近小程序 /删除地点
# 删除地点
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
deleteNearbyPoi
### 功能描述
该接口用于删除附近小程序的地点。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/delnearbypoi?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.nearbyPoi.delete
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：37
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| poi_id | string | 是 | 附近地点 ID |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"poi_id":"469382092"
}
```
### 返回数据示例
```json
{
"errcode":"",
"errmsg":"ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/nearbypoi/getNearbyPoiList.md 0 → 100644
View file @ 179ac129
附近小程序 /查看地点
# 查看地点
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getNearbyPoiList
### 功能描述
该接口用于查看附近小程序的地点列表。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/getnearbypoilist?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.nearbyPoi.getList
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：37
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| page | number | 是 | 起始页id（从1开始计数） |
| page_rows | number | 是 | 每页展示个数（最多1000个） |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :--------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | data | object | 附近小程序的数据 |
| | 属性类型说明max_apply_numnumber最大可添加地点个数left_apply_numnumber剩余可添加地点个数datastring地址列表的 JSON 格式字符串 | | |
## 其他说明
### data.data 的结构
| 属性 | 类型 | 说明 |
| :------- | :------------- | :------- |
| poi_list | Array.<Object> | 地址列表 |
### data.data.poi_list 的结构
| 属性 | 类型 | 说明 |
| :-------------------- | :----- | :------------------------------------ |
| poi_id | string | 附近地点 ID |
| qualification_address | string | 资质证件地址 |
| qualification_num | string | 资质证件证件号 |
| audit_status | number | 地点审核状态 |
| display_status | number | 地点展示在附近状态 |
| refuse_reason | string | 审核失败原因，`audit_status=4` 时返回 |
### audit_status 的合法值
| 值 | 说明 |
| :--- | :------- |
| 3 | 审核中 |
| 4 | 审核失败 |
| 5 | 审核通过 |
### display_status 的合法值
| 值 | 说明 |
| :--- | :----- |
| 0 | 未展示 |
| 1 | 展示中 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"page": 1,
"page_rows": 100
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"data": {
"left_apply_num": 9,
"max_apply_num": 10,
"data": "{\"poi_list\": [{\"poi_id\": \"123456\",\"qualification_address\": \"广东省广州市海珠区新港中路123号\",\"qualification_num\": \"123456789-1\",\"audit_status\": 3,\"display_status\": 0,\"refuse_reason\": \"\"}]}"
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 20002 | POST参数非法 | |
| 44002 | empty post data | POST 的数据包为空 |
| 92000 | 该经营资质已添加，请勿重复添加 | 该经营资质已添加，请勿重复添加 |
| 92002 | 附近地点添加数量达到上线，无法继续添加 | 附近地点添加数量达到上线，无法继续添加 |
| 92003 | 地点已被其它小程序占用 | 地点已被其它小程序占用 |
| 92004 | 附近功能被封禁 | |
| 92005 | 地点正在审核中 | 地点正在审核中 |
| 92006 | 地点正在展示小程序 | |
| 92007 | 地点审核失败 | |
| 92008 | 小程序未展示在该地点 | 小程序未展示在该地点 |
| 93009 | 小程序未上架或不可见 | 小程序未上架或不可见 |
| 93010 | 地点不存在 | 地点不存在 |
| 93011 | 个人类型小程序不可用 | 个人类型小程序不可用 |
| 93012 | 非普通类型小程序（门店小程序、小店小程序等）不可用 | 非普通类型小程序（门店小程序、小店小程序等）不可用 |
| 93013 | 从腾讯地图获取地址详细信息失败 | 从腾讯地图获取地址详细信息失败 |
| 93014 | 同一资质证件号重复添加 | |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/nearbypoi/setShowStatus.md 0 → 100644
View file @ 179ac129
附近小程序 /设置展示状态
# 设置展示状态
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
setShowStatus
### 功能描述
该接口用于展示/取消展示附近小程序。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/setnearbypoishowstatus?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.nearbyPoi.setShowStatus
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：37
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| poi_id | string | 是 | 附近地点 ID |
| status | number | 是 | 是否展示,0表示不展示，1表示展示 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"poi_id":493902010,
"status":1
}
```
### 返回数据示例
```json
{
"errcode":92005,
"errmsg":"地点正在审核中"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :--------- | :------- |
| 0 | ok | ok |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/openapimanage/clearQuota.md 0 → 100644
View file @ 179ac129
openApi管理 /重置API调用次数
# 重置 API 调用次数
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
clearQuota
### 功能描述
本接口用于清空公众号/小程序/第三方平台等接口的每日调用接口次数。
### 注意事项
1、如果要清空公众号的接口的quota，则需要用公众号的access_token；如果要清空小程序的接口的quota，则需要用[小程序的access_token](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)；如果要清空第三方平台的接口的quota，则需要用[第三方平台的component_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/component_access_token.html)
2、如果是第三方服务商代公众号或者小程序清除quota，则需要用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)
3、每个帐号每月共10次清零操作机会，清零生效一次即用掉一次机会；第三方帮助公众号/小程序调用时，实际上是在消耗公众号/小程序自身的quota
4、由于指标计算方法或统计时间差异，实时调用量数据可能会出现误差，一般在1%以内
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :----------- | :----- | :--- | :----------------------------------------------------------- |
| access_token | string | 是 | 第三方平台接口调用凭证[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)，该参数为 URL 参数，非 Body 参数。 |
| appid | string | 是 | 要被清空的账号的appid |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: 请求示例：
### 请求数据示例
```json
{
"appid":"wx448f04719cd48f69"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :-------------------------------------------------- | :----------------------------------------------------------- |
| 48006 | forbid to clear quota because of reaching the limit | api 禁止清零调用次数，因为清零次数达到上限 |
| 0 | ok | ok |
| 40013 | invalid appid | 不合法的 AppID ，请开发者检查 AppID 的正确性，避免异常字符，注意大小写 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/openapimanage/getApiQuota.md 0 → 100644
View file @ 179ac129
openApi管理 /查询API调用额度
# 查询 API 调用额度
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getApiQuota
### 功能描述
本接口用于查询公众号/小程序/第三方平台等接口的每日调用接口的额度以及调用次数。
### 注意事项
1、如果查询的 api 属于公众号的接口，则需要用[公众号的access_token](https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html)；如果查询的 api 属于小程序的接口，则需要用[小程序的access_token](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)；如果查询的接口属于第三方平台的接口，则需要用[第三方平台的component_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/component_access_token.html)
2、如果是第三方服务商代公众号或者小程序查询公众号或者小程序的api，则需要用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)
3、每个接口都有调用次数限制，请开发者合理调用接口
4、”/xxx/sns/xxx“这类接口不支持使用该接口，会出现76022报错。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/openapi/quota/get?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :----------- | :----- | :--- | :----------------------------------------------------------- |
| access_token | string | 是 | 第三方平台接口调用凭证[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)，该参数为 URL 参数，非 Body 参数。 |
| cgi_path | string | 是 | api的请求地址，例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ，也不要漏了"/",否则都会76003的报错 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :-------- |
| | errcode | number | 返回码 |
| | errmsg | string | 错误信息 |
| | quota | object | quota详情 |
| | 属性类型说明daily_limitnumber当天该账号可调用该接口的次数usednumber当天已经调用的次数remainnumber当天剩余调用次数 | | |
## 调用示例
> 示例说明: 请求示例:
### 请求数据示例
```json
{
"cgi_path":"/wxa/gettemplatedraftlist"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"quota":{
"daily_limit": 0,
"used": 0,
"remain": 0}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------------------------------------- | :----------------------------------------------------------- |
| 0 | ok | ok |
| 76021 | cgi_path not found, please check | cgi_path填错了 |
| 76022 | could not use this cgi_path，no permission | 当前调用接口使用的 token 与api所属账号不符，详情可看注意事项的说明 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/openapimanage/getRidInfo.md 0 → 100644
View file @ 179ac129
openApi管理 /查询RID信息
# 查询 RID 信息
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getRidInfo
### 功能描述
本接口用于查询调用公众号/小程序/第三方平台等接口报错返回的 rid 详情信息，辅助开发者高效定位问题。
### 注意事项
1、由于查询 rid 信息属于开发者私密行为，因此仅支持同账号的查询。举个例子，rid=1111，是小程序账号 A 调用某接口出现的报错，那么则需要使用小程序账号 A 的access_token调用当前接口查询rid=1111的详情信息，如果使用小程序账号 B 的身份查询，则出现报错，错误码为xxx。公众号、第三方平台账号的接口同理。
2、如果是第三方服务商代公众号或者小程序查询公众号或者小程序的 api 返回的rid，则使用同一账号的[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)调用即可
3、rid的有效期只有7天，即只可查询最近7天的rid，查询超过7天的 rid 会出现报错，错误码为76001
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/openapi/rid/get?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :----------- | :----- | :--- | :----------------------------------------------------------- |
| access_token | string | 是 | 第三方平台接口调用凭证[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)，该参数为 URL 参数，非 Body 参数。 |
| rid | string | 是 | 调用接口报错返回的rid |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :-------------------- |
| | errcode | number | 返回码 |
| | errmsg | string | 错误信息 |
| | request | object | 该 rid 对应的请求详情 |
| | 属性类型说明invoke_timenumber发起请求的时间戳cost_in_msnumber请求毫秒级耗时request_urlstring请求的 URL 参数request_bodystringpost请求的请求参数response_bodystring接口请求返回参数client_ipstring接口请求的客户端ip | | |
## 调用示例
> 示例说明: HTTPS请求
### 请求数据示例
```json
{
"rid":"61725984-6126f6f9-040f19c4"
}
```
### 返回数据示例
```json
{"errcode":0,
"errmsg":"ok",
"request":{
"invoke_time":1635156704,
"cost_in_ms":30,
"request_url":"access_token=50_Im7xxxx",
"request_body":"",
"response_body":"{\"errcode\":45009,\"errmsg\":\"reach max api daily quota limit rid: 617682e0-09059ac5-34a8e2ea\"}",
"client_ip": "113.xx.70.51"
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------- | :--------------------------------------------------- |
| 0 | ok | ok |
| 76001 | rid not found | rid不存在 |
| 76002 | rid is error | rid为空或者格式错误 |
| 76003 | could not query this rid,no permission | 当前账号无权查询该rid，该 rid 属于其他账号调用所产生 |
| 76004 | rid time is error | rid过期，仅支持持续7天内的rid |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/pluginmanager/managePlugin.md 0 → 100644
View file @ 179ac129
插件管理 /插件管理
# 插件管理
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
managePlugin
### 功能描述
该接口用于管理插件，支持申请、查看、更新、删除插件等操作。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/plugin?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.pluginManager.applyPlugin
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：40
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| action | string | 是 | action可取值为"list"、"apply"、 "unbind"、"update"，分别表示“查询已添加的插件列表”、“申请使用插件”、“删除已添加的插件”、“快速更新插件版本号” |
| plugin_appid | string | 是 | 插件的 appid |
| reason | string | 否 | 当 action 是"apply"时必填，申请原因 |
| user_version | string | 否 | 当 action 是"update"时使用。升级至版本号，要求此插件版本支持快速更新 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :----------------------------------------------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | plugin_list | array<object> | 申请或使用中的插件信息列表，当 action == 'list' 时返回 |
| | 属性类型说明appidstring插件 appIdstatusnumber插件状态。1表示申请中；2表示申请通过；3表示被拒绝；4表示申请已超时nicknamestring插件昵称headimgurlstring插件头像 | | |
## 调用示例
> 示例说明: 申请插件示例
### 请求数据示例
```json
{
"action": "apply",
"plugin_appid": "aaaa",
"reason": "hello"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
> 示例说明: 更新插件示例
### 请求数据示例
```json
{
"action": "update",
"user_version": "2.2.46",
"plugin_appid": "wx5514af450eaceec2"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
> 示例说明: 获取插件列表示例
### 请求数据示例
```json
{
"action": "list"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"plugin_list": [
{
"appid": "aaaa",
"status": 1,
"nickname": "插件昵称",
"headimgurl": "http://plugin.qq.com"
}
]
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 80067 | | 找不到使用的插件 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/pluginmanager/managePluginApplication.md 0 → 100644
View file @ 179ac129
插件管理 /插件申请管理
# 插件申请管理
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
managePluginApplication
### 功能描述
该接口供插件开发者调用，用于获取当前所有插件使用方信息以及修改插件使用申请的状态
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/devplugin?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.pluginManager.getPluginDevApplyList
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：40
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| action | string | 是 | dev_agree表示同意申请、dev_refuse表示拒绝申请、dev_delete表示删除已拒绝的申请者、dev_apply_list表示获取当前所有插件使用方信息 |
| appid | string | 否 | action为"dev_agree"时填写，使用者的 appid，同意申请时填写。 |
| page | number | 否 | action为"dev_apply_list"时填写，要拉取第几页的数据 |
| num | number | 否 | action为"dev_apply_list"时填写，每页的记录数 |
| reason | string | 否 | action为"dev_refuse"时填写，拒绝理由。 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :--------------------------------------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | apply_list | array<object> | 插件使用方列表，action为"dev_apply_list"时返回 |
| | 属性类型说明appidstring使用者的appidstatusnumber插件状态nicknamestring使用者的昵称headimgurlstring使用者的头像reasonstring使用者的申请说明apply_urlstring使用者的小程序码create_timestring使用者的申请时间categoriesarray<object>使用者的类目属性类型说明firststring一级类目名称secondstring二级类目名称 | | |
## 调用示例
> 示例说明: 获取当前所有插件使用方示例
### 请求数据示例
```json
{
"action":"dev_apply_list",
"page": 1,
"num": 10
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"apply_list": [{
"appid": "xxxxxxxxxxxxx",
"status": 1,
"nickname": "名称",
"headimgurl": "**********",
"reason": "polo has gone",
"apply_url": "*******",
"create_time": "1536305096",
"categories": [{
"first": "IT科技",
"second": "硬件与设备"
}]
}]
}
```
> 示例说明: 修改插件使用申请的状态示例
### 请求数据示例
```json
{
"action": "dev_agree",
"appid": "aaaa"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/redpacketcover/getRedPacketCoverUrl.md 0 → 100644
View file @ 179ac129
微信红包封面 /获取微信红包封面
# 获取微信红包封面
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getRedPacketCoverUrl
### 功能描述
本接口用于获得指定用户可以领取的红包封面链接。获取参数 ctoken 参考[微信红包封面开放平台](https://cover.weixin.qq.com/cgi-bin/mmcover-bin/readtemplate?t=page/index#/doc?page=delivery&index=2)。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/redpacketcover/wxapp/cover_url/get_by_token?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.redpacketcover.getAuthenticationUrl
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：112
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| openid | string | 是 | 可领取用户的openid |
| ctoken | string | 是 | 在红包封面平台获取发放ctoken（需要指定可以发放的appid） |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :---------------------------------------------------------- | :----- | :------------------------------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误描述 |
| | data | object | 指定用户可以领取的链接（带鉴权的链接） |
| | 属性类型说明urlstring指定用户可以领取的链接（带鉴权的链接） | | |
## 调用示例
> 示例说明: HTTPS请求示例
### 请求数据示例
```json
{
"openid":"xxxxxxxxxxmTo5lAUQxxxxxxxxxx",
"ctoken":"xxxxxqpHPu1xxxxx"
}
```
### 返回数据示例
```json
{
"data" : {
"url" : "https://xxx.xxx.xxx.xxx/xxx"
},
"errcode" : 0,
"errmsg" : "success"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :------ | :--------------------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 9600001 | 参数缺失 openid | |
| 9600002 | 参数缺失 ctoken | |
| 9600003 | 系统错误 | |
| 9600004 | ctoken 错误 | |
| 9600005 | openid 错误 | |
| 9600006 | 小程序不在配置列表中 | |
| 9600007 | 小程序与 openid 不对应 | |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMediaCheckAsyncReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.security; package com.yanzuoguang.wxxcx.security;
/** /**
* 异步校验图片/音频是否含有违法违规内容 请求 * 音视频内容安全识别 请求
* 异步校验图片/音频是否含有违法违规内容
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0 * 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
* 语音风险识别：社交类用户发表的语音内容检测； * 语音风险识别：社交类用户发表的语音内容检测；
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMediaCheckAsyncRequest.java
View file @ 179ac129
...@@ -6,8 +6,9 @@ import com.yanzuoguang.util.helper.JsonHelper; ...@@ -6,8 +6,9 @@ import com.yanzuoguang.util.helper.JsonHelper;
import com.yanzuoguang.wxxcx.base.*; import com.yanzuoguang.wxxcx.base.*;
/** /**
* 异步校验图片/音频是否含有违法违规内容 转换 * 音视频内容安全识别 转换
* <p> * 异步校验图片/音频是否含有违法违规内容
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
* 语音风险识别：社交类用户发表的语音内容检测； * 语音风险识别：社交类用户发表的语音内容检测；
* 图片智能鉴黄：涉及拍照的工具类应用(如美拍，识图类应用)用户拍照上传检测；电商类商品上架图片检测；媒体类用户文章里的图片检测等； * 图片智能鉴黄：涉及拍照的工具类应用(如美拍，识图类应用)用户拍照上传检测；电商类商品上架图片检测；媒体类用户文章里的图片检测等；
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMediaCheckAsyncRes.java
View file @ 179ac129
...@@ -3,8 +3,9 @@ package com.yanzuoguang.wxxcx.security; ...@@ -3,8 +3,9 @@ package com.yanzuoguang.wxxcx.security;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
/** /**
* 异步校验图片/音频是否含有违法违规内容 响应 * 音视频内容安全识别 响应
* * 异步校验图片/音频是否含有违法违规内容
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
* 语音风险识别：社交类用户发表的语音内容检测； * 语音风险识别：社交类用户发表的语音内容检测；
* 图片智能鉴黄：涉及拍照的工具类应用(如美拍，识图类应用)用户拍照上传检测；电商类商品上架图片检测；媒体类用户文章里的图片检测等； * 图片智能鉴黄：涉及拍照的工具类应用(如美拍，识图类应用)用户拍照上传检测；电商类商品上架图片检测；媒体类用户文章里的图片检测等；
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMsgSecCheckReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.security; package com.yanzuoguang.wxxcx.security;
/** /**
* 检查一段文本是否含有违法违规内容 请求 * 文本内容安全识别 请求
* 检查一段文本是否含有违法违规内容
* <p> * <p>
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0 * 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMsgSecCheckRequest.java
View file @ 179ac129
...@@ -6,7 +6,8 @@ import com.yanzuoguang.util.helper.JsonHelper; ...@@ -6,7 +6,8 @@ import com.yanzuoguang.util.helper.JsonHelper;
import com.yanzuoguang.wxxcx.base.*; import com.yanzuoguang.wxxcx.base.*;
/** /**
* 检查一段文本是否含有违法违规内容 转换 * 文本内容安全识别 转换
* 检查一段文本是否含有违法违规内容
* <p> * <p>
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0 * 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/WxXcxSecurityMsgSecCheckRes.java
View file @ 179ac129
...@@ -3,7 +3,8 @@ package com.yanzuoguang.wxxcx.security; ...@@ -3,7 +3,8 @@ package com.yanzuoguang.wxxcx.security;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
/** /**
* 检查一段文本是否含有违法违规内容 响应 * 文本内容安全识别 响应
* 检查一段文本是否含有违法违规内容
* <p> * <p>
* 1.0版本在2021年9月1日停止更新，请尽快更新至2.0 * 1.0版本在2021年9月1日停止更新，请尽快更新至2.0
* 应用场景举例： * 应用场景举例：
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/mediaCheckAsync.md 0 → 100644
View file @ 179ac129
小程序安全 /内容安全 /音视频内容安全识别
# 音视频内容安全识别
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
mediaCheckAsync
### 功能描述
本接口用于异步校验图片/音频是否含有违法违规内容。
- 1.0 版本异步接口文档[【点击查看】](https://developers.weixin.qq.com/miniprogram/dev/framework/security.mediaCheckAsync-v1.html)， 1.0 版本同步接口文档[【点击查看】](https://developers.weixin.qq.com/miniprogram/dev/framework/security.imgSecCheck.html)，1.0版本在2021年9月1日停止更新，请尽快更新至2.0
- 应用场景举例：
1. 语音风险识别：社交类用户发表的语音内容检测；
2. 图片智能鉴黄：涉及拍照的工具类应用(如美拍，识图类应用)用户拍照上传检测；电商类商品上架图片检测；媒体类用户文章里的图片检测等；
3. 敏感人脸识别：用户头像；媒体类用户文章里的图片检测；社交类用户上传的图片检测等。 **频率限制：单个 appId 调用上限为 2000 次/分钟，200,000 次/天；文件大小限制：单个文件大小不超过10M**
### 注意事项
media_type 需要准确填写 url 对应的多媒体类型，media_url 需要保证可以被检测服务器下载
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/media_check_async?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.security.mediaCheckAsync
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| media_url | string | 是 | 要检测的图片或音频的url，支持图片格式包括 jpg , jepg, png, bmp, gif（取首帧），支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav |
| media_type | number | 是 | 1:音频;2:图片 |
| version | number | 是 | 接口版本号，2.0版本为固定值2 |
| scene | number | 是 | 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志） |
| openid | string | 是 | 用户的openid（用户需在近两小时访问过小程序） |
### 返回参数
| 属性 | 类型 | 说明 |
| :------- | :----- | :----------------------------------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| trace_id | string | 唯一请求标识，标记单次请求，用于匹配异步推送结果 |
## 其他说明
### 异步检测结果推送
异步检测结果在 30 分钟内会推送到你的消息接收服务器。[点击查看消息接收服务器配置](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/message-push.html)
返回的 JSON 数据包
| 属性 | 类型 | 说明 |
| :----------- | :----- | :---------------------- |
| ToUserName | string | 小程序的username |
| FromUserName | string | 平台推送服务UserName |
| CreateTime | number | 发送时间 |
| MsgType | string | 默认为：Event |
| Event | string | 默认为：wxa_media_check |
| appid | string | 小程序的appid |
| trace_id | string | 任务id |
| version | number | 可用于区分接口版本 |
| result | object | 综合结果 |
| detail | array | 详细检测结果 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{"openid": "OPENID",
"scene": 1,
"version":2, "media_url":"https://developers.weixin.qq.com/miniprogram/assets/images/head_global_z_@all.png","media_type":2
}
```
### 返回数据示例
```json
{
"errcode" : 0,
"errmsg" : "ok",
"trace_id" : "967e945cd8a3e458f3c74dcb886068e9"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/msgSecCheck.md 0 → 100644
View file @ 179ac129
小程序安全 /内容安全 /文本内容安全识别
# 文本内容安全识别
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
msgSecCheck
### 功能描述
该接口用于检查一段文本是否含有违法违规内容。
#### 应用场景
- 用户个人资料违规文字检测；
- 媒体新闻类用户发表文章，评论内容检测；
- 游戏类用户编辑上传的素材(如答题类小游戏用户上传的问题及答案)检测等。
### 注意事项
-1.0 版本接口文档[【点击查看】](https://developers.weixin.qq.com/miniprogram/dev/framework/security.msgSecCheck-v1.html)，1.0版本在2021年9月1日停止更新，请尽快更新至2.0
- 频率限制：单个 appId 调用上限为 4000 次/分钟，2,000,000 次/天。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/msg_sec_check?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.security.msgSecCheck
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| content | string | 是 | 需检测的文本内容，文本字数的上限为2500字，需使用UTF-8编码 |
| version | number | 是 | 接口版本号，2.0版本为固定值2 |
| scene | number | 是 | 场景枚举值（1 资料；2 评论；3 论坛；4 社交日志） |
| openid | string | 是 | 用户的openid（用户需在近两小时访问过小程序） |
| title | string | 否 | 文本标题，需使用UTF-8编码 |
| nickname | string | 否 | 用户昵称，需使用UTF-8编码 |
| signature | string | 否 | 个性签名，该参数仅在资料类场景有效(scene=1)，需使用UTF-8编码 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :------------------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | detail | array<object> | 详细检测结果 |
| | 属性类型说明strategystring策略类型errcodenumber错误码，仅当该值为0时，该项结果有效suggeststring建议，有risky、pass、review三种值labelnumber命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他keywordstring命中的自定义关键词probnumber0-100，代表置信度，越高代表越有可能属于当前返回的标签（label） | | |
| | trace_id | string | 唯一请求标识，标记单次请求 |
| | result | object | 综合结果 |
| | 属性类型说明suggeststring建议，有risky、pass、review三种值labelnumber命中标签枚举值，100 正常；10001 广告；20001 时政；20002 色情；20003 辱骂；20006 违法犯罪；20008 欺诈；20012 低俗；20013 版权；21000 其他 | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"openid": "OPENID",
"scene": 1,
"version": 2,
"content":"hello world!"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"result": {
"suggest": "risky",
"label": 20001
},
"detail": [
{
"strategy": "content_model",
"errcode": 0,
"suggest": "risky",
"label": 20006,
"prob": 90
},
{
"strategy": "keyword",
"errcode": 0,
"suggest": "pass",
"label": 20006,
"level": 20,
"keyword": "命中的关键词1"
},
{
"strategy": "keyword",
"errcode": 0,
"suggest": "risky",
"label": 20006,
"level": 90,
"keyword": "命中的关键词2"
}
],
"trace_id": "60ae120f-371d5872-7941a05b"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.security.msgSecCheck({
"openid": 'OPENID',
"scene": 1,
"version": 2,
"content": 'hello world!'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"result": {
"suggest": "risky",
"label": 20001
},
"detail": [
{
"strategy": "content_model",
"errcode": 0,
"suggest": "risky",
"label": 20006,
"prob": 90
},
{
"strategy": "keyword",
"errcode": 0,
"suggest": "pass",
"label": 20006,
"level": 20,
"keyword": "命中的关键词1"
},
{
"strategy": "keyword",
"errcode": 0,
"suggest": "risky",
"label": 20006,
"level": 90,
"keyword": "命中的关键词2"
}
],
"trace_id": "60ae120f-371d5872-7941a05b"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40003 | invalid openid | 不合法的 OpenID ，请开发者确认 OpenID （该用户）是否已关注公众号，或是否是其他公众号的 OpenID |
| 40129 | invalid scene | 场景值错误（目前支持场景 1 资料；2 评论；3 论坛；4 社交日志） |
| 43104 | appid与 openid 不匹配 | |
| 43302 | 方法调用错误，请用 post 方法调用 | |
| 44002 | empty post data | POST 的数据包为空。post请求 body 参数不能为空。 |
| 47001 | data format error | 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。 |
| 61010 | 用户访问记录超时（用户未在近两小时访问小程序） | |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/service/WxXcxSecurityMediaCheckAsyncService.java
View file @ 179ac129
...@@ -5,17 +5,18 @@ import com.yanzuoguang.wxxcx.security.WxXcxSecurityMediaCheckAsyncReq; ...@@ -5,17 +5,18 @@ import com.yanzuoguang.wxxcx.security.WxXcxSecurityMediaCheckAsyncReq;
import com.yanzuoguang.wxxcx.security.WxXcxSecurityMediaCheckAsyncRes; import com.yanzuoguang.wxxcx.security.WxXcxSecurityMediaCheckAsyncRes;
/** /**
* 异步校验图片/音频是否含有违法违规内容 接口 * 音视频内容安全识别 接口
* 异步校验图片/音频是否含有违法违规内容
* *
* @author 李贤军 * @author 李贤军
*/ */
public interface WxXcxSecurityMediaCheckAsyncService { public interface WxXcxSecurityMediaCheckAsyncService {
/** /**
* 异步校验图片/音频是否含有违法违规内容 * 音视频内容安全识别
* *
* @param accessToken accessToken * @param accessToken accessToken
* @param req 异步校验图片/音频是否含有违法违规内容 入参 * @param req 异步校验图片/音频是否含有违法违规内容 入参
* @return 异步校验图片/音频是否含有违法违规内容 返回 * @return 音视频内容安全识别 返回
*/ */
WxXcxSecurityMediaCheckAsyncRes getSecurityMediaCheckAsync(WxXcxAccessToken accessToken, WxXcxSecurityMediaCheckAsyncReq req); WxXcxSecurityMediaCheckAsyncRes getSecurityMediaCheckAsync(WxXcxAccessToken accessToken, WxXcxSecurityMediaCheckAsyncReq req);
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/service/WxXcxSecurityMsgSecCheckService.java
View file @ 179ac129
...@@ -5,17 +5,17 @@ import com.yanzuoguang.wxxcx.security.WxXcxSecurityMsgSecCheckReq; ...@@ -5,17 +5,17 @@ import com.yanzuoguang.wxxcx.security.WxXcxSecurityMsgSecCheckReq;
import com.yanzuoguang.wxxcx.security.WxXcxSecurityMsgSecCheckRes; import com.yanzuoguang.wxxcx.security.WxXcxSecurityMsgSecCheckRes;
/** /**
* 检查一段文本是否含有违法违规内容 接口 * 文本内容安全识别 接口
* *
* @author 李贤军 * @author 李贤军
*/ */
public interface WxXcxSecurityMsgSecCheckService { public interface WxXcxSecurityMsgSecCheckService {
/** /**
* 检查一段文本是否含有违法违规内容 * 文本内容安全识别
* *
* @param accessToken accessToken * @param accessToken accessToken
* @param req 检查一段文本是否含有违法违规内容 入参 * @param req 文本内容安全识别 入参
* @return 检查一段文本是否含有违法违规内容 返回 * @return 文本内容安全识别 返回
*/ */
WxXcxSecurityMsgSecCheckRes getSecurityMsgSecCheck(WxXcxAccessToken accessToken, WxXcxSecurityMsgSecCheckReq req); WxXcxSecurityMsgSecCheckRes getSecurityMsgSecCheck(WxXcxAccessToken accessToken, WxXcxSecurityMsgSecCheckReq req);
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/service/impl/WxXcxSecurityMediaCheckAsyncServiceImpl.java
View file @ 179ac129
...@@ -10,6 +10,7 @@ import com.yanzuoguang.wxxcx.security.service.WxXcxSecurityMediaCheckAsyncServic ...@@ -10,6 +10,7 @@ import com.yanzuoguang.wxxcx.security.service.WxXcxSecurityMediaCheckAsyncServic
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
* 音视频内容安全识别
* 异步校验图片/音频是否含有违法违规内容 实现 * 异步校验图片/音频是否含有违法违规内容 实现
* *
* @author 李贤军 * @author 李贤军
...@@ -25,11 +26,11 @@ public class WxXcxSecurityMediaCheckAsyncServiceImpl implements WxXcxSecurityMed ...@@ -25,11 +26,11 @@ public class WxXcxSecurityMediaCheckAsyncServiceImpl implements WxXcxSecurityMed
} }
/** /**
* 异步校验图片/音频是否含有违法违规内容 * 音视频内容安全识别
* *
* @param accessToken accessToken * @param accessToken accessToken
* @param req 异步校验图片/音频是否含有违法违规内容 入参 * @param req 音视频内容安全识别 入参
* @return 异步校验图片/音频是否含有违法违规内容 返回 * @return 音视频内容安全识别 返回
*/ */
@Override @Override
public WxXcxSecurityMediaCheckAsyncRes getSecurityMediaCheckAsync(WxXcxAccessToken accessToken, WxXcxSecurityMediaCheckAsyncReq req) { public WxXcxSecurityMediaCheckAsyncRes getSecurityMediaCheckAsync(WxXcxAccessToken accessToken, WxXcxSecurityMediaCheckAsyncReq req) {
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/security/service/impl/WxXcxSecurityMsgSecCheckServiceImpl.java
View file @ 179ac129
...@@ -10,7 +10,7 @@ import com.yanzuoguang.wxxcx.security.service.WxXcxSecurityMsgSecCheckService; ...@@ -10,7 +10,7 @@ import com.yanzuoguang.wxxcx.security.service.WxXcxSecurityMsgSecCheckService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
* 检查一段文本是否含有违法违规内容 实现 * 文本内容安全识别 实现
* *
* @author 李贤军 * @author 李贤军
*/ */
...@@ -25,11 +25,11 @@ public class WxXcxSecurityMsgSecCheckServiceImpl implements WxXcxSecurityMsgSecC ...@@ -25,11 +25,11 @@ public class WxXcxSecurityMsgSecCheckServiceImpl implements WxXcxSecurityMsgSecC
} }
/** /**
* 检查一段文本是否含有违法违规内容 * 文本内容安全识别
* *
* @param accessToken accessToken * @param accessToken accessToken
* @param req 检查一段文本是否含有违法违规内容 入参 * @param req 文本内容安全识别 入参
* @return 检查一段文本是否含有违法违规内容 返回 * @return 文本内容安全识别 返回
*/ */
@Override @Override
public WxXcxSecurityMsgSecCheckRes getSecurityMsgSecCheck(WxXcxAccessToken accessToken, WxXcxSecurityMsgSecCheckReq req) { public WxXcxSecurityMsgSecCheckRes getSecurityMsgSecCheck(WxXcxAccessToken accessToken, WxXcxSecurityMsgSecCheckReq req) {
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia; package com.yanzuoguang.wxxcx.servicecustomer.gettempmedia;
/** /**
* 获取客服消息内的临时素材 请求 * 获取客服消息内的临时素材 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia; package com.yanzuoguang.wxxcx.servicecustomer.gettempmedia;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/WxXcxCustomerServiceMessageGetTempMediaRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia; package com.yanzuoguang.wxxcx.servicecustomer.gettempmedia;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/getTempMedia.md 0 → 100644
View file @ 179ac129
小程序客服 /客服消息 /获取客服消息内的临时素材
# 获取客服消息内的临时素材
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getTempMedia
### 功能描述
该接口用于获取客服消息内的临时素材。即下载临时的多媒体文件。目前小程序仅支持下载图片文件
### 注意事项
如果调用成功，会直接返回图片二进制内容，如果请求失败，会返回 JSON 格式的数据。
## 调用方式
### HTTPS 调用
```text
GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.customerServiceMessage.getTempMedia
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：1、3、8、9、11、19、30、31、59、61、62、100
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| media_id | string | 是 | 媒体文件 ID。可通过 uploadTempMedia 接口获得media_id |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :---------------------- |
| Buffer | Buffer | 成功时返回的图片 Buffer |
| errcode | number | 失败时返回错误码 |
| errmsg | string | 失败时返回错误信息 |
## 调用示例
> 示例说明: CURL请求失败示例
### 请求数据示例
```text
curl -I -G "https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID"
```
### 返回数据示例
```json
{
"errcode": 40007,
"errmsg": "无效媒体文件 ID"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.getTempMedia({
"mediaId": ''
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "openapi.customerServiceMessage.getTempMedia:ok",
"contentType": "image/jpeg",
"buffer": "Buffer"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/gettempmedia/service/WxXcxCustomerServiceMessageGetTempMediaService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/service/WxXcxCustomerServiceMessageGetTempMediaService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.service; package com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaReq; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaReq;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRes; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRes;
/** /**
* 获取客服消息内的临时素材 接口 * 获取客服消息内的临时素材 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/gettempmedia/service/impl/WxXcxCustomerServiceMessageGetTempMediaServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/gettempmedia/service/impl/WxXcxCustomerServiceMessageGetTempMediaServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.service.impl; package com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaReq; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaReq;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRequest; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRes; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.WxXcxCustomerServiceMessageGetTempMediaRes;
import com.yanzuoguang.wxxcx.customerservicemessage.gettempmedia.service.WxXcxCustomerServiceMessageGetTempMediaService; import com.yanzuoguang.wxxcx.servicecustomer.gettempmedia.service.WxXcxCustomerServiceMessageGetTempMediaService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/WxXcxCustomerServiceMessageSendImageReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/WxXcxCustomerServiceMessageSendImageReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send; package com.yanzuoguang.wxxcx.servicecustomer.send;
/** /**
* 发送客服消息给用户 请求图片消息内容 * 发送客服消息给用户 请求图片消息内容
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/WxXcxCustomerServiceMessageSendMiniProgramPageReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/WxXcxCustomerServiceMessageSendMiniProgramPageReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send; package com.yanzuoguang.wxxcx.servicecustomer.send;
/** /**
* 发送客服消息给用户 请求小程序卡片内容 * 发送客服消息给用户 请求小程序卡片内容
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/WxXcxCustomerServiceMessageSendRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/WxXcxCustomerServiceMessageSendRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send; package com.yanzuoguang.wxxcx.servicecustomer.send;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/WxXcxCustomerServiceMessageSendRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/WxXcxCustomerServiceMessageSendRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send; package com.yanzuoguang.wxxcx.servicecustomer.send;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/WxXcxCustomerServiceMessageSendTextReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/WxXcxCustomerServiceMessageSendTextReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send; package com.yanzuoguang.wxxcx.servicecustomer.send;
/** /**
* 发送客服消息给用户 请求文本消息内容 * 发送客服消息给用户 请求文本消息内容
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/sendCustomMessage.md 0 → 100644
View file @ 179ac129
小程序客服 /客服消息 /发送客服消息
# 发送客服消息
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
sendCustomMessage
### 功能描述
该接口用于发送客服消息给用户。详细规则见 [发送客服消息](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/send.html)
### 注意事项
- 发送文本消息时，支持添加可跳转小程序的文字连接.
- data-miniprogram-appid 项，填写小程序appid，则表示该链接跳转小程序；
- data-miniprogram-path项，填写小程序路径，路径与 app.json 中保持一致，可带参数；
- 对于不支持 data-miniprogram-appid 项的客户端版本（6.5.16 以下），如果有 herf 项，则仍然保持跳 href 中的链接；
- 小程序发带小程序文字链的文本消息，data-miniprogram-appid必须是该小程序的appid。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/message/custom/business/send?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：1、6、19、59、100、101
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| | 属性 | 类型 | 必填 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :--- | :----------------------------------------------------------- |
| | access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html) ； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html) 接口获得 |
| | touser | string | 是 | 用户的 OpenID |
| | msgtype | string | 是 | 消息类型。text表示文本消息；image表示图片消息；link表示图文链接；miniprogrampage表示小程序卡片。 |
| | text | object | 是 | 文本消息，msgtype="text" 时必填 |
| | 属性类型必填说明contentstring是文本消息内容。msgtype="text" 时必填 | | | |
| | image | object | 是 | 图片消息，msgtype="image" 时必填 |
| | 属性类型必填说明media_idstring是发送的图片的媒体ID，通过 uploadTempMedia上传图片文件获得。 | | | |
| | link | object | 是 | 图文链接，msgtype="link" 时必填 |
| | 属性类型必填说明titlestring是消息标题descriptionstring是图文链接消息urlstring是图文链接消息被点击后跳转的链接thumb_urlstring是图文链接消息的图片链接，支持 JPG、PNG 格式，较好的效果为大图 640 X 320，小图 80 X 80 | | | |
| | miniprogrampage | object | 是 | 小程序卡片，msgtype="miniprogrampage" 时必填 |
| | 属性类型必填说明titlestring是消息标题pagepathstring是小程序的页面路径，跟 app.json 对齐，支持参数，比如pages/index/index?foo=barthumb_media_idstring是小程序消息卡片的封面， image 类型的 media_id，通过 uploadTempMedia接口上传图片文件获得，建议大小为 520*416 | | | |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: 发送文本消息
### 请求数据示例
```json
{
"touser":"OPENID",
"msgtype":"text",
"text":
{
"content":"Hello World"
}
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok"
}
```
> 示例说明: 发送图片消息
### 请求数据示例
```json
{
"touser":"OPENID",
"msgtype":"image",
"image": {
"media_id":"MEDIA_ID"
}
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok"
}
```
> 示例说明: 发送图文链接
### 请求数据示例
```json
{
"touser": "OPENID",
"msgtype": "link",
"link": {
"title": "Happy Day",
"description": "Is Really A Happy Day",
"url": "URL",
"thumb_url": "THUMB_URL"
}
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok"
}
```
> 示例说明: 发送小程序卡片
### 请求数据示例
```json
{
"touser":"OPENID",
"msgtype":"miniprogrampage",
"miniprogrampage": {
"title":"title",
"pagepath":"pagepath",
"thumb_media_id":"thumb_media_id"
}
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40013 | invalid appid | 不合法的 AppID ，请开发者检查 AppID 的正确性，避免异常字符，注意大小写 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/service/WxXcxCustomerServiceMessageSendService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/service/WxXcxCustomerServiceMessageSendService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send.service; package com.yanzuoguang.wxxcx.servicecustomer.send.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.customerservicemessage.send.WxXcxCustomerServiceMessageSendReq; import com.yanzuoguang.wxxcx.servicecustomer.send.WxXcxCustomerServiceMessageSendReq;
import com.yanzuoguang.wxxcx.customerservicemessage.send.WxXcxCustomerServiceMessageSendRes; import com.yanzuoguang.wxxcx.servicecustomer.send.WxXcxCustomerServiceMessageSendRes;
/** /**
* 发送客服消息给用户 接口 * 发送客服消息给用户 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/send/service/impl/WxXcxCustomerServiceMessageSendServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/send/service/impl/WxXcxCustomerServiceMessageSendServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.send.service.impl; package com.yanzuoguang.wxxcx.servicecustomer.send.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.send.WxXcxCustomerServiceMessageSendReq; import com.yanzuoguang.wxxcx.servicecustomer.send.WxXcxCustomerServiceMessageSendReq;
import com.yanzuoguang.wxxcx.customerservicemessage.send.WxXcxCustomerServiceMessageSendRequest; import com.yanzuoguang.wxxcx.servicecustomer.send.WxXcxCustomerServiceMessageSendRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.send.WxXcxCustomerServiceMessageSendRes; import com.yanzuoguang.wxxcx.servicecustomer.send.WxXcxCustomerServiceMessageSendRes;
import com.yanzuoguang.wxxcx.customerservicemessage.send.service.WxXcxCustomerServiceMessageSendService; import com.yanzuoguang.wxxcx.servicecustomer.send.service.WxXcxCustomerServiceMessageSendService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/settyping/WxXcxCustomerServiceMessageSetTypingRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/settyping/WxXcxCustomerServiceMessageSetTypingRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.settyping; package com.yanzuoguang.wxxcx.servicecustomer.settyping;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/settyping/WxXcxCustomerServiceMessageSetTypingRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/settyping/WxXcxCustomerServiceMessageSetTypingRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.settyping; package com.yanzuoguang.wxxcx.servicecustomer.settyping;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/settyping/service/WxXcxCustomerServiceMessageSetTypingService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/settyping/service/WxXcxCustomerServiceMessageSetTypingService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.settyping.service; package com.yanzuoguang.wxxcx.servicecustomer.settyping.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.WxXcxCustomerServiceMessageSetTypingReq; import com.yanzuoguang.wxxcx.servicecustomer.settyping.WxXcxCustomerServiceMessageSetTypingReq;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.WxXcxCustomerServiceMessageSetTypingRes; import com.yanzuoguang.wxxcx.servicecustomer.settyping.WxXcxCustomerServiceMessageSetTypingRes;
/** /**
* 下发客服当前输入状态给用户 接口 * 下发客服当前输入状态给用户 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/settyping/service/impl/WxXcxCustomerServiceMessageSetTypingServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/settyping/service/impl/WxXcxCustomerServiceMessageSetTypingServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.settyping.service.impl; package com.yanzuoguang.wxxcx.servicecustomer.settyping.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.WxXcxCustomerServiceMessageSetTypingReq; import com.yanzuoguang.wxxcx.servicecustomer.settyping.WxXcxCustomerServiceMessageSetTypingReq;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.WxXcxCustomerServiceMessageSetTypingRequest; import com.yanzuoguang.wxxcx.servicecustomer.settyping.WxXcxCustomerServiceMessageSetTypingRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.WxXcxCustomerServiceMessageSetTypingRes; import com.yanzuoguang.wxxcx.servicecustomer.settyping.WxXcxCustomerServiceMessageSetTypingRes;
import com.yanzuoguang.wxxcx.customerservicemessage.settyping.service.WxXcxCustomerServiceMessageSetTypingService; import com.yanzuoguang.wxxcx.servicecustomer.settyping.service.WxXcxCustomerServiceMessageSetTypingService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/settyping/setTyping.md 0 → 100644
View file @ 179ac129
小程序客服 /客服消息 /下发客服当前输入状态
# 下发客服当前输入状态
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
setTyping
### 功能描述
该接口用于下发客服当前输入状态给用户。详见 [客服消息输入状态](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/typing.html)
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/message/custom/business/typing?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：1、6、19、59、100、101
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| touser | string | 是 | 用户的 OpenID |
| command | string | 是 | 命令。Typing表示对用户下发"正在输入"状态 ；CancelTyping表示取消对用户的"正在输入"状态 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"touser": "OPENID",
"command": "Typing"
}
```
### 返回数据示例
```json
{
"errcode": 45081,
"errmsg": "已经在输入状态，不可重复下发"
}
```
> 示例说明: 云函数调用
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.setTyping({
"touser": 'OPENID',
"command": 'Typing'
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"errcode": 45081,
"errmsg": "已经在输入状态，不可重复下发"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------------------------------------------------------- | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 45072 | invalid command | command字段取值不对 |
| 45080 | need sending message to user orrecving message from user in the last 30 seconds before typing | 下发输入状态，需要之前30秒内跟用户有过消息交互 |
| 45081 | you are already typing | 已经在输入状态，不可重复下发 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia; package com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia;
/** /**
* 把媒体文件上传到微信服务器 请求 * 把媒体文件上传到微信服务器 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia; package com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/WxXcxCustomerServiceMessageUploadTempMediaRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia; package com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/uploadtempmedia/service/WxXcxCustomerServiceMessageUploadTempMediaService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/service/WxXcxCustomerServiceMessageUploadTempMediaService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.service; package com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaReq; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaReq;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRes; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRes;
/** /**
* 把媒体文件上传到微信服务器 接口 * 把媒体文件上传到微信服务器 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/customerservicemessage/uploadtempmedia/service/impl/WxXcxCustomerServiceMessageUploadTempMediaServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/service/impl/WxXcxCustomerServiceMessageUploadTempMediaServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.service.impl; package com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaReq; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaReq;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRequest; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRequest;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRes; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.WxXcxCustomerServiceMessageUploadTempMediaRes;
import com.yanzuoguang.wxxcx.customerservicemessage.uploadtempmedia.service.WxXcxCustomerServiceMessageUploadTempMediaService; import com.yanzuoguang.wxxcx.servicecustomer.uploadtempmedia.service.WxXcxCustomerServiceMessageUploadTempMediaService;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/servicecustomer/uploadtempmedia/uploadTempMedia.md 0 → 100644
View file @ 179ac129
小程序客服 /客服消息 /新增图片素材
# 新增图片素材
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
uploadTempMedia
### 功能描述
该接口用于把媒体文件上传到微信服务器。目前仅支持图片。用于发送客服消息或被动回复用户消息
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.customerServiceMessage.uploadTempMedia
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：1、3、8、9、11、19、30、31、59、61、62、100
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :------- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| type | string | 是 | 文件类型,可填“ image”，表示图片 |
| media | FormData | 是 | form-data 中媒体文件标识，有filename、filelength、content-type等信息 |
### 返回参数
| 属性 | 类型 | 说明 |
| :--------- | :----- | :------------------------------------ |
| type | string | 文件类型 |
| media_id | string | 媒体文件上传后，获取标识，3天内有效。 |
| created_at | number | 媒体文件上传时间戳 |
## 调用示例
> 示例说明: CURL调用
### 请求数据示例
```text
curl -F media=@test.jpg "https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=image"
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"type": "image",
"media_id": "MEDIA_ID",
"created_at": "xxx"
}
```
> 示例说明: 云函数 sdk 调用示例
### 请求数据示例
```text
// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.customerServiceMessage.uploadTempMedia({
type: 'image',
media: {
contentType: 'image/png',
value: Buffer
}
})
```
### 返回数据示例
```json
{
"errCode": 0,
"errMsg": "openapi.customerServiceMessage.uploadTempMedia:ok",
"type": "image",
"mediaId": "MEDIA_ID",
"createdAt": "xxx"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40004 | invalid media type | 不合法的媒体文件类型 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/start/WxXcxAuthLogin.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.start; package com.yanzuoguang.wxxcx.start;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionReq; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionReq;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRes; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRes;
/** /**
* 微信登录实现类 * 微信登录实现类
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/start/WxXcxAuthUser.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.start; package com.yanzuoguang.wxxcx.start;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/start/impl/WxXcxAuthLoginImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.start.impl; package com.yanzuoguang.wxxcx.start.impl;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionReq; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionReq;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRequest; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRequest;
import com.yanzuoguang.wxxcx.auth.login.WxXcxAuthCode2SessionRes; import com.yanzuoguang.wxxcx.login.WxXcxAuthCode2SessionRes;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.start.WxXcxAuthLogin; import com.yanzuoguang.wxxcx.start.WxXcxAuthLogin;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/start/impl/WxXcxAuthUserImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.start.impl; package com.yanzuoguang.wxxcx.start.impl;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRequest; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRequest;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/token/WxXcxAuthGetAccessTokenReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/WxXcxAuthGetAccessTokenReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.token; package com.yanzuoguang.wxxcx.token;
/** /**
* 获取小程序全局唯一后台接口调用凭据 请求 * 获取小程序全局唯一后台接口调用凭据 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/token/WxXcxAuthGetAccessTokenRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/WxXcxAuthGetAccessTokenRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.token; package com.yanzuoguang.wxxcx.token;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/token/WxXcxAuthGetAccessTokenRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/WxXcxAuthGetAccessTokenRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.token; package com.yanzuoguang.wxxcx.token;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/getAccessToken.md 0 → 100644
View file @ 179ac129
接口调用凭证 /获取接口调用凭据
# 获取接口调用凭据
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getAccessToken
### 功能描述
- 获取小程序全局唯一后台接口调用凭据，token有效期为7200s，开发者需要进行妥善保存。
- 如使用[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)，可通过[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)免维护 access_token 调用。
- 如使用[云托管](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/basic/intro.html)，也可以通过[微信令牌/开放接口服务](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/open.html)免维护 access_token 调用。
## 调用方式
### HTTPS 调用
```text
GET https://api.weixin.qq.com/cgi-bin/token
```
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :--------- | :----- | :--- | :----------------------------------------------------------- |
| grant_type | string | 是 | 填写 client_credential |
| appid | string | 是 | 小程序唯一凭证，即 AppID，可在「微信公众平台 - 设置 - 开发设置」页中获得。（需要已经成为开发者，且帐号没有异常状态） |
| secret | string | 是 | 小程序唯一凭证密钥，即 AppSecret，获取方式同 appid |
### 返回参数
| 属性 | 类型 | 说明 |
| :----------- | :----- | :--------------------------------------------- |
| access_token | string | 获取到的凭证 |
| expires_in | number | 凭证有效时间，单位：秒。目前是7200秒之内的值。 |
## 其他说明
### access_token 的存储与更新
- `access_token` 的存储至少要保留 512 个字符空间；
- `access_token` 的有效期目前为 **2 个小时**，需定时刷新，重复获取将导致上次获取的 `access_token` 失效；
- 建议开发者使用中控服务器统一获取和刷新 `access_token`，其他业务逻辑服务器所使用的 `access_token` 均来自于该中控服务器，不应该各自去刷新，否则容易造成冲突，导致 `access_token` 覆盖而影响业务；
- `access_token` 的有效期通过返回的 `expires_in` 来传达，目前是7200秒之内的值，中控服务器需要根据这个有效时间提前去刷新。在刷新过程中，中控服务器可对外继续输出的老 `access_token`，此时公众平台后台会保证在5分钟内，新老 `access_token` 都可用，这保证了第三方业务的平滑过渡；
- `access_token` 的有效时间可能会在未来有调整，所以中控服务器不仅需要内部定时主动刷新，还需要提供被动刷新 `access_token` 的接口，这样便于业务服务器在 API 调用获知 `access_token` 已超时的情况下，可以触发 `access_token` 的刷新流程。
> 详情可参考微信公众平台文档 [《获取access_token》](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183)
### 免维护 access_token 的场景
如果使用了[云托管](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/basic/intro.html)或[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)，可以免维护 access_token，免鉴权直接调用服务端接口。
云托管：
- 通过[微信令牌](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)免维护 access_token 发起服务端调用，在调用微信服务端接口时，将 URL 上的 access_token 参数改成 cloudbase_access_token，值通过微信令牌取得。
- 调用[微信支付](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/basic/openapi/wxpay.html)也可以免维护鉴权和支付证书信息，避免证书泄漏风险。
云开发：
- 通过[云开发云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)免维护 access_token 调用。
- 调用[微信支付](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/wechatpay/wechatpay.html)也可以免维护鉴权和支付证书信息，避免证书泄漏风险。
### 在线调试
开发者可以使用[网页调试工具](https://mp.weixin.qq.com/debug/cgi-bin/apiinfo?t=index&type=基础支持&form=获取access_token接口 /token&token=&lang=zh_CN)调试该接口
## 调用示例
> 示例说明: HTTPS调用示例
### 请求数据示例
```text
GET https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET
```
### 返回数据示例
```json
{
"access_token":"ACCESS_TOKEN",
"expires_in":7200
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 40013 | invalid appid | 不合法的 AppID ，请开发者检查 AppID 的正确性，避免异常字符，注意大小写 |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/token/service/WxXcxAuthGetAccessTokenService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/service/WxXcxAuthGetAccessTokenService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.token.service; package com.yanzuoguang.wxxcx.token.service;
import com.yanzuoguang.wxxcx.auth.token.WxXcxAuthGetAccessTokenReq; import com.yanzuoguang.wxxcx.token.WxXcxAuthGetAccessTokenReq;
import com.yanzuoguang.wxxcx.auth.token.WxXcxAuthGetAccessTokenRes; import com.yanzuoguang.wxxcx.token.WxXcxAuthGetAccessTokenRes;
/** /**
* 获取小程序全局唯一后台接口调用凭据 接口 * 获取小程序全局唯一后台接口调用凭据 接口
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/token/service/impl/WxXcxAuthGetAccessTokenServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/token/service/impl/WxXcxAuthGetAccessTokenServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.token.service.impl; package com.yanzuoguang.wxxcx.token.service.impl;
import com.yanzuoguang.wxxcx.auth.token.WxXcxAuthGetAccessTokenReq; import com.yanzuoguang.wxxcx.token.WxXcxAuthGetAccessTokenReq;
import com.yanzuoguang.wxxcx.auth.token.WxXcxAuthGetAccessTokenRequest; import com.yanzuoguang.wxxcx.token.WxXcxAuthGetAccessTokenRequest;
import com.yanzuoguang.wxxcx.auth.token.WxXcxAuthGetAccessTokenRes; import com.yanzuoguang.wxxcx.token.WxXcxAuthGetAccessTokenRes;
import com.yanzuoguang.wxxcx.auth.token.service.WxXcxAuthGetAccessTokenService; import com.yanzuoguang.wxxcx.token.service.WxXcxAuthGetAccessTokenService;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthCheckEncryptedDataReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthCheckEncryptedDataReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
/** /**
* 检查加密信息是否由微信生成 请求 * 检查加密信息是否由微信生成 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthCheckEncryptedDataRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthCheckEncryptedDataRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthCheckEncryptedDataRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthCheckEncryptedDataRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPaidUnionIdReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPaidUnionIdReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
/** /**
* 用户支付完成后，获取该用户的 UnionId 请求 * 用户支付完成后，获取该用户的 UnionId 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPaidUnionIdRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPaidUnionIdRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPaidUnionIdRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPaidUnionIdRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPluginOpenPidReq.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPluginOpenPidReq.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
/** /**
* 通过 wx.pluginLogin 接口获得插件用户标志凭证 code 后传到开发者服务器 请求 * 通过 wx.pluginLogin 接口获得插件用户标志凭证 code 后传到开发者服务器 请求
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPluginOpenPidRequest.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPluginOpenPidRequest.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.alibaba.fastjson.TypeReference; import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper; import com.yanzuoguang.util.helper.HttpHelper;
...@@ -10,7 +10,7 @@ import com.yanzuoguang.wxxcx.base.*; ...@@ -10,7 +10,7 @@ import com.yanzuoguang.wxxcx.base.*;
* *
* @author 李贤军 * @author 李贤军
*/ */
public class WxXcxAuthGetPluginOpenPidRequest implements WxXcxRequestUrl, WxXcxRequestUrlPara { public class WxXcxAuthGetPluginOpenPidRequest implements WxXcxRequestUrl, WxXcxRequestUrlPara, WxXcxRequestPostFormData {
private final WxXcxConfig wxXcxConfig; private final WxXcxConfig wxXcxConfig;
private final WxXcxRequest wxXcxRequest; private final WxXcxRequest wxXcxRequest;
...@@ -31,6 +31,11 @@ public class WxXcxAuthGetPluginOpenPidRequest implements WxXcxRequestUrl, WxXcxR ...@@ -31,6 +31,11 @@ public class WxXcxAuthGetPluginOpenPidRequest implements WxXcxRequestUrl, WxXcxR
@Override @Override
public String getUrlPara() { public String getUrlPara() {
return HttpHelper.getUrlParameter(accessToken);
}
@Override
public String getPost() {
return HttpHelper.getUrlParameter(req); return HttpHelper.getUrlParameter(req);
} }
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/WxXcxAuthGetPluginOpenPidRes.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxAuthGetPluginOpenPidRes.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user; package com.yanzuoguang.wxxcx.user;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError; import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetPhoneNumberPhoneInfoRes.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import java.io.Serializable;
/**
* 用户手机号信息
*
* @author 李贤军
*/
public class WxXcxGetPhoneNumberPhoneInfoRes implements Serializable {
/**
* 用户绑定的手机号（国外手机号会有区号）
*/
private String phoneNumber;
/**
* 没有区号的手机号
*/
private String purePhoneNumber;
/**
* 区号
*/
private String countryCode;
/**
* 数据水印
*/
private WxXcxGetPhoneNumberPhoneInfoWaterMarkRes watermark;
public String getPhoneNumber() {
return phoneNumber;
}
public void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
public String getPurePhoneNumber() {
return purePhoneNumber;
}
public void setPurePhoneNumber(String purePhoneNumber) {
this.purePhoneNumber = purePhoneNumber;
}
public String getCountryCode() {
return countryCode;
}
public void setCountryCode(String countryCode) {
this.countryCode = countryCode;
}
public WxXcxGetPhoneNumberPhoneInfoWaterMarkRes getWatermark() {
return watermark;
}
public void setWatermark(WxXcxGetPhoneNumberPhoneInfoWaterMarkRes watermark) {
this.watermark = watermark;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetPhoneNumberPhoneInfoWaterMarkRes.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import java.io.Serializable;
/**
* @author 李贤军
*/
public class WxXcxGetPhoneNumberPhoneInfoWaterMarkRes implements Serializable {
/**
* 用户获取手机号操作的时间戳
*/
private double timestamp;
/**
* 小程序appid
*/
private String appid;
public double getTimestamp() {
return timestamp;
}
public void setTimestamp(double timestamp) {
this.timestamp = timestamp;
}
public String getAppid() {
return appid;
}
public void setAppid(String appid) {
this.appid = appid;
}
}
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetPhoneNumberReq.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
/**
* 获取手机号 请求
*
* @author 李贤军
*/
public class WxXcxGetPhoneNumberReq {
/**
* 接口调用凭证
*/
private String access_token;
/**
* 手机号获取凭证
*/
private String code;
public String getAccess_token() {
return access_token;
}
public void setAccess_token(String access_token) {
this.access_token = access_token;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetPhoneNumberRequest.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper;
import com.yanzuoguang.util.helper.JsonHelper;
import com.yanzuoguang.wxxcx.base.*;
/**
* 获取手机号 转换
*
* @author 李贤军
*/
public class WxXcxGetPhoneNumberRequest implements WxXcxRequestUrl, WxXcxRequestUrlPara, WxXcxRequestPostFormData {
private final WxXcxConfig wxXcxConfig;
private final WxXcxRequest wxXcxRequest;
private final WxXcxAccessToken accessToken;
private final WxXcxGetPhoneNumberReq req;
public WxXcxGetPhoneNumberRequest(WxXcxConfig wxXcxConfig, WxXcxRequest wxXcxRequest, WxXcxAccessToken accessToken, WxXcxGetPhoneNumberReq req) {
this.wxXcxConfig = wxXcxConfig;
this.wxXcxRequest = wxXcxRequest;
this.accessToken = accessToken;
this.req = req;
}
@Override
public String getUrl() {
return wxXcxConfig.getBaseUrl() + wxXcxConfig.getGetPhoneNumber() + "?" + this.getUrlPara();
}
@Override
public String getUrlPara() {
return HttpHelper.getUrlParameter(accessToken);
}
@Override
public String getPost() {
return HttpHelper.getUrlParameter(req);
}
public WxXcxGetPhoneNumberRes getResponse() {
// todo: 检测参数是否合法
// Assert.assertEquals();
return this.wxXcxRequest.request(this, response -> {
WxXcxGetPhoneNumberRes ret = JsonHelper.deserialize(response, new TypeReference<WxXcxGetPhoneNumberRes>() {
});
WxXcxAssert.assertBaseError(ret);
return ret;
});
}
}
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetPhoneNumberRes.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
/**
* 获取手机号 响应
*
* @author 李贤军
*/
public class WxXcxGetPhoneNumberRes extends WxXcxResponseBaseError {
/**
* 用户手机号信息
*/
private WxXcxGetPhoneNumberPhoneInfoRes phone_info;
public WxXcxGetPhoneNumberPhoneInfoRes getPhone_info() {
return phone_info;
}
public void setPhone_info(WxXcxGetPhoneNumberPhoneInfoRes phone_info) {
this.phone_info = phone_info;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetUserEncryptKeyKeyInfoListRes.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
/**
* 用户最近三次的加密 key 列表
*
* @author 李贤军
*/
public class WxXcxGetUserEncryptKeyKeyInfoListRes {
/**
* 加密key
*/
private String encrypt_key;
/**
* key的版本号
*/
private int version;
/**
* 剩余有效时间
*/
private double expire_in;
/**
* 加密iv
*/
private String iv;
/**
* 创建 key 的时间戳
*/
private double create_time;
public String getEncrypt_key() {
return encrypt_key;
}
public void setEncrypt_key(String encrypt_key) {
this.encrypt_key = encrypt_key;
}
public int getVersion() {
return version;
}
public void setVersion(int version) {
this.version = version;
}
public double getExpire_in() {
return expire_in;
}
public void setExpire_in(double expire_in) {
this.expire_in = expire_in;
}
public String getIv() {
return iv;
}
public void setIv(String iv) {
this.iv = iv;
}
public double getCreate_time() {
return create_time;
}
public void setCreate_time(double create_time) {
this.create_time = create_time;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetUserEncryptKeyReq.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
/**
* 获取用户encryptKey 请求
* 该接口用于获取用户encryptKey。 会获取用户最近3次的key，每个 key 的存活时间为3600s
*
* @author 李贤军
*/
public class WxXcxGetUserEncryptKeyReq {
/**
* 接口调用凭证
*/
private String access_token;
/**
* 用户的openid
*/
private String openid;
/**
* sessionkey 对空字符串签名得到的结果。session_key可通过code2Session接口获得
*/
private String signature;
/**
* 签名方法，只支持 hmac_sha256
*/
private String sig_method;
public String getAccess_token() {
return access_token;
}
public void setAccess_token(String access_token) {
this.access_token = access_token;
}
public String getOpenid() {
return openid;
}
public void setOpenid(String openid) {
this.openid = openid;
}
public String getSignature() {
return signature;
}
public void setSignature(String signature) {
this.signature = signature;
}
public String getSig_method() {
return sig_method;
}
public void setSig_method(String sig_method) {
this.sig_method = sig_method;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetUserEncryptKeyRequest.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import com.alibaba.fastjson.TypeReference;
import com.yanzuoguang.util.helper.HttpHelper;
import com.yanzuoguang.util.helper.JsonHelper;
import com.yanzuoguang.wxxcx.base.*;
/**
* 获取用户encryptKey 转换
*
* @author 李贤军
*/
public class WxXcxGetUserEncryptKeyRequest implements WxXcxRequestUrl, WxXcxRequestUrlPara, WxXcxRequestPostFormData {
private final WxXcxConfig wxXcxConfig;
private final WxXcxRequest wxXcxRequest;
private final WxXcxAccessToken accessToken;
private final WxXcxGetUserEncryptKeyReq req;
public WxXcxGetUserEncryptKeyRequest(WxXcxConfig wxXcxConfig, WxXcxRequest wxXcxRequest, WxXcxAccessToken accessToken, WxXcxGetUserEncryptKeyReq req) {
this.wxXcxConfig = wxXcxConfig;
this.wxXcxRequest = wxXcxRequest;
this.accessToken = accessToken;
this.req = req;
}
@Override
public String getUrl() {
return wxXcxConfig.getBaseUrl() + wxXcxConfig.getGetUserEncryptKey() + "?" + this.getUrlPara();
}
@Override
public String getUrlPara() {
return HttpHelper.getUrlParameter(accessToken);
}
@Override
public String getPost() {
return HttpHelper.getUrlParameter(req);
}
public WxXcxGetUserEncryptKeyRes getResponse() {
// todo: 检测参数是否合法
// Assert.assertEquals();
return this.wxXcxRequest.request(this, response -> {
WxXcxGetUserEncryptKeyRes ret = JsonHelper.deserialize(response, new TypeReference<WxXcxGetUserEncryptKeyRes>() {
});
WxXcxAssert.assertBaseError(ret);
return ret;
});
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/WxXcxGetUserEncryptKeyRes.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user;
import com.yanzuoguang.wxxcx.base.WxXcxResponseBaseError;
import java.util.List;
/**
* 获取用户encryptKey 响应
*
* @author 李贤军
*/
public class WxXcxGetUserEncryptKeyRes extends WxXcxResponseBaseError {
/**
* 用户最近三次的加密 key 列表
*/
private List<WxXcxGetUserEncryptKeyKeyInfoListRes> key_info_list;
public List<WxXcxGetUserEncryptKeyKeyInfoListRes> getKey_info_list() {
return key_info_list;
}
public void setKey_info_list(List<WxXcxGetUserEncryptKeyKeyInfoListRes> key_info_list) {
this.key_info_list = key_info_list;
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/checkEncryptedData.md 0 → 100644
View file @ 179ac129
用户信息 /用户信息 /检查加密信息
# 检查加密信息
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
checkEncryptedData
### 功能描述
检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| encrypted_msg_hash | string | 是 | 加密数据的sha256，通过Hex（Base16）编码后的字符串 |
### 返回参数
| 属性 | 类型 | 说明 |
| :---------- | :------ | :------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误提示信息 |
| vaild | boolean | 是否是合法的数据 |
| create_time | number | 加密数据生成的时间戳 |
## 调用示例
> 示例说明: HTTPS调用示例
### 请求数据示例
```json
{
"encrypted_msg_hash": "657edd868c9715a9bebe42b833269a557a48498785397a796f1568c29a200b2c"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"vaild": true,
"create_time" :1629121902
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :---------------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40097 | invalid args | 参数错误 |
| 44002 | empty post data | POST 的数据包为空 |
| 47001 | data format error | 解析 JSON/XML 内容错误 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/getGetPhoneNumber.md 0 → 100644
View file @ 179ac129
用户信息 /手机号 /获取手机号
# 获取手机号
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getPhoneNumber
### 功能描述
该接口用于将 code 换取用户手机号。 说明，每个 code 只能使用一次，code的有效期为5min。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| code | string | 是 | [手机号获取凭证](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/getPhoneNumber.html) |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :----- | :------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | phone_info | object | 用户手机号信息 |
| | 属性类型说明phoneNumberstring用户绑定的手机号（国外手机号会有区号）purePhoneNumberstring没有区号的手机号countryCodestring区号watermarkobject数据水印属性类型说明timestampnumber用户获取手机号操作的时间戳appidstring小程序appid | | |
## 调用示例
> 示例说明: HTTPS请求示例
### 请求数据示例
```json
{
"code": "e31968a7f94cc5ee25fafc2aef2773f0bb8c3937b22520eb8ee345274d00c144"
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok",
"phone_info": {
"phoneNumber":"xxxxxx",
"purePhoneNumber": "xxxxxx",
"countryCode": 86,
"watermark": {
"timestamp": 1637744274,
"appid": "xxxx"
}
}
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :----------- | :----------------------------- |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40029 | code 无效 | js_code无效 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/getPaidUnionId.md 0 → 100644
View file @ 179ac129
用户信息 /用户信息 /支付后获取 Unionid
# 支付后获取 Unionid
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
> 本接口支持[云调用](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)。需开发者工具版本 >= `1.02.1904090`（最新[稳定版下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)），`wx-server-sdk` >= `0.4.0`
## 接口说明
### 接口英文名
getPaidUnionid
### 功能描述
该接口用于在用户支付完成后，获调用本接口前需要用户完成支付，用户支付完成后，取该用户的 UnionId，无需用户授权。本接口支付后的五分钟内有效。
### 注意事项
- 调用前需要用户完成支付，且在支付后的五分钟内有效。
- 使用微信支付订单号（transaction_id）和微信支付商户订单号和微信支付商户号（out_trade_no 及 mch_id），二选一
## 调用方式
### HTTPS 调用
```text
GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN
```
### 云调用
- 出入参和 HTTPS 调用相同，调用方式可查看[云调用说明文档](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/openapi/openapi.html)
- 接口方法为: openapi.auth.getPaidUnionId
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| openid | string | 是 | 支付用户唯一标识 |
| transaction_id | string | 否 | [微信支付订单号](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=9_7) |
| mch_id | string | 否 | 微信支付分配的[商户号](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=9_7)，和商户订单号配合使用 |
| out_trade_no | string | 否 | [微信支付商户订单号](https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=9_7)，和商户号配合使用 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :--------------------------- |
| unionid | string | 用户唯一标识，调用成功后返回 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
## 调用示例
> 示例说明: 使用微信支付订单号
### 请求数据示例
```text
GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&transaction_id=TRANSACTION_ID
```
### 返回数据示例
```json
{
"unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk",
"errcode": 0,
"errmsg": "ok"
}
```
> 示例说明: 使用微信支付商户订单号和微信支付商户号（out_trade_no 及 mch_id）
### 请求数据示例
```text
GET https://api.weixin.qq.com/wxa/getpaidunionid?access_token=ACCESS_TOKEN&openid=OPENID&mch_id=MCH_ID&out_trade_no=OUT_TRADE_NO
```
### 返回数据示例
```json
{
"unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk",
"errcode": 0,
"errmsg": "ok"
}
```
> 示例说明: 云函数示例
### 请求数据示例
```text
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.auth.getPaidUnionId({
"openid": '',
"transactionId": '',
"mchId": '',
"outTradeNo": ''
})
return result
} catch (err) {
return err
}
}
```
### 返回数据示例
```json
{
"unionid": "oTmHYjg-tElZ68xxxxxxxxhy1Rgk",
"errCode": 0,
"errMsg": "openapi.auth.getPaidUnionId:ok"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| 0 | ok | ok |
| -1 | system error | 系统繁忙，此时请开发者稍候再试 |
| 40003 | invalid openid | 不合法的 OpenID ，请开发者确认 OpenID （该用户）是否已关注公众号，或是否是其他公众号的 OpenID |
| 89002 | open not exists | open not exists，该公众号/小程序未绑定微信开放平台帐号。 |
| 89300 | invalid trade | 订单无效 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/getPluginOpenPId.md 0 → 100644
View file @ 179ac129
用户信息 /用户信息 /获取插件用户openpid
# 获取插件用户openpid
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getPluginOpenPId
### 功能描述
通过 [wx.pluginLogin](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.pluginLogin.html) 接口获得插件用户标志凭证 code 后传到开发者服务器，开发者服务器调用此接口换取插件用户的唯一标识 openpid。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/getpluginopenpid?access_token=ACCESS_TOKEN
```
### 第三方调用
- 调用方式以及出入参和 HTTPS 相同，仅是调用的 token 不同
- 该接口所属的权限集 id 为：18
- 服务商获得其中之一权限集授权后，可通过使用[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)代商家进行调用
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； 如果是第三方代调用请传入[authorizer_access_token](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html)； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| code | string | 是 | 通过 [wx.pluginLogin](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.pluginLogin.html) 获得的插件用户标志凭证 code，有效时间为5分钟，一个 code 只能获取一次 openpid。 |
### 返回参数
| 属性 | 类型 | 说明 |
| :------ | :----- | :------------------- |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| openpid | string | 插件用户的唯一标识。 |
## 调用示例
> 示例说明: HTTPS请求示例
### 请求数据示例
```json
{
"code": "0c2b206443ce0c23338f6cb4d1ec15a1af0b8bcddbff26510dda4b23a433c391"
}
```
### 返回数据示例
```json
{
"errcode": 0,
"errmsg": "ok",
"openpid": "GACo74wkDIkDzEhkwRwgjGt1pqlk"
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------ | :----------------------------------------------------------- |
| 0 | ok | ok |
| 40016 | invalid button size | 不合法的按钮个数 |
| 45009 | reach max api daily quota limit | 天级别频率限制，2种解决途径2选1: 1.到小程序 mp- 开发管理 - 接口设置 - 调用额度重置;2.调用限频重置API |
| 1000 | 系统错误 | |
| 1022 | json数据解析错误 | |
| 1001 | 请求参数非法 | |
| 1003 | 请求频率过快 | |
| 1005 | 插件 appid 与数据不匹配 | |
| 1007 | openpid数据不存在 | |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/getUserEncryptKey.md 0 → 100644
View file @ 179ac129
用户信息 /网络 /获取用户encryptKey
# 获取用户encryptKey
> 接口应在服务器端调用，详细说明参见[服务端API](https://developers.weixin.qq.com/miniprogram/dev/framework/server-ability/backend-api.html)。
## 接口说明
### 接口英文名
getUserEncryptKey
### 功能描述
该接口用于获取用户encryptKey。 会获取用户最近3次的key，每个 key 的存活时间为3600s。
## 调用方式
### HTTPS 调用
```text
POST https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=ACCESS_TOKEN
```
### 请求参数
| 属性 | 类型 | 必填 | 说明 |
| :------------------------------------ | :----- | :--- | :----------------------------------------------------------- |
| access_token / cloudbase_access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过[getAccessToken](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)接口获得； cloudbase_access_token可通过[getOpenData](https://developers.weixin.qq.com/miniprogram/dev/wxcloudrun/src/guide/weixin/token.html)接口获得 |
| openid | string | 是 | 用户的openid |
| signature | string | 是 | 用 sessionkey 对空字符串签名得到的结果。session_key可通过code2Session接口获得。 |
| sig_method | string | 是 | 签名方法，只支持 hmac_sha256 |
### 返回参数
| | 属性 | 类型 | 说明 |
| :--- | :----------------------------------------------------------- | :------------ | :-------------------------- |
| | errcode | number | 错误码 |
| | errmsg | string | 错误信息 |
| | key_info_list | array<object> | 用户最近三次的加密 key 列表 |
| | 属性类型说明encrypt_keystring加密keyversionnumberkey的版本号expire_innumber剩余有效时间ivstring加密ivcreate_timenumber创建 key 的时间戳 | | |
## 调用示例
> 示例说明: HTTPS调用
### 请求数据示例
```json
{
"openid":"OPENID",
"signature":"SIGNATURE",
"sig_method":"hmac_sha256"
}
```
### 返回数据示例
```json
{
"errcode":0,
"errmsg":"ok",
"key_info_list":
[
{
"encrypt_key":"VI6BpyrK9XH4i4AIGe86tg==",
"version":10,
"expire_in":3597,
"iv":"6003f73ec441c386",
"create_time":1616572301
},
{
"encrypt_key":"aoUGAHltcliiL9f23oTKHA==",
"version":9,
"expire_in":0,
"iv":"7996656384218dbb",
"create_time":1616504886
},
{
"encrypt_key":"MlZNQNnRQz3zXHHcr6A3mA==",
"version":8,
"expire_in":0,
"iv":"58a1814f88883024",
"create_time":1616488061
}
]
}
```
### 错误码
| 错误码 | 错误码取值 | 解决方案 |
| :----- | :------------------------------------------------------ | :----------------------------------------------------------- |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口 |
| | | |
| :--- | :--- | :--- |
| | | |
| | | |
| | | |
\ No newline at end of file
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/readme.md → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/readme.md
View file @ 179ac129
- [登录](login/code2Session.md) - [登录](../login/code2Session.md)
- [code2Session](login/code2Session.md) - [code2Session](../login/code2Session.md)
- 用户信息 - 用户信息
- [checkEncryptedData](user/checkEncryptedData.md) - [checkEncryptedData](checkEncryptedData.md)
- [getPaidUnionId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.getPaidUnionId.html) - [getPaidUnionId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.getPaidUnionId.html)
- [getPluginOpenPId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.getPluginOpenPId.html) - [getPluginOpenPId](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.getPluginOpenPId.html)
- [接口调用凭证](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html) - [接口调用凭证](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/access-token/auth.getAccessToken.html)
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/WxXcxAuthCheckEncryptedDataService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/WxXcxAuthCheckEncryptedDataService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service; package com.yanzuoguang.wxxcx.user.service;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/WxXcxAuthGetPaidUnionIdService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/WxXcxAuthGetPaidUnionIdService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service; package com.yanzuoguang.wxxcx.user.service;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPaidUnionIdReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPaidUnionIdReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPaidUnionIdRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPaidUnionIdRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/WxXcxAuthGetPluginOpenPidService.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/WxXcxAuthGetPluginOpenPidService.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service; package com.yanzuoguang.wxxcx.user.service;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPluginOpenPidReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPluginOpenPidReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPluginOpenPidRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPluginOpenPidRes;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
/** /**
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/WxXcxGetPhoneNumberService.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.user.WxXcxGetPhoneNumberReq;
import com.yanzuoguang.wxxcx.user.WxXcxGetPhoneNumberRes;
/**
* 获取手机号 接口
*
* @author 李贤军
*/
public interface WxXcxGetPhoneNumberService {
/**
* 获取手机号
*
* @param accessToken accessToken
* @param req 获取手机号 入参
* @return 获取手机号 返回
*/
WxXcxGetPhoneNumberRes getGetPhoneNumber(WxXcxAccessToken accessToken, WxXcxGetPhoneNumberReq req);
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/WxXcxGetUserEncryptKeyService.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user.service;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.user.WxXcxGetUserEncryptKeyReq;
import com.yanzuoguang.wxxcx.user.WxXcxGetUserEncryptKeyRes;
/**
* 获取用户encryptKey 接口
*
* @author 李贤军
*/
public interface WxXcxGetUserEncryptKeyService {
/**
* 获取用户encryptKey
*
* @param accessToken accessToken
* @param req 获取用户encryptKey 入参
* @return 获取用户encryptKey 返回
*/
WxXcxGetUserEncryptKeyRes getGetUserEncryptKey(WxXcxAccessToken accessToken, WxXcxGetUserEncryptKeyReq req);
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/impl/WxXcxAuthCheckEncryptedDataServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/impl/WxXcxAuthCheckEncryptedDataServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service.impl; package com.yanzuoguang.wxxcx.user.service.impl;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRequest; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRequest;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthCheckEncryptedDataRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthCheckEncryptedDataRes;
import com.yanzuoguang.wxxcx.auth.user.service.WxXcxAuthCheckEncryptedDataService; import com.yanzuoguang.wxxcx.user.service.WxXcxAuthCheckEncryptedDataService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/impl/WxXcxAuthGetPaidUnionIdServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/impl/WxXcxAuthGetPaidUnionIdServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service.impl; package com.yanzuoguang.wxxcx.user.service.impl;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPaidUnionIdReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPaidUnionIdReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPaidUnionIdRequest; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPaidUnionIdRequest;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPaidUnionIdRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPaidUnionIdRes;
import com.yanzuoguang.wxxcx.auth.user.service.WxXcxAuthGetPaidUnionIdService; import com.yanzuoguang.wxxcx.user.service.WxXcxAuthGetPaidUnionIdService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/auth/user/service/impl/WxXcxAuthGetPluginOpenPidServiceImpl.java → yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/impl/WxXcxAuthGetPluginOpenPidServiceImpl.java
View file @ 179ac129
package com.yanzuoguang.wxxcx.auth.user.service.impl; package com.yanzuoguang.wxxcx.user.service.impl;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPluginOpenPidReq; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPluginOpenPidReq;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPluginOpenPidRequest; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPluginOpenPidRequest;
import com.yanzuoguang.wxxcx.auth.user.WxXcxAuthGetPluginOpenPidRes; import com.yanzuoguang.wxxcx.user.WxXcxAuthGetPluginOpenPidRes;
import com.yanzuoguang.wxxcx.auth.user.service.WxXcxAuthGetPluginOpenPidService; import com.yanzuoguang.wxxcx.user.service.WxXcxAuthGetPluginOpenPidService;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken; import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig; import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest; import com.yanzuoguang.wxxcx.base.WxXcxRequest;
......
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/impl/WxXcxGetPhoneNumberServiceImpl.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.user.WxXcxGetPhoneNumberReq;
import com.yanzuoguang.wxxcx.user.WxXcxGetPhoneNumberRequest;
import com.yanzuoguang.wxxcx.user.WxXcxGetPhoneNumberRes;
import com.yanzuoguang.wxxcx.user.service.WxXcxGetPhoneNumberService;
import org.springframework.stereotype.Component;
/**
* 获取手机号 实现
*
* @author 李贤军
*/
@Component
public class WxXcxGetPhoneNumberServiceImpl implements WxXcxGetPhoneNumberService {
private final WxXcxConfig wxXcxConfig;
private final WxXcxRequest wxXcxRequest;
public WxXcxGetPhoneNumberServiceImpl(WxXcxConfig wxXcxConfig, WxXcxRequest wxXcxRequest) {
this.wxXcxConfig = wxXcxConfig;
this.wxXcxRequest = wxXcxRequest;
}
/**
* 获取手机号
*
* @param accessToken accessToken
* @param req 获取手机号 入参
* @return 获取手机号 返回
*/
@Override
public WxXcxGetPhoneNumberRes getGetPhoneNumber(WxXcxAccessToken accessToken, WxXcxGetPhoneNumberReq req) {
WxXcxGetPhoneNumberRequest request = new WxXcxGetPhoneNumberRequest(wxXcxConfig, wxXcxRequest, accessToken, req);
return request.getResponse();
}
}
yzg-util-wxxcx/src/main/java/com/yanzuoguang/wxxcx/user/service/impl/WxXcxGetUserEncryptKeyServiceImpl.java 0 → 100644
View file @ 179ac129
package com.yanzuoguang.wxxcx.user.service.impl;
import com.yanzuoguang.wxxcx.base.WxXcxAccessToken;
import com.yanzuoguang.wxxcx.base.WxXcxConfig;
import com.yanzuoguang.wxxcx.base.WxXcxRequest;
import com.yanzuoguang.wxxcx.user.WxXcxGetUserEncryptKeyReq;
import com.yanzuoguang.wxxcx.user.WxXcxGetUserEncryptKeyRequest;
import com.yanzuoguang.wxxcx.user.WxXcxGetUserEncryptKeyRes;
import com.yanzuoguang.wxxcx.user.service.WxXcxGetUserEncryptKeyService;
import org.springframework.stereotype.Component;
/**
* 获取用户encryptKey 实现
*
* @author 李贤军
*/
@Component
public class WxXcxGetUserEncryptKeyServiceImpl implements WxXcxGetUserEncryptKeyService {
private final WxXcxConfig wxXcxConfig;
private final WxXcxRequest wxXcxRequest;
public WxXcxGetUserEncryptKeyServiceImpl(WxXcxConfig wxXcxConfig, WxXcxRequest wxXcxRequest) {
this.wxXcxConfig = wxXcxConfig;
this.wxXcxRequest = wxXcxRequest;
}
/**
* 获取用户encryptKey
*
* @param accessToken accessToken
* @param req 获取用户encryptKey 入参
* @return 获取用户encryptKey 返回
*/
@Override
public WxXcxGetUserEncryptKeyRes getGetUserEncryptKey(WxXcxAccessToken accessToken, WxXcxGetUserEncryptKeyReq req) {
WxXcxGetUserEncryptKeyRequest request = new WxXcxGetUserEncryptKeyRequest(wxXcxConfig, wxXcxRequest, accessToken, req);
return request.getResponse();
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment