智齿客服SDK对接集成文档V2.2.2（接口说明）

一、初始化接口：sobotInit

初始化一些必要的参数，本接口成功调用一次即可。

sobotInit(Information info, StringResultCallBack<ZhiChiInitModel> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "uid": "6ea1efaad73246d2bd778e65c9a69358867993024100230",
        "robotLogo": "https://img.sobot.com/console/common/face/robot.png",
        "adminHelloWord": "您好，请问有什么可以帮您的？ ",
        "manualCommentTitle": "服务态度差,回答不及时,没解决问题,不礼貌",
        "msgTmp": "您好，为了解决您的问题, ",
        "type": 2,
        "isblack": 0,
        "robotUnknownWord": "非常对不起，不知道怎么回答这个问题呢，我会努力学习的。\n",
        "groupflag": 0,
        "guideFlag": 0,
        "msgTxt": "您好，很抱歉我们暂时无法为您提供服务，如需帮助，请留言\n",
        "onORoff": 3,
        "msgFlag": 0,
        "adminTipTime": 1,
        "adminNonelineTitle": "抱歉，暂无人工客服在线",
        "userOutWord": "由于很久没有收到您的消息，系统自动18513666499结束了本次会话。",
        "userTipTime": 3,
        "userTipWord": "您在思考人生？有问题请随时提问哦111111~\n",
        "robotHelloWord": "您好，很高兴为您服务，请问有什么可以帮您的？ \n",
        "inputTime": 2,
        "ustatus": 0,
        "adminTipWord": "抱歉让您久等，客服妹子已经忙翻了，请稍候。\n",
        "companyName": "zhichi",
        "cid": "341c9caf6bfe43419b7a5cde363c3514",
        "robotName": "zhichi机器人",
        "companyStatus": 0,
        "userOutTime": 3,
        "color": "#09aeb0",
        "companyId": "6ea1********46d2bd778e********58",
        "robotCommentTitle": "答非所问,理解能力差,问题不能回答,不礼貌"
        "uname": "北京用户",
        "face": "",
    },
    "msg": null
}

响应示例说明：

二、查询cid接口：queryCids

本接口调用后可以查询到用户的cid列表，获取cid列表后，可以使用cid调用getChatDetailByCid接口进行历史纪录的查询。

queryCids(String uid,long time, StringResultCallBack<ZhiChiCidsModelResult> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "cids": [
            "d7e416f161af49afb856236db88e1fe1",
            "73c4a12d89fc4f13b89cd02e0583e22f",
            "0bf1f68262a54bd294a18f04762f057d",
        ]
    },
    "msg": null
}

响应示例说明：

三、获取聊天记录接口：getChatDetailByCid

sdk中所有聊天纪录都是以cid为单位查询得出，如果想获取用户的聊天记录，那么首先需要调用queryCids接口获取cid列表后，再使用cid进行聊天记录的查询。

getChatDetailByCid(String uid, String cid,

StringResultCallBack<ZhiChiHistoryMessage> resultCallBack);

请求参数说明：

响应示例：

{
"code": 1,
"data": [
                  {
               "date": "2017-03-01",
               "content": [
                              {
                                     "cid": "846ac1054e5c46cca9887f88e862d6a2",
                                     "action": 5,
                                     "type": 5,
                                     "sender": "9e74cbf3b9564ccca28511d45a5abdbe",
                                     "senderName": "jin",
                                     "senderType": 2,
                                     "senderFace": "https://img.sobot.com/cae967f.jpg",
                                     "t": "1488362243542",
                                     "ts": "2017-03-01 17:57:23",
                                     "msgType": 0,
                                     "msg": "111",
                                     "sdkMsg": {
                                                                 "sugguestions": null,
                                                                 "answerType": null,
                                                                 "stripe": null,
                                                                 "question": "",
                                                                 "answer": {
                                                                                            "msgType": 0,
                                                                                            "msg": "111",
                                                                                            "duration": null,
                                                                                            "richpricurl": null,
                                                                                            "richmoreurl": null
                                                                                    }
                                                           },
                                     "receiver": "6ea1efaad73024100230",
                                     "receiverName": "北京用户",
                                     "receiverType": 0,
                                     "offlineType": null,
                                     "msgId": "da28dc32981049ba8870204d3cae7b1c",
                                     "receiverFace": ""
                                     }, 
                          ]
              }
],
"msg": null
}

响应示例说明：

四、机器人问答接口：chatSendMsgToRoot

使用本接口可以与机器人进行问答咨询，sdk中所有与机器人的聊天信息都会调用此接口。

