# 查询分账比例
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:GetShareRatio
该 API 用于查询服务商与小程序广告收入分账的比例。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/getdefaultamsinfo?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 component_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 查询该APPID生效的分账比例。1、如果为服务商的APPID,则返回的是服务商此时生效的默认分账比例;2、如果为小程序的APPID,则返回的是小程序此时生效的分账比例,且分账比例为服务商分账比例,即服务商在该小程序的广告收益中的占比。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| ret | number | 错误码 |
| err_msg | string | 错误信息 |
| share_ratio | number | 服务商的分成比例 |
# 4. 注意事项
其中access_token为component_access_token。
# 其他说明
假设小程序(appid为wxf3dsfsfsdf478)与授权服务商(appid为wxf3dsfsfsdf13d)分账比例中,授权服务商收益占比40%。 此时服务商(appid为wxf3dsfsfsdf13d)的默认分账比例为50%。
//查询 { "appid" : "wxf3dsfsfsdf13d" }
{ "ret": 0, "err_msg":"", "share_ratio": 50 }
//查询 { "appid" : "wxf3dsfsfsdf478" }
{ "ret": 0, "err_msg":"", "share_ratio": 40 }
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/wxa/getdefaultamsinfo?action=get_share_ratio&access_token=xxxxxxxxxxxxxxx
{
"appid": "wxf3dsfsfsdf13d"
}
返回示例
{
"ret": 0,
"err_msg": "",
"share_ratio": 50
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -202 | 内部错误 | 可在一段时间后重试 |
| 0 | ok | ok |
| 1700 | 参数错误 | 检验输入参数是否符合文档说明 |
| 1701 | 参数错误 | 检验输入参数是否符合文档说明 |
| 1735 | 商户未完成协议签署流程 | 完成签约操作 |
| 1737 | 操作过快 | 等待一分钟后重新操作 |
| 2056 | 服务商未在变现专区开通账户 | 在第三方平台页面的变现专区开通服务 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。