开发者中心
首页
教程
接口
社区
工具
第三方应用开发
快速入门 服务端API 客户端API 运营规范 附录 更新日志 联系我们
第三方应用开发 服务端API 会话内容存档 关键词规则管理 关键词规则管理
关键词规则管理
最后更新：2024/03/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
关键词规则管理
最后更新：2024/03/01

目录

  • 规则适用范围结构体说明
  • 新增关键词规则
  • 获取关键词列表
  • 获取关键词规则详情
  • 修改关键词规则
  • 删除关键词规则


    • 可通过API管理客户会话关键词和关键行为，当消息命中时回调对应事件。

    权限说明

    应用类型权限要求
    自建应用暂不支持
    代开发应用暂不支持
    第三方应用暂不支持
    会话存档接口授权需具备「会话存档接口权限」

    规则适用范围结构体说明

    字段名类型是否必填说明
    target_typeObject否适用的对象类型
    target_type.type_listInteger数组否适用的对象类型列表，包括
    1-员工
    2-客户
    若填写则从指定的对象类型中识别，不填则默认包含员工与客户
    更新时指定空列表会清空该配置项
    chat_typeObject否适用的会话类型
    chat_type.type_listInteger数组否适用的会话类型列表，包括
    1-单聊
    2-群聊
    若填写则从指定的客户会话类型中识别，不填则默认包括单聊与群聊
    更新时指定空列表会清空该配置项
    departmentObject否适用的部门
    department.id_listInteger数组否适用的部门列表，列表大小不能超过100个。
    注意：如果未指定适用的对象类型（target_type），则会在指定部门列表和所有客户中生效。开发者预期仅在指定部门列表中生效的话，还需要配置适用对象类型为员工。
    更新时指定空列表会清空该配置项
    userObject否适用的员工
    user.id_listString数组否适用的员工open_userid列表，列表大小不能超过100个。
    注意：如果未指定适用的对象类型（target_type），则会在指定员工列表和所有客户中生效。开发者预期仅在指定员工列表中生效的话，还需要配置适用对象类型为员工。
    更新时指定空列表会清空该配置项
    external_contactObject否适用的客户
    external_contact.id_listString数组否适用的客户external_userid列表，列表大小不能超过100个。
    注意：如果未指定适用的对象类型（target_type），则会在指定客户列表和所有员工中生效。开发者预期仅在指定客户列表中生效的话，还需要配置适用对象类型为客户。
    更新时指定空列表会清空该配置项
    chatObject否适用的群聊
    chat.id_listString数组否适用的群聊chat_id列表，列表大小不能超过100个。
    注意：如果未指定适用的会话类型（chat_type），则会在指定群聊会话列表和所有单聊会话中生效。开发者预期仅在指定群聊会话列表中生效的话，还需要配置适用会话类型为群聊。
    更新时指定空列表会清空该配置项
    exclude_mobileObject否手机号白名单
    exclude_mobile.mobile_listString数组否手机号白名单列表，列表大小不能超过100个。会话消息中若命中白名单中手机号不产生回调
    更新时指定空列表会清空该配置项
    exclude_bank_cardObject否银行卡号白名单
    exclude_bank_card.bank_card_listString数组否银行卡号白名单列表，列表大小不能超过100个。会话消息中若命中白名单中银行卡号不产生回调
    更新时指定空列表会清空该配置项
    exclude_emailObject否邮箱地址白名单
    exclude_email.email_listString数组否邮箱地址白名单列表，列表大小不能超过100个。会话消息若命中白名单中的邮箱地址不产生回调
    更新时指定空列表会清空该配置项
    session_typeObject否适用的会话范围
    session_type.session_type_listInteger数组否适用的会话范围列表。
    1-内部会话
    2-外部会话
    更新时指定空列表会清空该配置项

    新增关键词规则

    通过此接口新建关键词规则，最多可创建100条规则。

    请求方式： POST（HTTPS）
    请求地址： https://qyapi.weixin.qq.com/cgi-bin/chatdata/keyword/create_rule?access_token=ACCESS_TOKEN

    请求包体：

    {
	"name": "已回复",
	"keyword": {
		"word_list": ["收到", "好的"]
	},
	"semantics": {
		"semantics_list": [1, 2]
	},
	"applicable_range": {
		"target_type":{
			"type_list":[1,2]
		},
		"department": {
			"id_list": [1, 2, 4]
		},
		"user": {
			"id_list": ["woaaaaaaaaa", "wobbbbbbbb"]
		},
		"external_contact": {
			"id_list": ["wossssssssss", "woxxxxxxxxxxx"]
		},
		"chat_type": {
			"type_list":[1,2]
		},
		"chat": {
			"id_list":["wrAAAAA","wrBBBBB"]
		},
		"exclude_mobile": {
			"mobile_list": ["+8612345679876"]
		},
		"exclude_email": {
			"email_list": ["zhangsan@qq.com"]
		},
		"exclude_bank_card":{
		   "bank_card_list": ["6234567891222"]
		},
		"session_type":{
			"session_type_list":[1,2]
		}
	}
}

    参数说明：

    参数是否必须说明
    access_token是调用接口凭证
    name是关键词规则名称，长度限制1~20个字符
    keyword_list否关键词列表，长度1~32个字符，列表大小不超过20个。关键词列表与关键行为列表必须选填一项
    semantics_list否关键行为列表
    1-红包
    2-手机号码
    3-邮箱地址
    4-微信名片
    5-带二维码图片
    6-撤回消息
    7-银行卡号
    8-身份证号
    9-发送文件（不包括微盘文件）
    10-发送链接（发送链接消息或者发送的文本消息中包含链接）
    关键行为列表与关键词列表必须选填一项
    applicable_range否规则适用说明，详细说明参考规则适用范围结构体说明

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok",
	"rule_id":"vvvvvvvvvvvvvvvvvxxxx"
}

    参数说明：

    参数说明
    errcode错误码
    errmsg错误码说明
    rule_id关键词规则id

     

    获取关键词列表

    通过此接口获取客户企业下的关键词规则列表

    请求方式： POST（HTTPS）
    请求地址： https://qyapi.weixin.qq.com/cgi-bin/chatdata/keyword/get_rule_list?access_token=ACCESS_TOKEN

    请求包体：

    {
	"cursor":"XMGIENJGJ",
	"limit":100
}

    参数说明：

    参数是否必须说明
    access_token是调用接口凭证
    cursor否由企业微信后台返回，第一次调用可不填
    limit否指定获取的数量上限，不填默认100

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok",
	"rule_list": [{
		"rule_id": "xxxxxxxxx",
		"name": "已回复",
		"create_time": 16666666666
	}],
	"has_more":false,
	"next_cursor":"JIUENGMG"
}

    参数说明：

    参数说明
    errcode错误码
    errmsg错误码说明
    has_more是否还有更多数据
    next_cursor下次调用时将该字段填入cursor中
    rule_list规则列表
    rule_id规则id
    name规则名字
    create_time规则创建时间对应的unix时间戳

    获取关键词规则详情

    通过此接口获取企业下的关键词规则详情

    请求方式： POST（HTTPS）
    请求地址： https://qyapi.weixin.qq.com/cgi-bin/chatdata/keyword/get_rule_detail?access_token=ACCESS_TOKEN

    请求包体：

    {
	"rule_id":"aaaaaaaaaaaaaaaa"
}

    参数说明：

    参数是否必须说明
    access_token是调用接口凭证
    rule_id是规则id

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok",
	"name": "已回复",
	"keyword": {
		"word_list": ["收到", "好的"]
	},
	"semantics": {
		"semantics_list": [1, 2]
	},
	"applicable_range": {
		"target_type":{
			"type_list":[1,2]
		},
		"department": {
			"id_list": [1, 2, 4]
		},
		"user": {
			"id_list": ["woAAAAAAAAAAA", "woBBBBBBBB"]
		},
		"external_contact": {
			"id_list": ["wossssssssss", "woxxxxxxxxxxx"]
		},
		"chat_type": {
			"type_list":[1,2]
		},
		"chat": {
			"id_list":["wrAAAAAAAAA","wrBBBBBBBBB"]
		},
		"exclude_mobile": {
			"mobile_list": ["+8612345679876"]
		},
		"exclude_email": {
			"email_list": ["zhangsan@qq.com"]
		},
		"exclude_bank_card":{
		   "bank_card_list": ["6234567891222"]
		},
		"session_type":{
			"session_type_list":[1,2]
		}
	}
}

    参数说明：

    参数说明 
    name关键词规则名称 
    keyword关键词列表 
    semantics关键行为列表 
    applicable_range否规则适用说明，详细说明参考规则适用范围结构体说明

    修改关键词规则

    通过此接口修改关键词规则

    请求方式： POST（HTTPS）
    请求地址： https://qyapi.weixin.qq.com/cgi-bin/chatdata/keyword/update_rule?access_token=ACCESS_TOKEN

    请求包体：

    {
	"rule_id": "wwwwwwwwwwwwwwwwwww",
	"name": "已回复",
	"keyword": {
		"word_list": ["收到", "好的"]
	},
	"semantics": {
		"semantics_list": [1, 2]
	},
	"applicable_range": {
		"target_type":{
			"type_list":[1,2]
		},
		"department": {
			"id_list": [1, 2, 4]
		},
		"user": {
			"id_list": ["woAAAAAAAAAA", "woBBBBBBBBBBBB"]
		},
		"external_contact": {
			"id_list": ["wossssssssss", "woxxxxxxxxxxx"]
		},
		"chat_type": {
			"type_list":[1,2]
		},
		"chat": {
			"id_list":["wrAAAAAAAAAAAA","wrBBBBBBBBBBB"]
		},
		"exclude_mobile": {
			"mobile_list": ["+8612345679876"]
		},
		"exclude_email": {
			"email_list": ["zhangsan@qq.com"]
		}
	}
}

    参数说明：

    参数是否必须说明
    access_token是调用接口凭证
    rule_id是规则id
    name否关键词规则名称，长度限制在1~20个字符
    keyword否关键词列表，关键词长度限制1~32个字符，列表大小不超过20个
    semantics否关键行为列表
    1-红包
    2-手机号码
    3-邮箱地址
    4-微信名片
    5-带二维码图片
    6-撤回消息
    7-银行卡号
    8-身份证号
    9-发送文件（不包括微盘文件）
    10-发送链接（发送链接消息或者发送的文本消息中包含链接）
    applicable_range否规则适用说明，详细说明参考规则适用范围结构体说明

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok"
}

    参数说明：

    参数说明
    errcode错误码
    errmsg错误码说明

    删除关键词规则

    可通过此接口删除关键词规则

    请求方式： POST（HTTPS）
    请求地址： https://qyapi.weixin.qq.com/cgi-bin/chatdata/keyword/delete_rule?access_token=ACCESS_TOKEN

    请求包体：

    {
	"rule_id":"lllllllllllllllll"
}

    参数说明：

    参数是否必须说明
    access_token是调用接口凭证
    rule_id是规则id

    返回结果：

    {
	"errcode": 0,
	"errmsg": "ok"
}

    参数说明：

    参数说明
    errcode错误码
    errmsg错误码说明
    上一篇
    会话消息搜索
    下一篇
    获取命中关键词规则的会话记录