在线统计

1、接口声明

在调用接口时必须在https请求的header中携带"token"参数。

token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token，开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时，需定时刷新，或根据接口返回的token失效提示，进行重新获取。请求token接口，无论token是否存在，都会返回新的token，并重置token的过期时间(目前24小时)。

token使用方式说明：
1、开发者需要统一获取和管理token，在调用智齿客服各个业务开放接 口时都应该使用同一个的token，不应该每个业务都刷新获取新的 token，否则容易导致token失效，影响接口的正常调用；
2、目前token的有效期通过返回的expire_in来传达，目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示，进行重新获取token。

2、接口调用

2.1、获取访问token编码

接口说明：

获取API开放接口token，此token仅适用于智齿开放平台 5.0版本全部API接口 。API接口中的参数 appid, app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

https://www.sobot.com/api/get_token

请求参数：

返回参数：

item对象：

时间戳转换参考工具：

http://tool.chinaz.com/Tools/unixtime.aspx

sign签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.2、机器人会话统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取机器人会话概览统计结果。

请求方式：

POST

请求地址：

http://www.sobot.com/api/wb/5/data/robot_session

请求参数：

返回参数：

item对象：

请求示例：

curl http://www.sobot.com/api/wb/5/data/robot_session
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01 01",
        "end_date": "2019-11-01 03"
    }'

返回示例：

