轮询查询即时消息

功能介绍

轮询查询即时消息接口

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/servicerequest/cases/instant-messages

表1 Query参数
参数	是否必选	参数类型	描述
case_ids	是	Array	工单id 数组长度：0 - 100
last_message_time_id	否	String	上次查询留言的时间最小长度：0 最大长度：64
group_id	否	String	组id 最小长度：0 最大长度：64
trim_osm_rich_text_label	否	Boolean	是否去除富文本，默认值为true

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：5000
X-Language	否	String	语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。最小长度：1 最大长度：32
X-Time-Zone	否	String	环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。涉及时间的数据会根据环境时区处理。最小长度：1 最大长度：32

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
imstatus	Array of ImStatusV2 objects	状态列表数组长度：0 - 100
immsg	Array of UserInstantIncidentMsgV2 objects	留言内容列表数组长度：0 - 100
last_message_time_id	String	上次查询留言时间最小长度：0 最大长度：64

表4 ImStatusV2
参数	参数类型	描述
status	Integer	状态，0 未读 1已读最小值：0 最大值：1
incident_id	String	工单id 最小长度：0 最大长度：64

表5 UserInstantIncidentMsgV2
参数	参数类型	描述
incident_id	String	工单id 最小长度：0 最大长度：64
message_list	Array of QueryMessageInfoV2 objects	留言列表
update_messages	Array of 表8 MessageUpdateV2 objects	更新留言列表

表6 QueryMessageInfoV2
参数	参数类型	描述
type	Integer	类型，可以删除 0是客户留言 1是客服留言最小值：0 最大值：1
replier_type	Integer	回复人类型，0是客户留言 1是客服留言最小值：0 最大值：3
replier	String	回复人id 最小长度：0 最大长度：64
content	String	留言内容最小长度：0 最大长度：400
create_time	String	创建时间
replier_name	String	回复人名称最小长度：0 最大长度：256
iam_user_type	Integer	子用户类型，0主账号 1子账号最小值：0 最大值：3
accessory_list	Array of SimpleAccessoryV2 objects	附件列表数组长度：0 - 5
message_id	String	消息id
status	Integer	状态
display_type	String	消息展示类型， NORMAL: 普通留言, QA_BOT: 智能客服对话, EXT_PARAM_REQUEST: 索要附加参数, AUTH: 索要授权
extension	String	留言展示扩展信息

表7 SimpleAccessoryV2
参数	参数类型	描述
accessory_id	String	附件id 最小长度：0 最大长度：64
file_actual_name	String	附件实际名称最小长度：0 最大长度：256

表8 MessageUpdateV2
参数	参数类型	描述
message_id	String	消息id
status	Integer	状态 -1已撤回, 1已读

请求示例

GET https://{endpoint}/v2/servicerequest/cases/instant-messages?trim_osm_rich_text_label=false&case_ids=case123&last_message_time_id=e9eaa5053408469387ac7fba56b5d00e

响应示例

状态码： 200

成功返回200

{
	"imstatus": [{
		"status": null,
		"incident_id": null
	}],
	"immsg": [{
		"incident_id": "TS202603275SQAEFGS0404",
		"message_list": [{
			"type": 0,
			"status": 0,
			"replier": "8c50e7009bc34556a91ecc33f31b9feb",
			"content": "<div class=\"osm-rich-text\"><p>bbb</p></div>",
			"create_time": "2026-03-30T08:57:47.921+00:00",
			"message_id": "0f4b6fa0cd2a4be297a4fb6e064e974d",
			"replier_name": "op_svc_hecops",
			"display_type": "NORMAL",
			"iam_user_type": 0,
			"accessory_list": []
		}],
		"update_messages": [{
			"message_id": "0f4b6fa0cd2a4be297a4fb6e064e974d",
			"status": 0
		}]
	}],
	"last_message_time_id": "24ab7eac3fb9485daa8ca2d65411f31f"
}