# 接口调用凭证
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取接口调用凭据 | /cgi-bin/token | 本接口用于获取获取全局唯一后台接口调用凭据(Access Token),token 有效期为 7200 秒,开发者需要进行妥善保存,使用注意事项请参考此文档 |
| 获取稳定版接口调用凭据 | /cgi-bin/stable_token | 本接口用于获取获取全局唯一后台接口调用凭据(Access Token),token 有效期为 7200 秒,但此接口和 getAccessToken 互相隔离, |
# 登录
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 小程序登录凭证校验 | /sns/jscode2session | 登录凭证校验 |
| 检验登录态 | /wxa/checksession | 校验服务器所保存的登录态 sessionkey 是否有效 |
| 重置登录态 | /wxa/resetusersessionkey | 重置指定的登录态 sessionkey |
# 游戏内容安全
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 多媒体内容安全识别 | /wxa/media_check_async | 本接口用于异步校验图片/音频是否含有违法违规内容 |
| 文本内容安全识别 | /wxa/game/content_spam/msg_sec_check | 文本审核接口能够识别游戏领域常见的违规内容,例如:谩骂、低俗、营销广告、小语种,无意义灌水以及违法违规,帮助构建健康的游戏环境 |
| 图片内容安全识别 | /wxa/game/content_spam/media_check_sync | 图片审核接口能够识别游戏领域常见的违规内容,例如:色情,低俗软色情、血腥、恐怖、恶心不适、营销引流广告,辱骂以及违法违规,帮助构建健康的游戏环境 |
# 开放数据
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 删除已上报KV数据 | /wxa/remove_user_storage | 本接口用于删除已经上报到微信的 key-value 数据 |
| 写用户关系链互动数据存储 | /wxa/setuserinteractivedata | 本接口用来写入用户关系链互动数据存储 |
| 上报用户数据 | /wxa/set_user_storage | 上报用户数据后台接口 |
# 动态消息
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建activity_id | /cgi-bin/message/wxopen/activityid/create | 该接口用于创建被分享动态消息或私密消息的 activity_id |
| 修改动态消息 | /cgi-bin/message/wxopen/updatablemsg/send | 该接口用于修改被分享的动态消息 |
# 小程序码
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取小程序码 | /wxa/getwxacode | 该接口用于获取小程序码,适用于需要的码数量较少的业务场景 |
| 获取不限制的小程序码 | /wxa/getwxacodeunlimit | 该接口用于获取小程序码,适用于需要的码数量极多的业务场景 |
| 获取小程序二维码 | /cgi-bin/wxaapp/createwxaqrcode | 获取小程序二维码,适用于需要的码数量较少的业务场景 |
# URL-Scheme
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询scheme码 | /wxa/queryscheme | 该接口用于查询小程序 scheme 码,包括加密 scheme 和明文 scheme |
| 获取加密scheme码 | /wxa/generatescheme | 该接口用于获取小程序 scheme 码,适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景 |
# URL-Link
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取加密URLLink | /wxa/generate_urllink | 获取小程序 URL Link,适用于短信、邮件、网页、微信内等拉起小程序的业务场景 |
| 查询加密URLLink | /wxa/query_urllink | 该接口用于查询小程序加密 url_link 配置 |
# 数据分析
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取小游戏分析数据 | /datacube/getgameanalysisdata | 本接口用于获取小游戏分析数据 |
# 云开发
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 发送短信v2 | /tcb/sendsmsv2 | 发送携带 URL Link 的短信 |
| 发送短信 | /tcb/sendsms | 发送支持打开云开发静态网站的短信,该 H5 可以打开小程序 |
| 创建发短信任务 | /tcb/createsendsmstask | 该接口用于创建发短信任务 |
| 云开发上报接口 | /tcb/cloudbasereport | 该接口为云开发通用上报接口 |
| 查询短信记录 | /tcb/describesmsrecords | 该接口用于查询 2 个月内的短信记录 |
| 描述扩展上传文件信息 | /tcb/describeextensionuploadinfo | 该接口用于描述扩展上传文件信息 |
| 获取云开发数据 | /tcb/getstatistics | 该接口用于获取云开发数据 |
# 对局匹配
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建对局匹配规则 | /wxa/business/gamematch/creatematchrule | 小游戏创建对局匹配规则,并返回一个 matchid |
| 删除对局匹配规则 | /wxa/business/gamematch/deletematchrule | 小游戏删除对局匹配规则,每个规则对应一个唯一的 matchid |
| 获取对局匹配规则 | /wxa/business/gamematch/getallmatchrule | 获取小游戏拥有的所有 matchid 及其对应的匹配规则,以及 matchid 的打开状态 |
| 修改对局规则打开状态 | /wxa/business/gamematch/setmatchopenstate | 改 matchid 对应的打开状态 |
| 修改对局匹配规则 | /wxa/business/gamematch/updatematchrule | 修改 matchid 对应的匹配规则 |
# 网络
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取用户encryptKey | /wxa/business/getuserencryptkey | 该接口用于获取用户encryptKey |
# 帧同步
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建帧同步游戏房间 | /wxa/createwxagameroom | 第三方后台创建帧同步游戏房间 |
| 分片拉取对局游戏帧 | /wxa/getwxagameframe | 本接口用于分片拉取对局游戏帧 |
| 获取对局玩家位次信息 | /wxa/getwxagameidentityinfo | 本接口用于获取对局玩家位次信息 |
| 获取指定房间信息 | /wxa/getwxagameroominfo | 本接口用于获取指定房间信息 |
# 安全风控
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取用户安全等级 | /wxa/getuserriskrank | 该接口用于根据提交的用户信息数据获取用户的安全等级 risk_rank(无需用户授权) |
# 订阅消息
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 发送订阅消息 | /cgi-bin/message/subscribe/send | 该接口用于发送订阅消息 |
# 虚拟支付
# 游戏币
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询游戏币余额 | /wxa/game/getbalance | 查询游戏币余额 |
| 扣除游戏币 | /wxa/game/pay | 本接口开通了虚拟支付的小游戏可用 |
| 退回扣除游戏币 | /wxa/game/cancelpay | 本接口开通了虚拟支付的小游戏可用 |
| 给用户赠送游戏币 | /wxa/game/present | 本接口开通了虚拟支付的小游戏可用 |
# 订单
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询订单状态 | /wxa/game/queryorderinfo | 本接口用于查看订单状态 |