注意,本接口的使用需要进行接口鉴权

机器人接口简介: 首先使用初始化接口获取一个cid,代表与机器人的一次会话,之后使用cid去调用机器人问答接口。问答接口会将问题解析为关键字去匹配机器人问答库,然后将匹配到的答案返回。

1.机器人初始化接口

  • HTTP请求方式:POST

  • 请求地址:{HOST}/v20160818/robot/init/ACCOUNTID?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

  • 请求示例:

https://apis.7moor.com/v20160818/robot/init/N00000000556
?sig=41276A8E7767352A0FE7456D20F03D3

请求体 空

返回值:

字段 含义
code 响应码
message 响应信息
data 返回数据,JSON格式

data:

cid 会话id
robotName 机器人名字

code:

代码 含义
200 请求成功
400 请求体参数错误
403 鉴权参数错误
500 服务器错误

返回200示例

{
    "code": 200,
    "message": "200 OK",
    "data": {
        "cid": "52eb33a6-3741-4d9d-ba7f-76194b8f0099",
        "robotName": "机器人小七"
    }
}

返回400示例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403示例:

{
    "code": 403,
    "message": "Forbidden"
}

返回500示例:

{
    "code": 500,
    "message": "Internal Server Error"
}

2.机器人问答接口

  • HTTP请求方式:POST

  • 请求地址:{HOST}/v20160818/robot/questionAnswer/ACCOUNTID?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

  • 请求示例:

http://apis.7moor.com/v20160818/robot/questionAnswer/N00000000556
?sig=41276A8E7767352A0FE7456D20F03D3

请求体

{
    "cid": "52eb33a6-3741-4d9d-ba7f-76194b8f0099",
    "question": "你的名字"
}

返回值:

字段 含义
code 响应码
message 响应信息
data 返回数据,JSON格式

data:

answerType 答案类型: 1直接回答:机器人回答成功,答案为 answer 2一个以上答案:返回suggestions 字段 3未知问题,将回答机器人信息配置中的答案 4关联问题,返回answer 与suggestions 字段,answer为问题答案,suggestion为关联的问题
answer 答案
suggestions 建议

code:

代码 含义
200 请求成功
400 请求体参数错误
403 鉴权参数错误
500 服务器错误

返回200示例

{
    "code": 200,
    "message": "200 OK",
    "data": {
        "answerType": "2",
        "suggestions": [
            "你的名字",
            "你的国籍"
        ],
        "answer": ""
    }
}
{
    "code": 200,
    "message": "200 OK",
    "data": {
        "answerType": "1",
        "suggestions": [],
        "answer": "行不更名,坐不改姓,小七就是我"
    }
}
{
    "code": 200,
    "message": "200 OK",
    "data": {
        "answerType": "3",
        "suggestions": [],
        "answer": "小七还不太明白,还在努力学习中!"
    }
}
{
    "code": 200,
    "message": "200 OK",
    "data": {
        "answerType": "3",
        "suggestions": [{"name”:”wk测试","_id":"35f9f110-1aa8-11e7-af5d-7fed3fd86081"}],
        "answer": “123”
    }
}

返回400示例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403示例:

{
    "code": 403,
    "message": "Forbidden"
}

返回500示例:

{
    "code": 500,
    "message": "Internal Server Error"
}