# 查询背景图
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getbackground
通过该接口可查询当前生效的背景图和流程中的申请。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/basics/homepage/background/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129、131
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
errcode | number | 0 | 错误码 |
errmsg | string | ok | 错误信息 |
img_url | string | https://mmecimage.cn/p/abc | 当前生效的背景图片url。 |
apply | object | 最近一次流程中的申请。已生效/已撤销的申请不返回。 |
# Res.apply Object Payload
最近一次流程中的申请。已生效/已撤销的申请不返回。
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
apply_id | number | 123 | 申请编号 |
state | number | 2 | 申请状态。枚举值可参考下文 |
audit_desc | string | 图片不合规 | 审核结果描述。state为审核驳回时有值。 |
img_url | string | https://mmecimage.cn/p/xyz | 图片url |
# 4. 注意事项
申请状态
枚举值 | 描述 |
---|---|
1 | 审核中 |
2 | 审核驳回 |
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/channels/ec/basics/homepage/background/get?access_token=ACCESS_TOKEN
返回示例
{
"errcode": 0,
"errmsg": "ok",
"img_url": "https://mmecimage.cn/p/abc",
"apply": {
"apply_id": 123,
"state": 2,
"audit_desc": "图片不合规",
"img_url": "https://mmecimage.cn/p/xyz"
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
268549676 | 既无生效中的主页背景图,也无流程中的申请。 | |
268555516 | 无权限,仅供微信小店使用。 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。