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