<small id="aimcq"></small>
  • # 在線統計

    # 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

    請求地址:

    http://www.gene-tech.cn/api/get_token

    請求參數:

    參數 類型 必填 名稱 備注
    appid String 接口憑證Id 第三方用戶接口調用唯一憑證id
    create_time String 時間戳 時間戳,秒,例如 2019-09-25 15:49:33 的時間戳1569397773
    sign String 簽名 md5(appid+create_time+app_key) sign簽名,app_key為秘鑰

    返回參數:

    參數 類型 必填 名稱
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 必填 名稱 備注
    token String token編碼
    expires_in String 憑證有效時間 單位:秒

    時間戳轉換參考工具:

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

    sign簽名生成示例:

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

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

    請求示例:

    curl http://www.gene-tech.cn/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.gene-tech.cn/api/wb/5/data/robot_session

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期(yyyy-MM-dd)
    end_date String 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    consult_session String 機器人咨詢會話
    valid_session String 機器人有效會話
    invalid_session String 機器人無效會話
    valid_reception_rate String 有效接待率
    self_reception_session String 機器人獨立接待會話
    self_reception_rate String 獨立接待率
    to_human_session String 轉人工會話
    to_human_session_rate String 轉人工會話率
    avg_session_duration String 平均會話時長

    請求示例:

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

    返回示例:

    {
        "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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/robot_satisfaction

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期(yyyy-MM-dd)
    end_date String 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    effect_session_count String 機器人有效會話總數
    total_times String 已評價總數
    comment_rate String 參評率
    solved String 已解決數
    not_solved String 未解決數
    resolution_rate String 已解決率

    請求示例:

    curl http://www.gene-tech.cn/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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/human_session

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期(yyyy-MM-dd)
    end_date String 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    consult_session String 人工咨詢會話
    self_reception_session String 人工獨立接待會話
    self_reception_session_rate String 人工獨立接待會話占比
    valid_session String 人工有效會話
    invalid_session String 人工無效會話
    valid_session_rate String 人工有效會話率
    valid_reception_session String 人工有效接待會話
    invalid_reception_session String 人工無效接待會話
    invalid_reception_rate String 人工無效接待率
    not_reception_session String 人工未接待會話
    not_reception_session_rate String 人工未接待會話率
    transfer_session String 轉接會話
    black_session String 拉黑會話
    avg_session_duration String 平均人工接待時長
    solved_session String 已解決會話
    not_solved_session String 未解決會話
    not_mark_is_solved String 未標注是否解決會話
    max_meantime_recption String 最大同時接待會話
    initiative_session String 主動發起會話量
    valid_reception_rate String 有效接待率
    transfer_in String 轉入會話
    transfer_out String 轉出會話

    請求示例:

    curl http://www.gene-tech.cn/api/wb/5/data/human_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: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%"
        },
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.5、人工滿意度統計

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取人工滿意度評價統計結果。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/human_satisfaction

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期(yyyy-MM-dd)
    end_date String 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    effect_session_count String 人工有效會話總數
    total_times String 已評價總數
    comment_rate String 參評率
    initiative String 客戶主動參評
    initiative_rate String 客戶主動參評占比
    invites_rate String 客服邀請參評占比
    invites String 客服邀請參評
    solved_count String 評價解決總數
    solved String 已解決數
    not_solved String 未解決數
    solved_rate String 已解決率
    avg_num String 平均分
    good String 好評數
    good_rate String 好評率
    middle String 中評數
    middle_rate String 中評率
    bad String 差評數
    bad_rate String 差評率
    score4 String 4分數
    score3 String 3分數
    score2 String 2分數
    score1 String 1分數

    請求示例:

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

    返回示例:

     {
        "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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/customer_session

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期(yyyy-MM-dd)
    end_date String 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    total_consult_session String 總咨詢會話
    total_valid_session String 總有效會話
    total_valid_session_rate String 總有效會話率
    avg_session_duration String 平均總會話接待時長
    avg_total_session_duration String 平均總會話時長
    total_invalid_session String 總無效會話

    請求示例:

    curl http://www.gene-tech.cn/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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/message_stats

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始時間 結束日期(yyyy-MM-dd)
    end_date String 結束時間 結束日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    total_message String 總會話消息數
    robot_message String 機器人消息數
    total_customer_message String 客戶消息數
    service_message String 客服消息數
    avg_message String 平均每會話消息數
    avg_customer_message String 平均每會話客戶消息數
    avg_service_messge String 平均每會話客服消息數
    customer_to_robot_message String 客戶消息數
    robot_avg_message String 平均每會話消息數
    robot_avg_customer_message String 平均每會話客戶消息數
    total_human_message String 總人工會話消息數
    customer_to_service_message String 客戶消息數
    answer_than String 答問比
    human_avg_message String 平均每會話消息數
    human_avg_customer_message String 平均每會話客戶消息數
    human_avg_service_message String 平均每會話客服消息數
    service_word String 客服字數
    avg_service_word String 平均每會話客服字數
    service_offline_num String 客服離線消息數

    請求示例:

    curl http://www.gene-tech.cn/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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/quality_result

    請求參數:

    參數 類型 必填 名稱 備注
    start_date String 開始日期 開始日期(yyyy-MM-dd)
    end_date String 結束日期 結束日期(yyyy-MM-dd)
    page String 當前頁碼
    size String 每頁條數(默認100,最大可傳入10000)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    chat_start_time String 會話開始時間(毫秒值)
    update_time String 質檢時間
    schemeid String 質檢方案id
    total_score String 質檢方案滿分
    standard_total_score String 質檢標準分滿分
    add_total_score String 質檢加分項滿分
    minus_total_score String 質檢減分項滿分
    quality_score String 質檢得分
    standard_quality_score String 質檢標準分得分
    add_quality_score String 質檢加分項得分
    minus_quality_score String 質檢減分項得分
    staffid String 客服id
    staff_name String 客服姓名
    email String 客服郵箱
    cid String 會話id

    請求示例:

    curl http://www.gene-tech.cn/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

    請求地址:

    http://www.gene-tech.cn/api/wb/5/data/export_data

    請求參數:

    參數 類型 必填 名稱 備注
    task_type String 任務類型 1:visit,2:conversation,3:evaluation,4:msg,5:user,6:ticket
    date String 日期 日期(yyyy-MM-dd)

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    item Object 返回對象

    item對象:

    參數 類型 名稱 備注
    companyid String 公司ID
    create_time String 創建時間
    task_type String 任務類型
    result_date String 日期
    file_path String 文件路徑
    description String 描述

    請求示例:

    curl http://www.gene-tech.cn/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

    請求地址:

    http://www.gene-tech.cn/chat-third/api/5/order/receive_order_data

    請求參數:

    參數 類型 必填 名稱 備注
    union_code String 平臺ID 不能大于32個字符
    companyid String 公司ID 不能大于32個字符
    order_number String 訂單編號 不能大于32個字符
    cus_partnerid String 下訂單客戶對接ID 不能大于32個字符
    order_time String 訂單時間 格式:2019-09-25 15:49:33
    order_money String 訂單金額 最大支持小數點后兩位

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息

    請求示例:

    {
        "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": "操作成功"
    }
    

    # 3、錯誤編碼

    # 3.1、操作成功

    業務操作成功。

    錯誤編碼 錯誤說明
    000000 操作成功(除此編碼以外的編碼為錯誤編碼)

    # 3.2、系統異常

    系統服務異常。

    錯誤編碼 錯誤說明
    910001 token為空
    910002 token已失效,請重新獲取
    910003 signature錯誤
    910004 沒有找到公司的api配置信息
    999999 系統未知異常

    # 3.3、業務異常

    業務異常。

    錯誤編碼 錯誤說明
    210003 傳入日期為空
    210004 傳入類型為空
    210005 日期傳入錯誤
    210016 請求參數類型錯誤(訂單編號不能為空/對接id不能為空/金額格式不正確等錯誤信息)
    210017 每分鐘調用次數達到限制(每分鐘可調用1000 次)
    大星彩票 <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <文本链> <文本链> <文本链> <文本链> <文本链> <文本链>