# 向WMPF推送消息

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

接口英文名：pushAppMsg

本接口用于向 WMPF [推送消息](/doc/oplatform/Miniprogram_Frame/push) 

access_token 使用移动应用 AppID（即 LauncherAPP 的 AppID ）或小程序的身份

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/business/runtime/pushappmsg?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "msg",
    "类型": "string",
    "必填": "是",
    "说明": "推送消息内容，大小不超过 5 KB"
  },
  {
    "参数名": "push_token",
    "类型": "string",
    "必填": "是",
    "说明": "从 WMPF 获取的 pushToken"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

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

## 4. 注意事项

调用该接口时还需要获取 `access_token` ，获取方式[详见此处](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken.md)。

最终应用上收到的消息内容的 JSON 数据包

| 属性  | 类型   | 是否必填 | 说明                          |
| ----- | ------ | -------- | ----------------------------- |
| msg   | string | 是       | 推送消息内容，大小不超过 5 KB |
| appid | string | 是       | 小程序标识                    |

## 5. 代码示例

请求示例

```json
{
  "msg": "your msg",
  "push_token": "your push token"
}
```

返回示例

```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
[
  {
    "错误码": "0",
    "错误描述": "成功"
  },
  {
    "错误码": "40101",
    "错误描述": "参数错误"
  },
  {
    "错误码": "45002",
    "错误描述": "推送内容长度超过限制"
  },
  {
    "错误码": "48012",
    "错误描述": "token 无效"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。