服务商代开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
服务商代开发
服务端API
会话内容存档
会话搜索
会话消息搜索
会话消息搜索
最后更新:2024/07/12

服务商可调用接口对企业会话的内容进行搜索
权限说明

仅支持对部分消息内容进行搜索,包括:
文本消息的消息内容
图文混合消息中的文本内容
文件消息的文件名称
链接消息的消息标题
小程序消息的消息标题
在线文档消息的文档名称
微盘文件消息的文件名称
应用类型权限要求
自建应用暂不支持
代开发应用暂不支持
第三方应用暂不支持
会话存档接口授权需具备「会话存档接口权限- 获取会话记录」权限

 

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/chatdata/search_msg?access_token=ACCESS_TOKEN

请求包体:


	"query_word": "欢迎",
	"chat_info": {
		"chat_type": 1,
		"id_list": [ {
				"open_userid": "OPEN_USERID"
			}, {
				"external_userid": "EXTERNALID1"
			}
		],
		//"chat_id : "CHATID"
	},
	"start_time":1668355200,
	"end_time":1668528000,
	"limit": 50,
	"cursor": "CURSOR"

参数说明:

参数是否必须说明
access_token调用接口凭证
query_word搜索的文本,要求大于等于2个UTF8字符。
chat_info指定要搜索的会话范围
chat_info.chat_type指定会话类型,若填写则从指定的会话类型中搜索。
1:单聊;2:群聊
chat_info.id_listchat_type为单聊时有效,会话双方的id,该列表长度必须为2,详见IdInfo
chat_info.chat_idchat_type为群聊时有效,若填写则从指定的群聊会话id中搜索
start_time指定搜索会话范围的起始时间,Unix时间戳
end_time指定搜索会话范围的结束时间,Unix时间戳。若指定了end_time,也必须指定start_time,start_time必须小于end_time,且时间范围不超过30天整;若都不指定则默认时间范围为当前时刻往前30天内。
limit用于分页查询,每次请求返回的数据上限。最大为100,不填默认为50
cursor用于分页查询的游标,字符串类型,由上一次调用返回,首次调用可不填

IdInfo说明:

参数是否必须说明
open_userid成员ID。会话者的身份类型为企业成员时填,优先识别该字段
external_userid客户ID。会话者的身份类型为为客户时填

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"has_more": 1,
	"next_cursor": "CURSOR",
	"msg_list":[
		{
			"msgid": "xxxmsgid"
		},
		{
			"msgid": "yyymsgid"
		}
	]
}

参数说明:

参数说明
errcode错误码
errmsg错误码说明
has_more是否还有更多数据未获取,不填默认为0
0: 否
1: 是
next_cursor下一次请求的cursor值
msg_list搜索结果的消息列表,按消息发送时间降序排序
msgid每条消息对应的msgid
上一篇会话名称搜索
下一篇关键词规则管理
    本节内容
服务端API
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们