api

后台 API

鉴权

所有接口都需要带上 validate 参数，该参数值和配置文件中的 server/validate 参数值相同。示例：

$ curl localhost:5000/gethistory?validate=f4bde2a342c7c75aa276f78b26cfbd8a

接口返回：

{"code": 0, "message": "ok", "history": "[{\"type\": 1, \"text\": \"\\u4f1f\\u6d32 \\u4f60\\u597d\\uff01\\u8bd5\\u8bd5\\u5bf9\\u6211\\u558a\\u5524\\u9192\\u8bcd\\u53eb\\u9192\\u6211\\u5427\", \"time\": \"2019-02-07 19:10:19\", \"uuid\": \"f464d430-2ac8-11e9-bd1e-8c8590caf9a5\"}, {\"type\": 0, \"text\": \"\\u4eca\\u5929\\u5929\\u6c14\\u600e\\u4e48\\u6837\", \"time\": \"2019-02-07 19:10:33\", \"uuid\": \"fca4c218-2ac8-11e9-bd1e-8c8590caf9a5\"}, {\"type\": 1, \"text\": \"[Weather] \\u6df1\\u5733\\u5929\\u6c14\\uff1a\\u4eca\\u5929\\uff1a\\u591a\\u4e91\\uff0c20\\u523028\\u6444\\u6c0f\\u5ea6\\u3002\\u4eca\\u5929\\u5929\\u6c14\\u4e0d\\u9519\\uff0c\\u7a7a\\u6c14\\u6e05\\u65b0\\uff0c\\u9002\\u5408\\u51fa\\u95e8\\u8fd0\\u52a8\\u54e6\", \"time\": \"2019-02-07 19:10:33\", \"uuid\": \"fceec836-2ac8-11e9-bd1e-8c8590caf9a5\"}, {\"type\": 0, \"text\": \"\\u73b0\\u5728\\u51e0\\u70b9\", \"time\": \"2019-02-07 19:33:34\", \"uuid\": \"chat58b0d6a2-8395-1453-6383-4e27c421ea89\"}, {\"type\": 1, \"text\": \"2019\\u5e7402\\u670807\\u65e5 \\u661f\\u671f\\u56db \\u4e0b\\u5348 7:33\", \"time\": \"2019-02-07 19:33:35\", \"uuid\": \"3445dcd6-2acc-11e9-bd1e-8c8590caf9a5\"}]"}

管理

用于重启 wukong-robot 。

• url：/operate
• method: POST
• 参数：

参数名	是否必须	说明
validate	是	参见 鉴权
type	是	类型。目前只有 restart 一种

• 示例：

$ curl -X POST localhost:5000/operate -d "type=restart&validate=f4bde2a342c7c75aa276f78b26cfbd8a"

• 返回：

参数名	说明
code	返回码。0：成功；1：失败
message	结果说明

会话

用于发起一次对话。

• url：/chat
• method: POST
• 参数：

参数名	是否必须	说明
validate	是	参见 鉴权
type	是	query 类型。 "text": 文本型 query ； "voice"：语音型 query
query	仅当 type 为 "text" 时需要	发起对话的内容的 urlencode 后的值。例如 ”现在几点？“ 的 urlencode 结果
uuid	仅当 type 为 "text" 时需要	为这个文本 query 赋予的一个 uuid。例如可以使用随机字符+时间戳。
voice	仅当 type 为 "voice" 时需要	语音。需为 单通道，采样率为 16k 的 wav 格式语音的 base64 编码。

• 示例：

$ curl -X POST localhost:5000/chat -d "type=text&query=%E7%8E%B0%E5%9C%A8%E5%87%A0%E7%82%B9&validate=f4bde2a342c7c75aa276f78b26cfbd8a&uuid=chated17be5d-0240-c9ba-2b2e-7eb98588cf34"

• 返回：

参数名	说明
code	返回码。0：成功；1：失败
message	结果说明