服务台机器人向工单绑定的群内发送消息
通过服务台机器人给指定用户的服务台专属群或私聊发送消息，支持文本、富文本、卡片、图片。
Warning: - 暂不支持新版卡片（ JSON 2.0 版本）。
- 暂不支持商店应用使用。
- 只支持向没有进行中工单的专属群中发送消息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/helpdesk/v1/message |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | helpdesk:all 更新服务台资源详情 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
Tip: 服务台请求Header中还需添加“服务台token”参数：
Key: X-Lark-Helpdesk-Authorization
Value: base64(helpdesk_id:helpdesk_token)，通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值： open_id当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
msg_type | string | 是 | 消息类型 示例值："post" 可选值有： - text: 普通文本 - post: 富文本 - image: 图片 - interactive: 卡片消息 |
content | string | 是 | 消息内容，json格式结构序列化成string。格式说明参考: 发送消息content说明 示例值："{"post":{"zh_cn": {\"title\":\"some title\",\"content\":[[{\"tag\":\"text\",\"text\":\"some content\"}]]}}}" |
receiver_id | string | 是 | 接收消息用户id 示例值："ou_7346484524" |
receive_type | string | 否 | 接收消息方式，chat(服务台专属服务群)或user(服务台机器人私聊)。若选择专属服务群，用户有正在处理的工单将会发送失败。默认以chat方式发送。 示例值："chat" 可选值有： - chat: 通过服务台专属群发送 - user: 通过服务台机器人私聊发送 |
请求体示例
json
{
"msg_type": "post",
"content": "{\"post\":{\"zh_cn\":{\"title\":\"some title\",\"content\":[[{\"tag\":\"text\",\"text\":\"some content\"}]]}}}",
"receiver_id": "ou_7346484524",
"receive_type": "chat"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ message_id | string | chat消息open_id |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"message_id": "om_7054301238434"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 154000 | Bad request, please check your request body | 请求不合法，请检查参数 |
| 401 | 154001 | Unauthorized, please check you have the correct access | 检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确，应用和服务台属于同一租户 |
| 403 | 154003 | Please check you have the correct access | 检查是否申请正确权限 |
| 404 | 154004 | Resource not found | 资源不存在，请检查ID值 |
| 405 | 154005 | Method Forbidden | 检查是否有权限创建推送 |
| 500 | 155000 | Internal error | 内部错误，请联系我们 |