Skip to content

获取工单消息详情

该接口用于获取服务台工单消息详情。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/helpdesk/v1/tickets/:ticket_id/messages
HTTP MethodGET
接口频率限制特殊频控
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用helpdesk:all:readonly 获取服务台资源详情

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

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

Key: X-Lark-Helpdesk-Authorization

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

了解更多:获取与使用服务台token

路径参数

名称类型描述
ticket_idstring工单ID
示例值:"6948728206392295444"

查询参数

名称类型必填描述
time_startint起始时间
示例值:1617960686
time_endint结束时间
示例值:1617960687
pageint页数ID
示例值:1
page_sizeint消息数量,最大200,默认20
示例值:10

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ messagesticket.message\[\]工单消息列表
    └ idstring工单消息ID
    └ message_idstringchat消息ID
    └ message_typestring消息类型;text:纯文本;post:富文本;image:图像;file:文件;media:视频
    └ created_atint创建时间
    └ contentstring内容
    └ user_namestring用户名
    └ avatar_urlstring用户图片url
    └ user_idstring用户open ID
  └ totalint消息总数

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "messages": [
            {
                "id": "6948728206392295444",
                "message_id": "6949088236610273307",
                "message_type": "text",
                "created_at": 1617960686000,
                "content": "{\"content\":\"进入人工服务。 @李宁  为你提供服务,开始聊起来吧~\",\"msg_type\":\"text\"}",
                "user_name": "李宁",
                "avatar_url": "https://internal-api-lark-file.feishu-boe.cn/static-resource/v1/3e73cdce-54b0-4c6a-8226-b131fb2825dj~?image_size=72x72&cut_type=&quality=&format=image&sticker_format=.webp",
                "user_id": "ou_37019b7c830210acd88fdce886e25c71"
            }
        ],
        "total": 100
    }
}

错误码

HTTP状态码错误码描述排查建议
400154000Bad request, please check your request body请求不合法,请检查参数
401154001Unauthorized, please check you have the correct access检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确,应用和服务台属于同一租户
403154003Please check you have the correct access检查是否申请正确权限
500155000Internal error内部错误,请联系我们

内容来源:飞书开放平台 · 自动爬取整理