请求方法
POST https://open.sobot.com/open/platform/api.json
请求参数(Request Body)
参数名 |
类型 |
必填 |
说明 |
|
action |
字符串 |
是 |
传值为"chat_user_robot_ask" |
|
access_token |
字符串 |
是 |
调用接口凭据 |
|
data |
对象 |
是 |
详见下文 |
|
请求data
参数名 |
类型 |
必填 |
说明 |
|
sysNum |
字符串 |
是 |
企业标识,由智齿分配 |
|
partnerId |
字符串 |
是 |
企业自己的用户id,可自行传值 |
|
question |
字符串 |
是 |
用户问题;多轮会话点击时传入:上轮会话multiDiaRespInfo数据中,只保留template和interfaceRetList的json,其中interfaceRetList集合只保留选中的集合元素 |
|
uname |
字符串 |
否 |
用户昵称 |
|
source |
整型 |
否 |
用户渠道:0-pc,1-微信,2-app,3-微博,4-移动网站 |
|
robotFlag |
整型 |
否 |
机器人编号 |
|
questionFlag |
整型 |
否 |
问题类型:点击-1,输入-0,多轮会话中点击-2 |
|
requestText |
字符串 |
否 |
问题内容 |
|
返回数据
参数名 |
类型 |
说明 |
|
code |
字符串 |
执行结果码,1000代表成功 |
|
data |
对象 |
详见下文 |
|
返回data
参数名 |
类型 |
说明 |
|
answer |
字符串 |
答案 |
|
suggestions |
对象 |
推荐问题列表,详见下文 |
|
question |
字符串 |
原始问题 |
|
docId |
字符串 |
词条id |
|
uid |
字符串 |
用户id |
|
cid |
字符串 |
会话id |
|
msgId |
字符串 |
消息体id |
|
stripe |
字符串 |
问题推荐引导语 |
|
robotFlag |
整型 |
机器人编号 |
|
answerType |
整型 |
机器人回答类型 |
|
multiDiaRespInfo |
对象 |
多轮会话返回数据,详见下文 |
|
sessionNew |
布尔值 |
是否是新会话,true-是,false-不是 |
|
返回suggestions
参数名 |
类型 |
说明 |
|
question |
字符串 |
推荐问题的名称 |
|
answer |
字符串 |
推荐问题的答案 |
|
docId |
字符串 |
推荐问题的词条Id |
|
返回multiDiaRespInfo
参数名 |
类型 |
说明 |
|
retCode |
字符串 |
状态码:000000-成功;000001----接口返回参数错误或者参数缺失、网络连接超时;000002---输入参数长度或者属性校验失败 |
|
conversationId |
字符串 |
多轮会话id |
|
outPutParamList |
字符串 |
下轮回话需要传回参数列表,多个以"#"隔开,参数对应interfaceRetList中某一元素的属性 |
|
docId |
字符串 |
词条Id |
|
template |
整型 |
模板编号 |
|
endFlag |
布尔类型 |
多轮会话是否结束 |
|
answerStrip |
字符串 |
答案引导语 |
|
remindQuestion |
字符串 |
中间问题引导语 |
|
level |
整型 |
||
interfaceRetList |
集合 |
接口返回数据集合 |
|
请求示例
curl https://open.sobot.com/open/platform/api.json \
-X POST \
-H 'content-type: application/json' \
-d '
{
"action":"chat_user_robot_ask",
"access_token":"xx",//获取access_token
"data":{
"sysNum" : "xx",
"partnerId" : "xx",
"question" : "xx",
"source" : 0,
"robotFlag" : 1,
"questionFlag" : 0,
"requestText" : "xx",
}
}'
{
"code": "1000",
"data": {
"answer": "xx",
"suggestions": [
{"question":"xx","answer":"xx","docId":"xx"}
],
"question" : "xx",
"docId" : "xx",
"uid" : "xx",
"cid" : "xx",
"msgId" : "xx",
"stripe" : "xx",
"robotFlag" : 1,
"answerType" : 1,
"sessionNew" : true,
"multidiaRespInfo" : {
"retCode" : "000000",
"conversationId" : "xx",
"outPutParamList" : "xx",
"docId" : "xx",
"template" : 1,
"endFlag" : false,
"answerStrip" : "xx",
"remindQuestion" : "xx",
"level" : "xx",
"interfaceRetList" : [{}],
}
}
}