服务台机器人向工单绑定的群内发送消息

POST

https://open.feishu.cn/open-apis/helpdesk/v1/message

通过服务台机器人给指定用户的服务台专属群或私聊发送消息，支持文本、富文本、卡片、图片。

服务台请求Header中还需添加“服务台token”参数：

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token)，通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

错误码

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	内部错误，请联系我们

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/helpdesk/v1/message?user_id_type=open_id' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msg_type": "post",
    "content": "{\"post\":{\"zh_cn\":{\"title\":\"some title\",\"content\":[[{\"tag\":\"text\",\"text\":\"some content\"}]]}}}",
    "receiver_id": "ou_7346484524",
    "receive_type": "chat"
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "om_7054301238434"
  }
}

请求参数

Query 参数

user_id_type

string

可选

用户 ID 类型

示例值:

open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

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：通过服务台机器人私聊发送

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

message_id

string

必需

chat消息open_id

修改于 2023-02-02 06:50:45

获取工单消息详情

概述

服务台机器人向工单绑定的群内发送消息

错误码#

请求参数

返回响应

错误码