# 添加半屏小程序

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：addEmbedded

本接口用于添加半屏小程序。使用过程中如遇到问题，可在[开放平台服务商专区](https://developers.weixin.qq.com/community/minihome/mixflow/1355698687267438595)发帖交流

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxaapi/wxaembedded/add_embedded?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：18

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "必填": "是",
    "说明": "添加的半屏小程序 appid"
  },
  {
    "参数名": "apply_reason",
    "类型": "string",
    "必填": "否",
    "说明": "申请理由，不超过 30 个字"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

1、如果被添加的半屏小程序设置为"需管理员验证"，那么调用该接口申请添加半屏小程序后，会下发模板消息至被添加的半屏小程序管理员，需等对方管理员同意后方可添加成功，可通过get_list接口查看通过状态。

2、如果被添加的半屏小程序设置为"自动授权通过"，那么调用该接口申请添加半屏小程序后，即可添加成功，可通过[get_list接口](api_getembeddedlist)查看通过状态。

3、如果被添加的半屏小程序设置为"拒绝授权邀请"，那么调用该接口申请添加半屏小程序后，即刻被拒绝，可通过[get_list接口](api_getembeddedlist)查看通过状态。

4、一个小程序最多可调用10个半屏小程序；一天最多申请50个半屏小程序；

5、服务商一天最多可通过api代10个小程序申请添加同一个半屏小程序；

6、一个半屏小程序最多可授权给10000个小程序调用；

7、24h内，最多申请3次同一个半屏小程序；

8、其他使用限制可查看：[小程序跳转小程序-半屏模式说明](/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.md)

## 5. 代码示例

请求示例

```json
{
  "appid": "wxf074af703a2xxx3",
  "apply_reason": "我要申请"
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok"
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "access_token 无效或不为最新获取的 access_token，请开发者确认access_token的有效性"
  },
  {
    "错误码": "89408",
    "错误描述": "半屏小程序系统错误",
    "解决方案": "系统错误，请稍后重试"
  },
  {
    "错误码": "89409",
    "错误描述": "获取半屏小程序列表参数错误",
    "解决方案": "请检查获取半屏小程序列表的分页参数是否合法"
  },
  {
    "错误码": "89410",
    "错误描述": "添加半屏小程序appid参数错误",
    "解决方案": "请检查appid是否有效"
  },
  {
    "错误码": "89411",
    "错误描述": "添加半屏小程序appid参数为空",
    "解决方案": "请检查appid是否为空值"
  },
  {
    "错误码": "89412",
    "错误描述": "添加半屏小程序申请理由不得超过30个字",
    "解决方案": "请确保申请理由不超过30个字"
  },
  {
    "错误码": "89413",
    "错误描述": "该小程序被申请次数已达24h限制",
    "解决方案": "该小程序被申请次数已达24h限制，请稍后重试"
  },
  {
    "错误码": "89414",
    "错误描述": "每天仅允许申请50次半屏小程序",
    "解决方案": "当天已申请50次半屏小程序，请稍后重试"
  },
  {
    "错误码": "89418",
    "错误描述": "获取半屏小程序每日申请次数失败",
    "解决方案": "获取半屏小程序每日申请次数失败，请稍后重试"
  },
  {
    "错误码": "89419",
    "错误描述": "获取半屏小程序每日授权次数失败",
    "解决方案": "获取半屏小程序每日授权次数失败，请稍后重试"
  },
  {
    "错误码": "89420",
    "错误描述": "不支持添加个人主体小程序",
    "解决方案": "不支持添加个人主体小程序，请添加符合要求的小程序"
  },
  {
    "错误码": "89423",
    "错误描述": "申请次数添加到达上限",
    "解决方案": "申请次数添加到达上限，请稍后重试"
  },
  {
    "错误码": "89424",
    "错误描述": "授权次数到达上限",
    "解决方案": "授权次数到达上限，请稍后重试"
  },
  {
    "错误码": "89425",
    "错误描述": "申请添加已超时",
    "解决方案": "申请添加已超时，请稍后重试"
  },
  {
    "错误码": "89426",
    "错误描述": "申请添加状态异常",
    "解决方案": "申请添加状态异常，请稍后重试"
  },
  {
    "错误码": "89427",
    "错误描述": "申请号和授权号相同",
    "解决方案": "申请号和授权号相同，请勿申请该账号的小程序"
  },
  {
    "错误码": "89428",
    "错误描述": "该小程序已申请，不允许重复添加",
    "解决方案": "该小程序已申请，不允许重复添加"
  },
  {
    "错误码": "89429",
    "错误描述": "已到达同一小程序每日最多申请次数",
    "解决方案": "已到达同一小程序每日最多申请次数，请稍后重试"
  },
  {
    "错误码": "89430",
    "错误描述": "该小程序已设置自动拒绝申请",
    "解决方案": "该小程序已设置自动拒绝申请，请联系该小程序管理员"
  },
  {
    "错误码": "89431",
    "错误描述": "不支持此类型小程序",
    "解决方案": "不支持此类型小程序，请向有效的小程序发起申请"
  },
  {
    "错误码": "89432",
    "错误描述": "不是小程序",
    "解决方案": "不是小程序，请向有效的小程序发起申请"
  }
]
```

## 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。