# 服务商取消分配资源包
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:cancelAssign
服务商可通过本接口取消已分配的资源包。
同时符合以下两条,才能取消分配:
- 分配的7天内
- 且分配的资源包未被使用
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/charge/service-provider/package/cancel_assign?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| orderId | string | 是 | 要取消分配的服务商订单ID,如 DD2970445798112968704 |
| requestId | string | 是 | 唯一请求 ID,需与请求分配接口`assignPackage`时的值一致。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
- 取消分配为异步任务,接口调用成功后,取消分配是否最终成功,请以服务端消息推送的取消分配结果事件为准。
# 5. 代码示例
请求示例
{
"orderId": "DD2970445798112968704",
"requestId": "1687254272930"
}
返回示例
{
"errcode": 0,
"errmsg": ""
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10120002 | 参数错误 | |
| 10120405 | 方法不可用 | 对照文档使用正确的方法请求 |
| 10120800 | 订单ID不合法 |
# 7. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。