chatSendMsgToRoot(String uid, String cid,String robotFlag,String requestText, int lanFlag, int questionFlag,String question, StringResultCallBack<ZhiChiMessage> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "ustatus": -1,
        "answer": {
            "msgType": 4,
            "msg": null,
            "duration": null,
            "richpricurl": null,
            "richmoreurl": null
        },
        "answerType": "4",
        "stripe": "您问的是否是以下问题,点击或回复序号即可得到对应问题的答案：",
        "suggestionList": [
            {
                "question": "富文本",
                "docId": "27e52a49451a4e87985ae45c354fe2d9",
                "answer": "<p>富文本富文本富"
            },
            {
                "question": "富文本 两张图片富文本 两张图片富文本 两张图片富文本 两张图片",
                "docId": "0b2a12079b8e4347872d5547e59a5cac",
                "answer": "<p>富文本富文"
            }
        ],
        "question": null,
        "time": null
    },
"msg": null
}

响应示例说明：

五、转人工接口：connnect

sdk中调用初始化后默认为机器人问答状态，如果想连接客服进行人工问答，那么可以调用此接口，本接口成功调用一次即可。

connnect(String uid, String cid, String chooseAdminId,int tranFlag, String groupId,String groupName, boolean currentFlag, StringResultCallBack <ZhiChiMessage> esultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "count": 1,
        "aface": "https://img.sobot.com/chatr*****350b0.jpg",
        "status": 1,
        "wslink.default": "**.2**.**1.**4:6***",
        "aid": "1b6d********4db99c3c******bd3332",
        "aname": "sobotsnbgghh",
        "wslink.bak": [
            "5*.2**.2**.1**:***5"
        ],
    },
    "msg": null
}

响应示例说明：

六、与客服聊天接口：sendMsgToCoutom

在调用转人工接口成功后，与人工的问答消息都需要调用此接口，sdk中所有与人工的会话都会使用此接口。

sendMsgToCoutom(String content, String uid, String cid，StringResultCallBack

<CommonModelBase> resultCallBack);;

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    }
"msg": null
}

响应示例说明：

七、用户给客服发送文件接口：sendFile

在调用转人工接口成功后，发送语音、图片等文件需要调用此接口。

sendFile(String cid, String uid, String filePath, String duration, ResultCallBack<ZhiChiMessage> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1,
        "url": "https://img.sobot.com/chatres/e6fb177060b91b2db544.wav"
    },
    "msg": null
}

响应示例说明：

八、满意度评价接口：comment

用户对机器人或者人工进行评价的接口，系统默认一次会话只能评价一次机器人和人工，评价后信息会计入统计列表。

comment(String cid, String uid, String type, String source, String problem, String suggest, int isresolve, int commentType, StringResultCallBack <CommonModel> ResultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    },
    "msg": null
}

响应示例说明：

九、获取技能组接口：getGroupList

调用转人工接口时，如果用户打开技能组开关，并且设置了技能组，那么可以调用此接口来获取技能组。

getGroupList(String appId,String uid, StringResultCallBack<ZhiChiGroup> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": [
        {
            "groupId": "c30ea56d46994b1093dc20ad65785d2a",
            "channelType": "5",
            "groupName": "aaa",
            "companyId": "6ea1efaad73246d2bd778e65c9a69358",
            "recGroupName": "aaa",
            "appId": "13f7545fa0834debbe3f488daf5c5b0a",
            "isOnline": true
        },
        {
            "groupId": "ff0333886e76470db66bee3f2519063b",
            "channelType": "5",
            "groupName": "343434",
            "companyId": "6ea1efaad73246d2bd778e65c9a69358",
            "recGroupName": "343434",
            "appId": "13f7545fa0834debbe3f488daf5c5b0a",
            "isOnline": true
        }
    ],
    "msg": {
        "ustatus": 1
    }
}

响应示例说明：

十、正在输入接口：input

调用转人工接口成功后，可以使用此接口来捕捉用户正在输入的消息。

input(String uid,String content, StringResultCallBack<CommonModel> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    },
    "msg": null
}

响应示例说明：

十一、留言接口：postMsg

当用户需要进行留言时，可使用此接口进行留言提交，留言提交后会自动生成工单。

postMsg(String uid, String ticketContent, String customerEmail, String customerPhone, String companyId, String customerNick, String fileStr, StringResultCallBack<CommonModel> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    },
    "msg": null
}

响应示例说明：

十二、删除聊天记录：deleteHisMsg

调用此接口后，sdk端将不再显示之前的聊天记录，但是客服工作台依旧可以查看到之前的聊天记录。

deleteHisMsg(String uid, StringResultCallBack<CommonModel> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    },
    "msg": null
}

响应示例说明：

十三、获取机器人引导语：robotGuide

如果在工作台设置了机器人引导语，那么可以调用此接口来获取机器人引导语。

robotGuide(String uid,String robotFlag,final StringResultCallBack<ZhiChiMessage> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "ustatus": -1,
        "answer": {
            "msgType": 0,
            "msg": "这是第二个机器人-1\n\n",
            "duration": null,
            "richpricurl": null,
            "richmoreurl": null
        },
        "answerType": "13",
        "stripe": null,
        "suggestionList": [
            {
                "question": "这是第二个机器人",
                "docId": "3e11e3b54d214b62ba16e2c26c69d869",
                "answer": "这是第二个机器人"
            }
        ],
    },
    "msg": null
}

