<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/chat/5/user/chat_connect

    請求參數:

    參數 類型 必填 名稱
    partnerid String 企業自己的用戶id,可自行傳值
    source String 客戶來源,0-pc,1-微信,2-sdk,3-微博,4-h5
    agentid String 指定客服的id
    tran_flag String 是否必須轉入指定客服,1-是,0-否
    groupid String 指定技能組
    params String(json) 自定義參數
    user_tels String 用戶電話
    user_emails String 用戶郵箱
    user_face String 用戶頭像
    user_name String 用戶真實姓名
    user_nick String 用戶昵稱
    user_img String 用戶頭像

    返回參數:

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

    item對象:

    參數 類型 名稱
    status String 狀態:-1.重復請求,拒絕處理,0.排隊,1.成功 2.無客服 3.在黑名單
    agent_name String 客服姓名
    agent_face String 客服頭像
    agentid String 客服id
    visitorid String 用戶id
    cid String 會話id
    count String 排隊位置

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/chat_connect 
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	 
        "partnerid" : "123",
        "source" : "0",
        "agentid " : "61673ee8d98d4282a95cdad38ffd5f5b ",
        "tran_flag" : "1",
        "params" : "{\"name\":\"lxl\",\"age\":18}",
        "user_tels" : "13778967890;13278907890",
        "user_emails" : "xiaoming@163.com; xiaoming2@163.com",
        "user_face":"https://sobot-www.oss-cn-beijing.aliyuncs.com/001915.JPG",
        "user_name" : "小明"
        }'
    

    返回示例:

    {
      "item": {
        "status": "1",
        "userid" :"fdd445a5b10f303297752dc3625db648",
        "agent_name" :"在線客服", 
        "agent_face":"https://sobot-www.oss-cn-beijing.aliyuncs.com/6112512332.PNG", 
        "agentid":"61673ee8d98d4282a95cdad38ffd5f5b", 
        "cid":"eca9155a77384d64bb64a132e8459b7e"
      },
      "ret_code": "000000",
      "ret_msg": "成功"
    }
    

    # 2.3、客戶咨詢客服

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口以用戶的身份給客服發送消息。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/chat_send

    請求參數:

    參數 類型 必填 名稱 備注
    partnerid String 企業自己的用戶id,可自行傳值
    content String 用戶問題
    msg_type String 消息類型 (text,image,voice,默認為text純文本,如果為image和voice的時候,content傳遞圖片地址或者音頻地址,其中音頻支持mp3,wav兩種格式)

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    status String 狀態:1.成功 2.用戶沒有跟客服建立連接

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/chat_send
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d ' {
        "partnerid": "123",
        "content": "https://bbs.sangfor.com.cn/data/attachment/sfchat/image/20687/1571984960.png",
        "msg_type": "image"
    } '
    

    返回示例:

    {
      "item": {
        "status": "1"
      },
      "ret_code": "000000",
      "ret_msg": "成功"
    }
    

    # 2.4、客服消息推送

    接口說明:

    接口類型:回調型接口

    接口作用:智齒將客服發送給用戶的消息推送至企業預先配置好的回調地址上。

    參數說明:

    參數 類型 名稱 備注
    sys_code String 系統編碼 2:在線業務
    type String 消息類型 chat_user_msg:用戶接收消息
    is_encrypt String 是否加密,true:加密false:不加密
    content Object 消息內容 詳見下表

    消息內容:

    參數 類型 名稱 備注
    msg_code String 消息編碼 200:客戶接入客服 201:客戶收到排隊位置變更 202:客戶收到客服發送的消息 204:客戶離線 209:客戶收到客服邀請評價的消息
    msg_id String 消息id
    msg_type String 消息類型 text:文本(包含html標簽)image:圖片
    msg String 消息內容
    agentid String 客服id
    agent_nick String 客服昵稱
    agent_face String 客服頭像
    partnerid String 客戶對接id
    params String 客戶對接自定義字段
    cid String 會話id

    請求方式:

    POST

    類型:

    1)用戶接入會話:

    {
        "sys_code":"2",
        "type":"chat_user_msg",
        "is_encrypt":"false",
        "content":{
            "agent_name":"在線客服LS186",
            "msgid":"d25f2bfe4f8f4573af5751f6ab61ea70",
            "agent_face":"https://sobot-test.oss-cn-beijing.aliyuncs.com/co2.PNG",
            "partnerid":"222",
            "msg_code":"200",
            "params":{
                "name":"xiaoming",
                "age":18
            }
        }
    }
    

    2)用戶收到排隊位置變更:

    {
        "sys_code":"2",
        "type":"chat_user_msg",
        "is_encrypt":"false",
        "content":{
            "msg_code":"201",
            "count":"3",
            "msgid":"5646d04350e84f689ca855153c58c0f9",
            "partnerid":"222",
            "params":"{'name':'xiaoming','age': 18}"
        }
    }
    

    3)用戶收到客服發送的消息:

    {
        "sys_code":"2",
        "type":"chat_user_msg",
        "isEncrypt":"false",
        "content":{
            "msg":"222",
            "agent_name":"在線客服LS186",
            "msgid":"ab48f1e755ac766d8732501a3ef1a1161573465172716",
            "msg_type":"text",
            "agent_face":"https://sobot-test.oss-cn-beijing.aliyuncs.com/co12332.PNG",
            "partnerid":"222",
            "msg_code":"202",
            "params":""
        }
    }
    

    4)客戶離線

    {
        "sys_code":"2",
        "type":"chat_user_msg",
        "is_encrypt":"false",
        "content":{
            "msg_code":"204",
            "msgid":"eda5990841fc4f42a8a1ea5ef731a0c6",
            "partnerid":"222",
            "params":""
        }
    }
    

    5)客戶收到客服邀請評價的消息

    {
        "sys_code":"2",
        "type":"chat_user_msg",
        "is_encrypt":"false",
        "content":{
            "agentid":"61673ee8d98d4282a95cdad38ffd5f5b",
            "msg_code":"209",
            "agent_name":"在線客服LS186",
            "msgid":"68bab5d926334703a8a8c790aa99dd03",
            "partnerid":"222",
            "params":{
                "name":"xiaoming",
                "age":18
            },
            "cid":"83766ca85b3a4159b05b00b82dc12197"
        }
    }
    

    # 2.5、客戶評價

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口執行用戶對會話進行滿意度評價。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/comment

    請求參數:

    參數 類型 必填 名稱 備注
    partnerid String 企業自己的用戶id,可自行傳值
    type String 評價類型:0:評價機器人,1:評價人工
    solved String 評價結果:0:未解決,1:已解決
    score String 人工評價分數(1,2,3,4,5)
    tag String 評價標簽,多個用逗號分隔
    remark String 評價內容
    comment_type String 評價類型:0-邀請評價,1-主動評價

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    status String 狀態:0.失敗,1.成功,2-已評價,3-無咨詢,不能評價
    cid String 會話ID

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/comment 
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{
        "partnerid" : "123", 
        "type" : "1", 
        "solved" : "1"
       }'
    

    返回示例:

    {
    "item": {
        "status":"1",
        "cid":" eca9155a77384d64bb64a132e8459b7e" 
        },
    "ret_code": "000000",
    "ret_msg": "成功"
    }
    

    # 2.6、客戶結束會話

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來結束某個用戶當前的會話。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/out

    請求參數:

    參數 類型 必填 名稱 備注
    partnerid 字符串 企業自己的用戶id,可自行傳值

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    status String 狀態:1.成功 整型

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/out
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
        "partnerid" : "123"
    }'
    

    返回示例:

    {
        "item": {
            "status":"1"
        },
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.7、查詢離線消息數據

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取會話已經結束后,客服發送給用戶的消息(即離線消息)。開放平臺接口對接的用戶,由于所有消息都會推送到消息地址中,沒有離線消息數據。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/offline_msg_data

    請求參數:

    參數 類型 必填 名稱 備注
    visitorid String 訪客id

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    size String 離線消息數
    msg_data List 客服列表及對應客服發送的消息列表

    msg_data對象:

    參數 類型 名稱 備注
    sender String 發送者id
    sender_name String 發送者昵稱
    send_face String 發送者頭像
    msg_list List 消息列表

    msg_list對象:

    參數 類型 名稱 備注
    cid String 會話id
    msg String 消息體
    ts String 發送消息時間

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/offline_msg_data
    -X POST 
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
    "visitorid" : "xx"
    }'
    

    返回示例:

    {
        "item": {
            "size": 2,
            "msg_data":[
            		 {
           		 "sender ": " 61673ee8d98d4282a95cdad38ffd5f5b",
            	 "sender_name": "在線客服",
      			 "sender_face":" https://sobot-www.oss-cn-beijing.aliyuncs.com/console/2512332.PNG",
           		 "msg_list": [
             			 {
                            "cid": "c36d04f18b4e48eaa88e7a5c93212a0a",
                            "msg": "111",
                            "ts": "2019-10-31 19:13:57"
                        },
                        {
                            "cid": "c36d04f18b4e48eaa88e7a5c93212a0a",
                            "msg": "222",
                            "ts": "2019-10-31 19:13:59"
                        }
           			 ]
         		 }
       		 ]
        },
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.8、查詢客戶會話列表

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取某個用戶在系統中的會話記錄列表(cid列表)。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/query_cids

    請求參數:

    參數 類型 必填 名稱 備注
    visitorid String 訪客id visitorid與partnerid選擇其一
    partnerid String 企業自己的用戶id,可自行傳值 與from參數配套使用
    from Integer 來源:0-開放平臺,1-pc/h5/sdk

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表

    items對象:

    參數 類型 名稱 備注
    cid String 會話ID
    start_date_time String 會話時間,毫秒
    visitorid String

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/query_cids
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
           "visitorid" : "xx"
    }'
    

    返回示例:

    {
        "items": [
            {
                "cid": "825a57e755a240559e03deec267e6463",
                "start_date_time": 1568603119126,
                "visitorid": "7f27b999bbe94274ab1a738568aba137"
            },
            {
                "cid": "1874cbc483b64d4b9f1b7f06de083638",
                "start_date_time": 1568613840540,
                "visitorid": "7f27b999bbe94274ab1a738568aba137"
            }    
    ],
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.9、查詢客戶會話記錄

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取某條會話的詳細會話記錄。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/get_detail_by_cid

    請求參數:

    參數 類型 必填 名稱 備注
    cid String 會話id
    partnerid String 企業自己的用戶id-供開放平臺用戶使用
    from Integer 來源:0-開放平臺,1-pc/h5/sdk
    visitorid String 智齒平臺用戶id-所有來源用戶都可使用
    name_flag Integer 客服名字類型:0.昵稱(默認) 1.真實姓名

    說明:1)cid,visitorid,partnerid+from為三種查詢模式,優先級為:cid&gt;visitorid&gt;partnerid+from;

    2)傳入visitorid或者partnerid+from時,表示查詢用戶的最后一次會話記錄。

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表

    items對象:

    參數 類型 名稱 備注
    sender_name String 發送者昵稱
    sender_type String 發送者類型 0-用戶,1-機器人,2-客服
    sender_face String 發送者頭像
    receiver_name String 接收者昵稱
    receiver_type String 接收者類型 0-用戶,1-機器人,2-客服
    receiver_face String 接收者頭像
    ts String 發送時間 格式:yyyy-MM-dd HH:mm:ss
    t String 發送時間 格式:毫秒級時間戳
    msg String 會話消息
    msg_type Integer 消息類型:0-文本,1-圖片,2-音頻,3-富文本
    cid String 會話ID

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/get_detail_by_cid
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
        "cid" : "49142902cfa74f2d9af8e7c1b546221d",
        "name_flag" : "1"
        }'
    

    返回示例:

     {
        "items": [{
                "cid": "49142902cfa74f2d9af8e7c1b546221d",
                "msg":"<img src='http://bbs.sangfor.com.cn/data/attachment/sfchat/image/201910/154687/1571984960.png' class='webchat_img_upload upNowImg uploadedFile' />",
                "msg_type": 1,
                "msgid": "ab221eb4fbde4ea0b9fa728448470503",
                "receiver": "61673ee8d98d4282a95cdad38ffd5f5b",
                "receiver_name": "在線客服",
                "receiver_type": 2,
                "sender": "fdd445a5b10f303297752dc3625db648",
                    "sender_face": "https://sobot-www.oss-cn-beijing.aliyuncs.com/console/7e20834c439748c780ca9648ca6c0cde/userImage/2016120715001915.JPG",
                "sender_name": "小明",
                "sender_type": 0,
                "t": "1572514382820",
                "ts": "2019-10-31 17:33:02"            
            }],
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.10、查詢客服上下班時間

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取某個在線客服組當前是否處于系統設置的上班時間或下 班時間。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/admin_is_work

    請求參數:

    參數 類型 必填 名稱 備注
    groupid String 技能組id

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    is_work String 上下班狀態:true-上班;false-下班

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/admin_is_work
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
        "groupid" : "1d89fad9e31d4498b1196f7580666e52"
        }'
    

    返回示例:

    {
        "item": {
            "is_work": "true"
    
        },
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.11、查詢客服實時數據

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取當前登錄的在線客服的列表以及狀態等信息。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/get_once_data

    請求參數:無

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    admin_list List 在線客服列表,詳見下文
    admin_size String 在線客服數量
    online_user_size String 在線用戶數量
    wait_user_size String 排隊用戶數量
    robot_user_size String 與機器人會話數量

    admin_list對象:

    參數 類型 名稱 備注
    agentid String 客服id
    group_name List 客服所在技能組名稱列表
    groupid List 客服所在技能組id列表
    count String 客服實時接待用戶數量
    agent_email String 客服郵箱
    status String 客服狀態(1-在線,2-忙碌)
    status_code Integer 自定義狀態:3.小休 4.培訓 5.會議 6.用餐 7.活動
    agent_name String 客服姓名
    agent_face String 客服頭像
    remark String 客服備注
    agent_nick String 客服昵稱
    max_count String 客服最大接待量
    status_time String 狀態持續時長 格式:hh:mm:ss

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/get_once_data
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    

    返回示例:

    {
        "item": {
            "wait_user_size": 0,
            "admin_size": 1,
            "online_user_size": 0,
            "robot_user_size": 0,
            "admin_list": [
                {
                    "agentid": "61673ee8d98d4282a95cdad38ffd5f5b",
                    "status_code": 0,
                    "agent_name": "真是改了名字了",
                    "agent_email": "123456@123.com",
                    "group_name": [
                        "銷售",
                        "售后",
                        "售前"
                    ],
                    "groupid": [
                        "c4a3a9b8bc5742079d57d154ef2e2cc2",
                        "ef06c796d2b64218afc511dab1cd1283",
                        "a457f4dfe92842f8a11d1616c1c58dc1"
                    ],
                    "count": 0,
                    "agent_face": "https://sobot-www.oss-cn-beijing.aliyuncs.com/console/7e2512332.PNG",
                    "remark": "hello",
                    "max_count": 10,
                    "service_no": "1",
                    "status_time": "06:53:56",
                    "agent_nick": "在線客服",
                    "status": 1
                }
            ]
        },
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.12、查詢在線技能組列表

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來查詢當前系統下所有在線客服技能組的詳情。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/query_group

    請求參數:無

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表

    items對象:

    參數 類型 名稱 備注
    groupid String 技能組id
    group_name String 技能組名稱
    create_time String 創建時間(秒級時間戳)

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/query_group
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    

    返回示例:

     {
        "items": [{
            "groupid" : "c4a3a9b8bc5742079d57d154ef2e2cc2",
            "group_name" : "售前",
            "create_time" : "1540176885"
        }],
        "ret_code": "000000",
        "ret_msg": "成功"
    }
    

    # 2.13、查詢在線客服列表

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來查詢當前系統下所有在線客服的詳情。

    請求方式:

    POST

    請求地址:

    http://www.gene-tech.cn/api/chat/5/user/query_agent

    請求參數:無

    返回參數:

    參數 類型 必填 名稱 備注
    ret_code String 返回編碼
    ret_msg String 返回信息
    items List 對象列表

    items對象:

    參數 類型 名稱 備注
    agentid String 客服id
    group_name List 客服所在技能組名稱列表
    groupid List 客服所在技能組id列表
    agent_email String 客服郵箱
    agent_name String 客服姓名
    role_name String 角色
    agent_no String 客服工號
    agent_status String 客服狀態
    create_time String 創建時間(yyyy-MM-dd)
    department_name String 部門名稱

    請求示例:

    curl http://www.gene-tech.cn/api/chat/5/user/query_agent
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    

    返回示例:

    {
        "agent_email": "123456@123.com",
        "agent_name": "在線客服",
        "agent_no": "1",
        "agent_status": "啟用",
        "agentid": "61673ee8d98d4282a95cdad38ffd5f5b",
        "create_time": "2016-04-19",
        "department_name": "總公司",
        "group_name":  [
                "銷售",
                "售后",
                "售前"
            ],
        "groupid": [
            "c4a3a9b8bc5742079d57d154ef2e2cc2",
            "ef06c796d2b64218afc511dab1cd1283",
            "a457f4dfe92842f8a11d1616c1c58dc1"
        ],
        "role_name": "超級管理員"
    }
    

    # 2.14、查詢服務總結記錄

    接口說明:

    接口類型:主動調用接口

    接口作用:可通過調用該接口來獲取服務總結記錄。

    請求方式:

    POST

    請求地址:

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

    請求參數:

    參數 類型 必填 名稱 備注
    cid 字符串 會話id cid

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    summary_flag String 總結狀態,1-已總結,0-未總結
    update_time String 總結時間
    operation_name String 業務單元
    req_type_name String 業務類型
    question_status String 解決狀態,1-已解決,0-未解決
    question_description String 備注說明
    invalid_session String 無效會話,1-無效,0-有效
    fields List 自定義字段列表
    summary_staff_name String 總結客服
    cid String 會話id

    fields對象:

    參數 類型 名稱 備注
    fieldid String 字段id
    field_name String 字段名稱
    field_value String 字段值

    請求示例:

    curl http://www.gene-tech.cn/api/wb/5/data/query_summary
    -X POST 
    -H 'content-type:application/json'
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '{	  
    "cid": "xx"
    }'
    

    返回示例:

    {
        "item": {
                "cid": "3cd40201989943df8cd1ed845efcb043",
                "summary_flag": "1",
                "operation_name": "業務單元",
                "req_type_name": "業務類型1,業務類型2",
                "summary_staff_name": "客服1",
                "question_status": "1",
                "question_description": "問題描述",
                "fields": [
                {
                "fieldid": "28f002c873c344d9a8f9b3606830dfbb",
                "field_name": "業務單元字段1",
                "field_value": "值1"
                },
                {
                "fieldid": "9b9086c5bed84016af5adf273d41110e",
                "field_name": "業務單元字段2",
                "field_value": "值2"
                }
                ],
                "invalid_session": "0",
                "update_time": "1554716281854"
            },
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    

    # 2.15、單點登錄接口

    接口說明:

    接口類型:主動調用接口。

    接口作用:可通過調用該接口來獲取一個臨時的URL,通過訪問該URL即可直接進入某賬號的智齒客服后臺,從而實現單點登錄的業務。

    請求方式:

    POST

    請求地址:

    https(http)://www.gene-tech.cn/api/oss/5/direct_url
    

    注:使用https請求返回的登錄鏈接是https協議的,使用http請求,返回的登錄鏈接就是http協議的

    請求參數:

    參數 類型 必填 名稱 備注
    agent_email String 客服郵箱
    type String 登錄頁面,1:舊版工作臺,2:新版工作臺 如果不傳,返回的頁面鏈接是智齒管理后臺頁面

    返回參數:

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

    item對象:

    參數 類型 名稱 備注
    url String 跳轉地址

    請求示例:

    curl http://www.gene-tech.cn/api/agent/5/direct_url 
    -X POST 
    -H 'content-type: application/json' 
    -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
    -d '
    {
        "agent_email": "xiaoming@sobot.com",
        "type": "1"
    }'
    

    返回示例:

    {
    	"item": {
    		"url": "http://www.gene-tech.cn/console/openAPI/login/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIxODUwMDM5NTY2OEAxNjMuY29tIiwiZXhwIjoxNTczMjcxMTc2fQ.__nZg_aekTGUwz7qoz_Cw7bIF9sQ66ughijr1FLsX9c"
    	},
      	"ret_code": "000000",
    	"ret_msg": "操作成功"
    }
    

    # 3、在線消息轉發

    該功能消息格式為json格式;實時消息推送配置將在次日凌晨零點開始生效。

    實時消息推送需要客戶提供數據接收接口,例如 https://xxxxxxx.xxxxxx.com/sobot/message,所有的類型的數據使用相同的地址。

    消息轉發接口,增加可以加密后再傳遞,可以聯系您的客戶經理,設置開通后,可以在消息轉發時header中增加三個參數:時間戳(取服務器時間)、隨機碼、sign(MD5加密,32位 小寫));客戶取到參數后解碼對比,正確接收數據,錯誤時返回錯誤碼。

    header中參數

    參數 類型 備注
    X-Log-TimeStamp String 時間戳(取服務器時間,毫秒)
    X-Log-RandomCode String 隨機碼)
    X-Log-Sign String sign簽名,對companyId,時間戳(取服務器時間),隨機碼 ,appKey(配置消息轉發時使用的密鑰)按照順序進行字符串拼接,使用MD5摘要算法(32位小寫)所得值

    請求示例

    curl https://xxxxxxx.xxxxxx.com/sobot/message
    -X POST 
    -H 'X-Log-TimeStamp:1592216019'
    -H 'X-Log-RandomCode:111222333'
    -H 'X-Log-Sign:258eec3118705112b2c53dc8043d4d34'
    

    # 3.1在線會話消息

    # 3.1.1 content對象

    參數 類型 必填 名稱 備注
    companyid String 公司Id 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況
    cid String 會話id
    source String 用戶來源 0 pc;1 微信;2 sdk;3 微博;4 移動網站;9 企業微信;10 微信小程序
    start_time String 開始時間 unixtime ms,例如:"1539153409792"
    partnerid String 合作方用戶id
    end_time String 結束時間 unixtime ms,例如:"1539153409792"
    first_response_time String 首次響應時間 unixtime ms,例如:"1539153409792"
    transfer_tohuman_time String 機器人轉人工時間 unixtime ms,例如:"1539153409792"
    conversation_duration String 會話時長 單位:毫秒
    staff_email String 最后接待客服Email
    staff_name String 最后接待客服姓名
    consult_robot_msg_count String 咨詢機器人消息數
    robot_reply_msg_count String 機器人回復數
    consult_staff_msg_count String 咨詢人工消息數
    staff_reply_msg_count String 人工回復數
    transfer_human_succ_flag String 轉人工是否成功 1-是;0-否
    queue_time String 排隊時長 單位:毫秒
    session_queue_state String 排隊狀態 1-未排隊接通;2-排隊成功;3-排隊離開
    ip String 訪問IP 格式: "255.255.255.255"
    area String 地域
    os String 終端 1 Windows XP;2 Windows 7;3 Windows 8;4 Windows Vista;5 Windows 其他;6 Linux;7 macOS;8 Android;9 iOS;11 Windows 2000;12 Windows 10 ;其他 其他
    visitorid String 用戶ID
    partnerid String 合作方用戶ID
    lastgroupid String 最后接待客戶組Id
    lastgroup_name String 最后接待客戶組名稱
    offline_type String 會話結束方式 1 客服離線,2 客戶被客服移除 3 客戶被客服加入黑名單 4 客戶會話超時 5 客戶關閉了聊天頁面 6 客戶打開新的頁面
    human_valid_flag String 是否是人工有效會話 1 是 0否
    human_invalid_flag String 是否是人工無效會話 1 是 0否
    human_invalid_recep_flag String 是否是人工無效接待 1 是 0否
    human_valid_recep_flag String 是否是人工有效接待 1 是 0否
    human_recep_flag String 是否是人工接待 1 是 0否
    robot_invalid_flag String 是否是機器人無效會話 1 是 0否
    robot_valid_flag String 是否是機器人有效會話 1 是 0否
    province_name String 省份名稱
    city_name String 城市名稱
    access_human_time String 接入人工時間
    robotid String 機器人id
    robot_alias String 機器人別名 機器人的對接參數,優先級高于robotid,目前僅支持APP渠道
    robot_name String 機器人昵稱
    staffids String 所有接待客服Id,以逗號分割;
    invite_evaluation_flags String 客服是否發起邀評,對應接待客服Id的順序 ,1 發起過邀評,0 未發起邀評
    response_duration String 總響應時長 毫秒
    response_count String 總響應次數
    response_avg String 平均響應時長=總響應時長/總響應次數
    session_human_duration String 人工接待時長
    asHuman_interactive_count String 人工交互會話數
    channel_flag String 子渠道Id
    channel_name String 子渠道名稱

    注:唯一主鍵 cid,各表通過cid關聯,表示同一個會話

    # 3.1.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 conversation
    content List 消息內容

    # 3.1.3 請求報文樣例

    { 
      "sys_code":"21",
        "type":"conversation",
        "content":[
            {
                "companyid":"5cc2c708202d4defaf72d4bcac362a55",
                "cid":"86937e82ae244ad59aeefe41af731079",
                "source":"2",
                "start_time":"1468826506677",
                "partnerid":"1907281202433341",
                "end_time":"1468827002400",
                "first_response_time":"1468827002400",
                "transfer_tohuman_time":"1468826506677",
                "conversation_duration":"495723",
                "staff_emails":"11122221@foxmail.com",
                "staff_name":"路人丁",
                "consult_robot_msg_count":"3",
                "robot_reply_msg_count":"20",
                "consult_staff_msg_count":"0",
                "staff_reply_msg_count":"0",
                "transfer_human_succ_flag":"1",
                "queue_time":"0",
                "session_queue_state":"2",
                "ip":"60.18.150.38",
                "area":"遼寧",
                "os":"8",
                "visitorid":"837213545777846",
                "lastgroupid":"35980200f279438b952f8dc3d5731f85",
                "lastgroup_name":"客服組",
                "human_valid_flag":"1",
                "human_invalid_flag":"0",
                "human_invalid_recep_flag":"0",
                "human_valid_recep_flag":"0",
                "human_recep_flag":"1",
                "robot_invalid_flag":"0",
                "robot_valid_flag":"1",
                "offline_type":"1",
                "access_human_time":"1584806400000",
                "robotid": "1234",
                "robot_alias": "test_alias",
                "robot_name": "機器人小明",
                "staffids":"3695089d031c409380073081aaa73c7d,733e9edabb5c4158b095198aec58a890,3ff11cb243b540f78f8274f84b289920",
                "invite_evaluation_flags":"0,1,1",
                "channel_flag": "d720fe0e97ac427183c65b59f82c061f",
                "channel_name": "Android - 正式",
                "response_duration": "0",
                "response_count": "0",
                "response_avg": "0",
                "session_human_duration": "0",
                "asHuman_interactive_count": "0"
            }
        ]
    }
    

    # 3.2在線評價消息

    # 3.2.1 content對象

    參數 類型 必填 名稱 備注
    companyid String 公司ID 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況
    staffid String 客服ID
    source String 用戶來源 0-pc;1-微信;2-sdk;3-微博;4-移動網站;9-企業微信;10-微信小程序
    admin_name String 評價對象 可能是客服或機器人
    is_robot String 是否是機器人 1-是機器人,0-是人工客服
    remark String 備注信息
    tag String 評價標簽
    score String 評分 最高5分,均為正整數
    visitorid String 訪客ID
    date_time String 時間 unixtime ms,例如 1539153409792
    cid String 會話ID 會話的唯一標識
    comment_type String 評價類型 0-邀請評價,1-主動評價
    solved String 標記是否解決 1-解決,0-未解決,-1 未開啟

    注:唯一主鍵(cid+is_robot)

    # 3.2.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 evaluation
    content List 消息內容

    # 3.2.3 請求報文樣例

    {
        "sys_code":"21",
        "type":"evaluation",
        "content":[
            {
                "companyid":"5cc2c708202d4defaf72d4bcac362a55",
                "staffid":"9517",
                "source":"10",
                "admin_name":"",
                "is_robot":"1",
                "remark":"意向用戶可跟",
                "tag":"答非所問,問題不能回答",
                "score":"2",
                "visitorid":"97b31cba87e04dcdafe0ebb60248ecf4",
                "date_time":"1468340203266",
                "cid":"9ae05bc279544b68895cd86b12e418e0",
                "comment_type":"1",
                "solved":"1"
            }
        ]
    }
    

    # 3.3在線用戶信息

    # 3.3.1content對象

    參數 類型 必填 名稱 備注
    companyid String 公司ID 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況。
    userid String 用戶ID
    cid String 會話ID
    user_tels String 聯系電話 客戶電話,如多個號碼采用英文逗號","隔開
    user_emails String 電子郵箱 客戶郵箱,如多個郵箱采用英文逗號","隔開
    qq String QQ號碼
    partnerid String 合作方用戶ID
    user_name String 用戶姓名
    remark String 備注信息
    service_no String 客服工號
    params String 動態參數 jsonString,對接時由客戶傳過來
    summary_params String 服務總結相關參數 jsonString,對接由客戶傳過來

    注:唯一主鍵 userid

    # 3.3.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 user
    content List 消息內容

    # 3.3.3 請求報文樣例

    {
        "type":"user",
        "sys_code":"21",
        "content":[
            {
                "companyid":"5cc2c708202d4defaf72d4bcac362a55",
                "userid":"837213545777846",
                "cid":"86937e82ae244ad59aeefe41af731079",
                "user_tels":"13545777846",
                "user_emails":"506003007@qq.com",
                "qq":"784383358",
                "partnerid":"13545777846",
                "user_name":"孫盼",
                "remark":"",
                "params":{
                    "KUID":"MTU2NjY0MzE1NTAwMDA3MTAz",
                    "cookie":"88a484e052f1455a8706213cd41c4c94"
                },
                "service_no":"1011"
            }
        ]
    }
    

    # 3.4在線訪客信息

    # 3.4.1content對象

    參數 類型 必填 名稱 備注
    companyid String 公司ID 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況
    userid String 用戶ID
    img String 用戶頭像
    nick String 用戶昵稱 用戶昵稱
    source String 用戶來源 0 pc;1 微信;2 sdk;3 微博;4 移動網站;9 企業微信;10 微信小程序
    enterprise_name String 公司名稱 默認值為空字符串
    user_tels String 用戶聯系電話 默認值為空字符串
    user_emails String 用戶郵箱 默認值為空字符串,此參數可能會采用英文逗號","隔開
    user_name String 用戶真實姓名 默認值為空字符串
    qq String 用戶QQ 默認值為空字符串
    province_name String 省份
    city_name String 市名稱 默認值為空字符串
    area_name String 縣/區名稱 默認值為空字符串
    remark String 備注 默認值為空字符串
    visitorids String 訪客ID 默認值為空字符串
    service_no String 客服工號 默認值為空字符串
    serviceid String 客服ID
    cid String 會話ID
    result_list List 自定義字段

    # 3.4.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 userinfo
    content List 消息內容

    # 3.4.3 請求報文樣例

    {
        "sys_code":"21",
        "type":"userinfo",
        "content":[
            {
                "companyid":"5cc2c708202d4defaf72d4bcac362a55",
                "userid":"837213545777846",
                "img":"https://img.sobot.com/console/common/face/user.png",
                "nick":"招商王",
                "source":"10",
                "enterprise_name":"",
                "user_tels":"13545777846",
                "user_emails":"13545777846@foxmail.com",
                "user_name":"孫盼",
                "province_name":"山東",
                "city_name":"",
                "area_name":"",
                "remark":"意向用戶可跟",
                "visitorids":"",
                "service_no":"1011",
                "serviceid":"ea6f8d1a5e8846fd8dfce4ab7057c45c",
                "cid":"bcfb6853edc446c0a4305692b9daf6c8",
                "result_list":[
    
                ]
            }
        ]
    }
    

    # 3.5在線聊天消息

    # 3.5.1content對象

    參數 類型 必填 名稱 備注
    companyid String 公司ID 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況
    cid String 會話ID
    format_time String 時間 格式:yyyy-MM-dd HH:mm:ss
    timems String 時間戳 unixtime ms,例如:1539153409792
    senderid String 發送人ID 為訪客ID或客服ID或機器人ID
    sender_name String 發送人
    receiverid String 接收人ID 為訪客ID或客服ID或機器人ID
    receiver_name String 接收人
    msg String 聊天內容
    docid string 問題id 知識庫問題的id 只有sender_type=1的消息有
    doc_name string 詞條名稱 知識庫問題的詞條名稱 只有sender_type=1的消息有
    sender_type String 發送方類型 0-訪客,1-機器人,2-人工客服
    receiver_type String 接收方類型 0-訪客,1-機器人,2-人工客服,3-無接收方(表示該消息為留言轉離線消息)
    msg_offline String 是否是離線消息 1-是,0-否

    注: 唯一主鍵cid+ timems +senderid,機器人和人工可分別評價。

    # 3.5.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 msg
    content List 消息內容

    # 3.5.3 請求報文樣例

    {
        "sys_code":"21",
        "type":"msg",
        "content":[
            {
                "companyid":"5cc2c708202sasad2f72d4bcac362a55",
                "cid":"44c603626e2e4c82a5a49619a8aaa397",
                "format_time":"2017-11-01 12:24:04",
                "timems":"1509510244000",
                "senderid":"33c603626e434c82a5a49619aadde451",
                "sender_name":"馮建武",
                "receiverid":"25e603626e434c82a5a49619aaqw345",
                "receiver_name":"胡麗靜",
                "msg":"到還款日,延期3天怎么算",
                "docid":"88c5342f51134db58ea59f430ad16939",
                "doc_name":"來張圖片",
                "sender_type":"0",
                "receiver_type":"2",
                "msg_offline":"0"
            }
        ]
    }
    

    # 3.6在線服務總結

    # 3.6.1content 對象

    參數 類型 必填 名稱 備注
    companyid String 企業ID 適用一個公司多個超管帳號或者多個分公司需要分別統計的情況
    cid String 會話ID
    visitorid String 訪客ID
    operationid String 業務單元ID
    operation_name String 業務單元名稱
    req_type String 業務類型ID列表 以-隔開
    req_type_name String 業務類型名稱列表 以-隔開
    summary_status String 處理狀態 1-已解決,0-未解決,-1-未勾選
    summary_description String 備注
    update_time String 更新時間 例如:"1577785628084"
    update_staffId String 更新人ID
    invalid_flag String 服務總結狀態 1 無效會話,0 有效會話
    update_staff_name String 編輯服務總結內容客服名稱
    groupid String 技能組ID
    group_name String 技能組名稱
    fieldid List&lt;String&gt; 自定義字段id列表
    field_name List&lt;String&gt; 自定義字段名稱
    field_value List&lt;String&gt; 自定義字段值
    start_time String 會話建立時間

    # 3.6.2 請求參數

    參數 類型 必填 名稱 備注
    sys_code String 產品編碼 21
    type String 消息類型 summary
    content List 消息內容

    # 3.6.3 請求報文樣例

    {
        "sys_code":"21",
        "type":"summary",
        "content":[
            {
                "chat_start_time":"1577779079941",
                "group_name":"test",
                "groupid":"ab900e0cea3f4247981631a7bdb0c694",
                "summary_status":"1",
                "field_name":[
                    "字段1",
                    "字段2"
                ],
                "operation_name":"",
                "update_staff_name":"毛怪",
                "companyid":"7f72b9c5dee8425fba152a216e528cd4",
                "update_time":"1577779099437",
                "invalid_flag":"0",
                "operationid":"1577330071201",
                "field_value":[
                    "qweqeqw",
                    "eqweqwe"
                ],
                "req_type_name":"手機-電腦",
                "req_type":"1577330173970-1577330182339",
                "update_staffId":"132dd5ef52b44dc3931f181980c61276",
                "cid":"dfdc8f4dfaab44bbb463a5f8960a4cc7",
                "visitorid":"d7a05991e58c35f1dede477a04205f92",
                "summary_description":"qeqe",
                "fieldid":[
                    "3fc247578a294a3297a7418d521974fd",
                    "39303cc831c641ad93a5f0757cce69d7"
                ]
            }
        ]
    }
    

    # 4、錯誤編碼

    # 4.1、操作成功

    業務操作成功。

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

    # 4.2、系統異常

    系統服務異常。

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

    # 4.3、業務異常

    業務異常。

    錯誤編碼 錯誤說明
    200001 partnerid未傳入
    200002 公司信息不存在
    200003 訪客信息不存在
    200004 參數不能為空
    200005 詞條id或詞條名稱未傳入
    200006 訪客已離線,無法評價
    200007 該消息已被評價,無法評價
    200008 消息內容未傳入
    200009 評價類型未傳入
    200010 評價結果未傳入
    200011 會話id未傳入
    200012 消息id未傳入
    200013 評價狀態未傳入
    200014 機器人信息未傳入
    210001 該郵箱未注冊
    210002 郵箱不能為空
    大星彩票 <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <蜘蛛词>| <文本链> <文本链> <文本链> <文本链> <文本链> <文本链>