{
    "item": {
        "avg_session_duration": "00:00:07",
        "consult_session": "63",
        "invalid_session": "20",
        "self_reception_rate": "53.49%",
        "self_reception_session": "23",
        "to_human_session": "20",
        "to_human_session_rate": "46.51%",
        "valid_reception_rate": "68.25%",
        "valid_session": "43"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.3、机器人满意度统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取机器人满意度评价统计结果。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/robot_satisfaction

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/robot_satisfaction
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01",
        "end_date": "2019-11-01"
    }'

返回示例：

 {
    "item": {
        "comment_rate": "2.33%",
        "effect_session_count": "43",
        "not_solved": "1",
        "resolution_rate": "0.00%",
        "solved": "0",
        "total_times": "1"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.4、人工会话统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取人工会话概览统计结果。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/human_session

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/human_session
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01 01",
        "end_date": "2019-11-01 03",
        "groupids": "a1d05d23f7744927a97bd6651d2b6ef7,edfcdcc480604bbc96f0585ee778a51a",
        "serviceids": "093685e7ae854979b3f07a97ea3685bc,738faf75873c4c47a79f4dfea83f164d"
    }'

返回示例：

{
    "item": {
        "avg_session_duration": "00:07:15",
        "black_session": "3",
        "consult_session": "132",
        "initiative_session": "3",
        "invalid_reception_rate": "20.21%",
        "invalid_reception_session": "19",
        "invalid_session": "38",
        "max_meantime_recption": "4",
        "not_mark_is_solved": "125",
        "not_reception_session": "34",
        "not_reception_session_rate": "36.17%",
        "not_solved_session": "0",
        "self_reception_session": "73",
        "self_reception_session_rate": "77.66%",
        "solved_session": "7",
        "transfer_in": "1",
        "transfer_out": "1",
        "transfer_session": "0",
        "valid_reception_rate": "43.62%",
        "valid_reception_session": "41",
        "valid_session": "94",
        "valid_session_rate": "71.21%",
        "response_time_avg_duration":"00:02:32",
        "queue_accept_zb":"66.67%",
        "avg_queue_accept_duration":"00:10:40",
        "session_leave_in_queue":"2",
        "accept_rate":"97.26%"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.5、人工满意度统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取人工满意度评价统计结果。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/human_satisfaction

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/human_satisfaction
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75334d5358802' 
-d '{
        "start_date": "2021-02-01 01",
        "end_date": "2021-03-01 03",
        "groupids": "a1d05d23f7744927a97bd6651d2b6ef7,edfcdcc480604bbc96f0585ee778a51a",
        "serviceids": "093685e7ae854979b3f07a97ea3685bc,738faf75873c4c47a79f4dfea83f164d"
    }'

返回示例：

 {
    "item": {
        "avg_num": "3.80",
        "bad": "1",
        "bad_rate": "20.00%",
        "comment_rate": "5.32%",
        "effect_session_count": "94",
        "good": "2",
        "good_rate": "40.00%",
        "initiative": "3",
        "initiative_rate": "60.00%",
        "invites": "2",
        "invites_rate": "-60.00%",
        "middle": "2",
        "middle_rate": "40.00%",
        "not_solved": "0",
        "score1": "0",
        "score2": "1",
        "score3": "1",
        "score4": "1",
        "solved": "5",
        "solved_count": "5",
        "solved_rate": "100.00%",
        "total_times": "5"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.6、客户会话统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取客户会话概览统计结果。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/customer_session

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/customer_session
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01",
        "end_date": "2019-11-01"
    }'

返回示例：

{
    "item": {
        "avg_session_duration": "00:04:03",
        "avg_total_session_duration": "00:08:53",
        "total_consult_session": "170",
        "total_invalid_session": "53",
        "total_valid_session": "117",
        "total_valid_session_rate": "68.82%"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.7、会话消息统计

接口说明：

接口类型：主动调用接口。

接口作用：可通过调用该接口来获取会话消息统计结果。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/message_stats

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/message_stats 
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01",
        "end_date": "2019-11-01"
    }'

返回示例：

{
    "item": {
        "answer_than": "79.78%",
        "avg_customer_message": "3.03",
        "avg_message": "5.59",
        "avg_service_messge": "1.89",
        "avg_service_word": "15.18",
        "customer_to_robot_message": "78",
        "customer_to_service_message": "277",
        "human_avg_customer_message": "2.95",
        "human_avg_message": "5.3",
        "human_avg_service_message": "2.35",
        "robot_avg_customer_message": "1.81",
        "robot_avg_message": "3.63",
        "robot_message": "78",
        "service_message": "221",
        "service_offline_num": "21",
        "service_word": "1427",
        "total_customer_message": "355",
        "total_human_message": "498",
        "total_message": "654"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.8、获取在线质检结果

接口说明：

接口类型：主动调用接口。

接口作用：获取在线质检结果

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/quality_result

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/quality_result 
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01",
        "end_date": "2019-11-01",
        "page":"1",
        "size":"100"
    }'

返回示例：

{
    "items": [
        {
            "add_quality_score": "20.0",
            "add_total_score": "20.0",
            "chat_start_time": "1572851882000",
            "cid": "eca23a4cb2ba45bbab32b6878775cfd2",
            "email": "123456@123.com",
            "minus_quality_score": "-10.0",
            "minus_total_score": "-20.0",
            "quality_score": "210.0",
            "schemeid": "44aea7fd6f57414f98d190bac0ee2d42",
            "staff_name": "在线客服",
            "staffid": "61673ee8d98d4282a95cdad38ffd5f5b",
            "standard_quality_score": "200.0",
            "standard_total_score": "200.0",
            "total_score": "200.0",
            "update_time": "1572954558319"
        }
    ],
    "ret_code": "000000",
    "ret_msg": "查询成功"
}

2.9、离线数据文件下载接口

接口说明：

接口类型：主动调用接口。

接口作用：可通过调用该接口来获取各个业务模块的原始数据，可用于企业对数据归档或做数据分析等。

注意：若需要使用该接口下载离线数据，需提前通知智齿进行数据整理安排，否则无法下载到数据。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/export_data

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/export_data 
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "task_type":  "2",
        "date": "2019-11-05",
    }'

返回示例：

{
    "item": {
        "file_path": "https://sobot-test.oss-cn-beijing.aliyuncs.com/expo105-1.zip",
        "companyid": "7e20834c439748c780ca9648ca6c0cde",
        "create_time": "1573027669037",
        "result_date": "2019-11-05",
        "task_type": "2"
    },
    "ret_code": "000000",
    "ret_msg": "成功"
}

2.10、订单统计推送接口

接口说明：

接口作用：客服订单推送接口

请求方式：

POST

请求地址：

https://www.sobot.com/chat-third/api/5/order/receive_order_data

请求参数：

返回参数：

请求示例：

{
    "union_code": "10001",
    "companyid": "5ae23431d5605a76fa11b40",
    "order_number": "WERW34B",
    "cus_partnerid": "389dshjkd",
    "order_time": "2020-04-30 20:11:00",
    "order_money": "888.99"
}

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.11、客服统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取客服统计数据。

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/get_service_data

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/get_service_data
-X POST 
-H 'content-type: application/json' 
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
        "start_date": "2019-08-01 01",
        "end_date": "2019-11-01 03",
        "groupids": "a1d05d23f7744927a97bd6651d2b6ef7,edfcdcc480604bbc96f0585ee778a51a",
        "serviceids": "093685e7ae854979b3f07a97ea3685bc,738faf75873c4c47a79f4dfea83f164d"
    }'

返回示例：

{
    "items":[
        {
            "avg_first_response_time":"00:00:05",
            "groupid":"a1d05d23f7744927a97bd6651d2b6ef7",
            "invalid_reception_session":"0",
            "not_reception_session":"1",
            "response_in30s_rate":"0.00%",
            "score1":"0",
            "score2":"0",
            "score3":"0",
            "score4":"0",
            "score5":"0",
            "serviceid":"093685e7ae854979b3f07a97ea3685bc",
            "total_times":"0",
            "transfer_first_response_rate":"0.00%",
            "transfer_out":"0",
            "valid_reception_session":"0",
            "valid_session":"1"
        },
        {
            "avg_first_response_time":"00:01:02",
            "groupid":"edfcdcc480604bbc96f0585ee778a51a",
            "invalid_reception_session":"0",
            "not_reception_session":"0",
            "response_in30s_rate":"0.00%",
            "score1":"0",
            "score2":"0",
            "score3":"0",
            "score4":"0",
            "score5":"0",
            "serviceid":"738faf75873c4c47a79f4dfea83f164d",
            "total_times":"0",
            "transfer_first_response_rate":"0.00%",
            "transfer_out":"0",
            "valid_reception_session":"0",
            "valid_session":"0"
        }
    ],
    "ret_code":"000000",
    "ret_msg":"成功"
}

2.12、客服登录时长统计

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口来获取客服登录时长数据

请求方式：

POST

请求地址：

https://www.sobot.com/api/wb/5/data/human_duration

请求参数：

返回参数：

item对象：

请求示例：

curl https://www.sobot.com/api/wb/5/data/human_duration
-X POST 
-H 'content-type: application/json' 
-H 'token: uac37cb1e9c740dba4b75a34d54n88a2' 
-d '{
    "start_date":"2021-03-12",
    "end_date":"2021-03-18",
    "serviceids":"ffb4fccb6c3a48a6b185ob5de171b6bb,083685e7a18549b9b3f07a97ea3675bc"
}'

返回示例：

{
    "items":[
        {
            "login_duration":"00:16:11",
            "online_duration":"00:16:12",
            "busy_duration":"00:16:13",
            "train_duration":"00:16:14",
            "eat_duration":"00:16:15",
            "meet_duration":"00:16:16",
            "active_duration":"00:16:17",
            "rest_duration":"00:16:18",
            "serviceid":"ffb4fccb6c3a48a6b185ob5de171b6bb"
        },
        {
            "login_duration":"00:17:11",
            "online_duration":"00:17:12",
            "busy_duration":"00:17:13",
            "train_duration":"00:17:14",
            "eat_duration":"00:17:15",
            "meet_duration":"00:17:16",
            "active_duration":"00:17:17",
            "rest_duration":"00:17:18",
            "serviceid":"083685e7a18549b9b3f07a97ea3675bc"
        }
    ],
    "ret_code":"000000",
    "ret_msg":"成功"
}

3、错误编码

3.1、操作成功

业务操作成功。

3.2、系统异常

系统服务异常。

3.3、业务异常

业务异常。