响应示例说明：

十四、用户主动下线接口：out

调用此接口后用户将在客服工作台中显示下线，同时将计入统计数据。调用此接口成功后，发送客服消息将无法成功。

out(String cid, String uid, StringResultCallBack <CommonModel> resultCallBack);

请求参数说明：

响应示例：

{
        "code": 1,
        "data": {
                "status": 1
                    }
}

响应示例说明：

十五、留言上传图片接口：fileUploadForPostMsg

在提交留言时需要上传图片时可以使用此接口，上传完毕后将返回的文件路径以逗号分隔，作为参数提交到留言接口（postMsg）中。

fileUploadForPostMsg(String companyId, String filePath, ResultCallBack<ZhiChiMessage>

resultCallBack);

请求参数说明：

响应示例：

{
 "code": 1,    
"data": {        
"url":"https://img.sobot.com/chatres/e6fb17f5af9f4487a8ec7f1f58c972ba/msg/201
70605/dts_featured_ath_clr100_1496658840995.png"    
},    
"msg": null
}

响应示例说明：

十六、机器人回答顶踩接口：rbAnswerComment

此接口可以对机器人的回答词条进行命中率统计，调用后将计入统计数据。

rbAnswerComment(String uid, String cid, String robotFlag, String docId, String

docName,boolean revaluateFlag, StringResultCallBack<CommonModelBase> resultCallBack);

请求参数说明：

响应示例：

{
    "code": 1,
    "data": {
        "status": 1
    },
    "msg": null
}

响应示例说明：

十七、服务器推送的消息格式

需要注册广播：ZhiChiConstants.receiveMessageBrocast

1）用户与人工客服建立会话响应示例：

{
        "type": 200,        
        "aname": "sobotcggghh",
        "aface": "https://img.sobot.com/chb0.jpg",
        "aid": "1b6d22ab52bc4db99c3c7b055abd3332",
}

响应参数说明：

2）用户排队响应示例：

{
        "type": 201,
        "count": 3,
}

响应参数说明：

3）用户收到客服新消息响应示例：

{
        "type": 202,
        "aname": "sobotgghh",
        "aface": "https://img.sobot.com/ch0424785f6443acbc350b0.jpg",
        "content": "",
        "msgType": *,
}

响应示例说明：

4）用户被下线响应示例：

{
        "type": 204,
        "status": 2,
        "aname": "sobothhh",
        "msgId": "6793ec14b4d44739a7dc289d7ecc26c7",
        "puid": "0953be7e19b3494e8c6da517e2d062c9"
}

响应示例说明：

5）用户被客服转接响应示例：

{
        "type": 210,
        "name": "[email protected]",
        "face": "https://img.sobot.com/chat8f5d475091ad7a400b04ad96.jpg",
}

响应示例说明：

6）客服推送满意度评价响应示例：

{
        "type": 209,
        "aname": "[email protected]",
        "aid": "442d6f93cce54134a13542dd66dea1e7",
        "msgId": "2326a269b9f04d6c8c318b8d7678c8a0"
}

响应示例说明：

　代码混淆

　　-keepattributesAnnotation

　　-keepattributesSignature

　　-keeppublicclass*extendsandroid.app.Fragment

　　-keeppublicclass*extendsandroid.app.Activity

　　-keeppublicclass*extendsandroid.app.Application

　　-keeppublicclass*extendsandroid.app.Service

　　-keeppublicclass*extendsandroid.content.BroadcastReceiver

　　-keeppublicclass*extendsandroid.content.ContentProvider

　　-keeppublicclass*extendsandroid.app.backup.BackupAgentHelper

　　-keeppublicclass*extendsandroid.preference.Preference

　　-keeppublicclass*extendsandroid.support.v4.**

　　-keeppublicclasscom.android.vending.licensing.ILicensingService

　　-keepclasscom.android.vending.licensing.ILicensingService

　　-keepclassandroid.support.v4.**{*;}

　　-keepclassokhttp3.*

　　-keepclasscom.sobot.**{*;}

　　-dontwarnandroid.support.v4.**

　　-dontwarnokio.**

　　-dontwarncom.squareup.okhttp.**

　　-dontwarnandroid.webkit.WebView

　　-keepclasseswithmembernamesclass*{

　　 native<methods>;

　　}

　　-keepclasseswithmembernamesclass*{

　　 public<init>(android.content.Context,android.util.AttributeSet);

　　}

　　-keepclasseswithmembernamesclass*{

　　 public<init>(android.content.Context,android.util.AttributeSet,int);

　　}

　　-keepclassmembersenum*{

　　 publicstatic**[]values();

　　 publicstatic**valueOf(java.lang.String);

　　}

　　-keepclass*implementsandroid.os.Parcelable{

　　 publicstaticfinalandroid.os.Parcelable$Creator*;

　　}

　　-keepclasseswithmembersclass*{

　　 public<init>(android.content.Context);

　　}

　　-keepclassmembersclass*{

　　 public<init>(org.json.JSONObject);

　　}