# 查询签约关系
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:query_subscribe_contract
本接口用于查询签约关系
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/xpay/query_subscribe_contract?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:157
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 用户的openid |
| product_id | string | 是 | 道具 id,需为订阅制道具 |
| out_contract_code | string | 是 | 签约时传入的协议号 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| authorization_state | string | SIGNED: 签约生效中。TERMINATED: 生效的签约协议已被解约。此时协议已经到达终态,该协议无法再次进行签约;可更换协议号再发起签约。UNBINDUSER: 从未签约过 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
本接口无代码示例
# 6. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。