企业微信接口文档

# 接口地址

Base URLs:

- <a href="http://172.16.10.5:49999">测试环境: http://172.16.10.5:49999</a>
- <a href="https://bcp-api.wwxckj.com">生产环境: https://bcp-api.wwxckj.com</a>

## POST 发送文本消息给指定用户

POST /integration/wx_work/sendByWorkIds

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| workIds          | body   | Array | 是   | 工号，传多个时批量发送消息 |
| content          | body   | String | 是   | 消息内容 |
| companyId          | body   | String | 否   | 公司id，为空时默认发送“豆秒好车”企微提醒，需发送“豆秒数科”企微提醒时传入EHR系统的公司id |

> Body 参数示例

```json
{
    "workIds": ["ww0517"],
    "content":"这是一条测试消息",
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```

## POST 发送文本卡片消息给指定用户

POST /integration/wx_work/sendTextCardByWorkIds

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| workIds          | body   | Array | 是   | 工号，传多个时批量发送消息 |
| textCard          | body   | Object | 是   | 消息内容 |
| title          | textCard   | String | 是   | 标题 |
| description          | textCard   | String | 是   | 描述 |
| url          | textCard   | String | 是   | 点击后跳转的链接 |
| btntxt          | textCard   | String | 否   | 按钮文字 |
| companyId          | body   | String | 否   | 公司id，为空时默认发送“豆秒好车”企微提醒，需发送“豆秒数科”企微提醒时传入EHR系统的公司id |

> Body 参数示例

```json
{
    "workIds": ["ww0517"],
    "textCard": {
        "title": "领奖通知",
        "description": "<div class=\"gray\">2016年9月26日</div><div class=\"normal\">恭喜你抽中iPhone 7一台</div>",
        "url": "https://example.com",
        "btntxt": "更多"
    },
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```
> 企微消息展示
![](/media/202605/2026-05-11_141836_2549450.1518182437143566.png)

## POST 发送文件消息给指定用户

POST /integration/wx_work/sendFileByWorkIds

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| workIds          | body   | Array | 是   | 工号，传多个时批量发送消息 |
| fileUrl          | body   | String | 是   | 文件地址（obs文件地址） |
| safe          | body   | Integer | 否   | 表示是否是保密消息，0表示可对外分享，1表示不能分享且内容显示水印，默认为0，保密消息支持以下格式文件： txt、pdf、doc、docx、ppt、pptx、xls、xlsx、xml、jpg、jpeg、png、bmp、gif |
| companyId          | body   | String | 否   | 公司id，为空时默认发送“豆秒好车”企微提醒，需发送“豆秒数科”企微提醒时传入EHR系统的公司id |

> Body 参数示例

```json
{
    "workIds": ["ww0517"],
    "fileUrl":"https://xxx-yyy-dev.obs.cn-north-4.myhuaweicloud.com:443/report/2025/12/12/426.pdf",
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```

## POST 发送图文消息给指定用户

POST /integration/wx_work/sendImageByWorkIds

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| workIds          | body   | Array | 是   | 工号，传多个时批量发送消息 |
| images          | body   | Array | 是   | 图文对象 |
| title          | images   | String | 是   | 标题 |
| description          | images   | String | 是   | 描述 |
| picUrl          | images   | String | 是   | 图片地址（obs文件地址） |
| url          | images   | String | 否   | 点击后跳转的链接 |
| companyId          | body   | String | 否   | 公司id，为空时默认发送“豆秒好车”企微提醒，需发送“豆秒数科”企微提醒时传入EHR系统的公司id |

#### 单个images
> Body 参数示例

```json
{
    "workIds": [
        "ww0517"
    ],
    "images": [
        {
            "title": "中秋节礼品领取测试1",
            "description": "今年中秋节公司有豪礼相送测试1",
            "picUrl": "https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png",
            "url": "https://www.baidu.com/"
        }
    ],
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```
> 企微消息展示
![](/media/202604/2026-04-07_113004_3671840.1938199979957561.png)

#### 多个images
> Body 参数示例

```json
{
    "workIds": [
        "ww0517"
    ],
    "images": [
        {
            "title": "中秋节礼品领取测试1",
            "description": "今年中秋节公司有豪礼相送测试1",
            "picUrl": "https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png",
            "url": "https://example.com/"
        },
        {
            "title": "中秋节礼品领取测试2",
            "description": "今年中秋节公司有豪礼相送测试2",
            "picUrl": "https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png",
            "url": "https://www.baidu.com/"
        },
        {
            "title": "中秋节礼品领取测试3",
            "description": "今年中秋节公司有豪礼相送测试3",
            "picUrl": "https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png",
            "url": "https://cn.bing.com/"
        }
    ],
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```
> 企微消息展示
![](/media/202604/2026-04-07_113201_8474810.196479320757578.png)

## POST 发送Markdown消息给指定用户

POST /integration/wx_work/sendMarkdownByWorkIds

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| workIds          | body   | Array | 是   | 工号，传多个时批量发送消息 |
| markdown          | body   | Object | 是   | 消息内容 |
| content          | body   | String | 是   | markdown内容 |
| companyId          | body   | String | 否   | 公司id，为空时默认发送“豆秒好车”企微提醒，需发送“豆秒数科”企微提醒时传入EHR系统的公司id |

> Body 参数示例

```json
{
    "workIds": ["ww0517"],
    "markdown": {
        "content": "您的会议室已经预定，稍后会同步到`邮箱`  \n>**事项详情**  \n>事　项：<font color=\"info\">开会</font>  \n>组织者：@miglioguan  \n>参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang  \n>  \n>会议室：<font color=\"info\">广州TIT 1楼 301</font>  \n>日　期：<font color=\"warning\">2018年5月18日</font>  \n>时　间：<font color=\"comment\">上午9:00-11:00</font>  \n>  \n>请准时参加会议。  \n>  \n>如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)"
   },
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": {
        "msgId": "D2PfORmTcZSAQn8H7KP_zECAnySMGQNJDSjdoKWmXc8_-L6NtdehUtRx_CtC-sLv1S9KWLxbc9lOV598o9TyDivPu-7tglTwaWiPyWLuyZw"
    },
    "requestId": "2041388380923346944",
    "ok": true
}
```

## POST 撤回应用消息

POST /integration/wx_work/recall
本接口可以撤回24小时内通过发送应用消息接口推送的消息

### 请求参数

| 名称          | 位置   | 类型   | 必填 | 说明 |
| ------------- | ------ | ------ | ---- | ---- |
| Authorization | header | String | 是   | Bearer Token 通过万网中台 客户端模式获取 |
| msgId          | body   | String | 是   | 消息id |
| companyId          | body   | String | 否   | 公司id，为空时默认撤回“豆秒好车”企微提醒，需撤回“豆秒数科”企微提醒时传入EHR系统的公司id |

> Body 参数示例

```json
{
    "msgId": "D2PfORmTcZSAQn8H7KP_zPlahKdakh1UQnW5mkX9SSLJKiHWFgvNlD0n3fZPuib74RdgcLQz714GuEDO8O9k5YPIFwxIV69Jytwz4yBrAL8",
    "companyId": "corp001" // 可选参数
}
```

> 返回示例
```json
{
    "code": 0,
    "msg": null,
    "data": null,
    "requestId": "2041395562460987392",
    "ok": true
}
```