# 添加半屏小程序
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:addEmbedded
本接口用于添加半屏小程序,使用过程中如遇到问题,可在开放平台服务商专区发帖交流
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxaapi/wxaembedded/add_embedded?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 添加的半屏小程序 appid |
| apply_reason | string | 否 | 申请理由,不超过 30 个字 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# 4. 注意事项
1、如果被添加的半屏小程序设置为"需管理员验证",那么调用该接口申请添加半屏小程序后,会下发模板消息至被添加的半屏小程序管理员,需等对方管理员同意后方可添加成功,可通过get_list接口查看通过状态。
2、如果被添加的半屏小程序设置为"自动授权通过",那么调用该接口申请添加半屏小程序后,即可添加成功,可通过get_list接口查看通过状态。
3、如果被添加的半屏小程序设置为"拒绝授权邀请",那么调用该接口申请添加半屏小程序后,即刻被拒绝,可通过get_list接口查看通过状态。
4、一个小程序最多可调用10个半屏小程序;一天最多申请50个半屏小程序;
5、服务商一天最多可通过api代10个小程序申请添加同一个半屏小程序;
6、一个半屏小程序最多可授权给1000个小程序调用;
7、24h内,最多申请3次同一个半屏小程序;
8、其他使用限制可查看:小程序跳转小程序-半屏模式说明
# 5. 代码示例
请求示例
{
"appid": "wxf074af703a2xxx3",
"apply_reason": "我要申请"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40001 | invalid credential access_token isinvalid or not latest | access_token 无效或不为最新获取的 access_token,请开发者确认access_token的有效性 |
| 89408 | 半屏小程序系统错误 | |
| 89409 | 获取半屏小程序列表参数错误 | |
| 89410 | 添加半屏小程序appid参数错误 | |
| 89411 | 添加半屏小程序appid参数为空 | |
| 89412 | 添加半屏小程序申请理由不得超过30个字 | |
| 89413 | 该小程序被申请次数已达24h限制 | |
| 89414 | 每天仅允许申请50次半屏小程序 | |
| 89418 | 获取半屏小程序每日申请次数失败 | |
| 89419 | 获取半屏小程序每日授权次数失败 | |
| 89420 | 不支持添加个人主体小程序 | |
| 89423 | 申请次数添加到达上限 | |
| 89424 | 授权次数到达上限 | |
| 89425 | 申请添加已超时 | |
| 89426 | 申请添加状态异常 | |
| 89427 | 申请号和授权号相同 | |
| 89428 | 该小程序已申请,不允许重复添加 | |
| 89429 | 已到达同一小程序每日最多申请次数 | |
| 89430 | 该小程序已设置自动拒绝申请 | |
| 89431 | 不支持此类型小程序 | |
| 89432 | 不是小程序 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。