SAAS saas_plat openapi stat

对话分析接口

通过API获取对话分析接口

• URL：https://api.nxcloud.com/saas/openapi/stat/query?page_number={page_number}&page_size={page_size}&start_date={start_date}&end_date={end_date}&tenant_id={tenant_id}&appkey={appkey}&dimension={dimension}&user_name={user_name}&user_group_name={user_group_name}&type={type}&response_type={response_type}
• Method：GET
• Content-Type：application/json
• 需要鉴权：是

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，公共约定

parameter 参数：

参数名	类型	必选	示例值	说明
tenant_id	Long	是	1	租户ID
appkey	String	是	pem28kje	应用appkey
page_number	integer	是	1	页数
page_size	integer	是	10	每页个数
start_date	String	是	开始查询日期	格式为yyyy-mm-dd
end_date	String	是	截止查询日期	格式为yyyy-mm-dd (时间查询范围不能超过6个月)
dimension	integer	是	统计维度	统计维度, 0: 客服, 1: 客服组, 2: 机器人
type	integer	是	时间维度	时间维度 0:天，1:小时
user_name	String	否	搜索用户名称
user_group_name	String	否	搜索分组名称
response_type	integer	否	响应类型	1:5分钟，2:1小时，3:12小时，4:24小时 (默认为1小时)

返回参数说明

参数名	类型	说明
list	array[data JsonObject]	请求结果
message	string	请求结果说明
code	integer	结果编码
total	integer	列表总数量
page_number	integer	页数
page_size	integer	每页数量

data

参数名	类型	说明
id	Long	对话分析id
user_id	Long	用户id
user_name	String	用户名称
user_email	String	用户邮箱
user_group_id	Long	分组id
user_group_name	String	分组名称
created_at	String	模板创建时间
conversation_count	Long	接入会话数
conversation_end_count	Long	结束会话数
message_count	Long	消息总数
message_user_count	Long	客服消息数
message_customer_count	Long	客户消息数
single_conversation_max_count	Long	单会话消息数最大值
single_conversation_avg_count	Long	单会话消息平均值
conversation_max_duration	Double	会话时长最大值
conversation_avg_duration	Double	会话时长平均值
intera_count	Long	处理对话数
first_response_count	Long	首次响应数量
first_response_duration	Double	首次响应时长
first_response_rate	Double	首次响应率
response_count	Long	响应数量
response_duration	Long	响应时长
response_rate	doDoubleble	响应率

响应示例

{
    "code": 0,
    "message": null,
    "traceId": "ee0e74276ff14dd58c43512c92ed9958.315.17223186559662193",
    "total": 19,
    "page_number": 1,
    "page_size": 10,
    "list": [
        {
            "id": 1310899,
            "user_id": 123445,
            "user_name": "",
            "user_email": "",
            "user_group_id": 0,
            "user_group_name": "",
            "created_at": "2024-07-26",
            "conversation_count": 0,
            "conversation_end_count": 1,
            "message_count": 0,
            "message_user_count": 0,
            "message_customer_count": 0,
            "single_conversation_max_count": 1,
            "single_conversation_avg_count": 1,
            "conversation_max_duration": 1216047.00,
            "conversation_avg_duration": 1216047.00,
            "conversation_first_response_avg_duration": 1216047.00,
            "intera_count": 0,
            "first_response_count": 0,
            "first_response_duration": 0,
            "first_response_rate": 0,
            "response_count": 0,
            "response_duration": 0,
            "response_rate": 0
        }  
    ],
    "ext": null,
    "empty": false,
    "notEmpty": true,
    "totalPages": 19
}

响应码说明

code	message	解决办法
0	请求成功
-1	请求失败	请联系技术人员排除问题
1000~100X	鉴权问题	详情查看API鉴权部分
21058	参数异常	tenant_id 必填
21059	参数异常	appkey必填
22016	参数异常	商户未配置WhatsApp应用
22215	参数异常	查询日期间隔不能超过6个月