Ubot对接api渠道

一. 鉴权校验接口

请求地址

请求参数

{
    "timestamp":1731998070,
    "sign":"e3b035f81afd309097f189ceab67b4aa286d8b20",
    "robotId":85
}
参数名 参数类型 参数介绍
timestamp String 发起请求时的时间戳，'1970-01-01 00:00:00'至今的秒数。如无特别说明，默认过期时间五分钟
sign String 签名
robotId Integer ubot智能体id

请求结果

参数 类型 描述
code Integer 执行结果码
message String 执行结果说明
data Object 鉴权验证结果
data.result boolean 结果, 成功true, 失败false
data.type Integer 机器人id校验失败:1 机器人校验成功,鉴权失败:0

示例


{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "result": true
    }
}

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "result": false,
        "type": 0
    }
}

二. 创建会话接口

请求地址

请求参数

URL param 请求接口时的参数，如/contacts?page=10中的page

参数名 参数类型 参数介绍
timestamp String 发起请求时的时间戳，'1970-01-01 00:00:00'至今的秒数。如无特别说明，默认过期时间五分钟
sign String 签名
robotId integer ubot智能体id

请求结果

参数 类型 描述
code Integer 执行结果码
message String 执行结果说明
data Object 会话数据
data.conversionId Long ubot会话id
data.robotId Integer ubot 智能体id
data.customerId Long 客户id

示例

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "conversionId": 1753,
        "robotId": 85,
        "customerId": 678
    }
}

三. 对话接口

SSE流式输出

请求参数

URL param 请求接口时的参数，如/contacts?page=10中的page

参数名 参数类型 参数介绍
timestamp String 发起请求时的时间戳，'1970-01-01 00:00:00'至今的秒数。如无特别说明，默认过期时间五分钟
sign String 签名
robotId integer ubot智能体id
conversionId Long ubot会话id
content String 请求内容

请求结果

参数 类型 描述
message String 消息内容
code Integer 执行结果码 (204 超纲内容 200 正常 )
sources Array 来源文档信息
sources[].docId Integer 文档id
sources[].type String 文档类型
sources[].fileUrl String 文档url
sources[].docSegment String 文档片段
sources[].title String 文档标题
finished Integer 结束标记, 结束:1 未结束 0
msgType String 消息类型, 目前仅"follow_up" 类型, 表示推荐问题

示例1

event:heartbeat
data: 

event:heartbeat
data: 

event:heartbeat
data: 

event:message
data:{"message":"红烧肉怎么做简单版？  ","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"辣椒炒肉加什么调料？  ","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"其他经典家常菜推荐？","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"尊敬的用户，感谢您的提问。目前我尚不具备解答该问题的相关知识。您可以选择探索其他相关话题，或者直接联系我们的专业客服团队，我们将竭诚为您提供帮助。期待您的宝贵反馈！","sources":[],"code":204,"finished":1}

示例2

event:heartbeat
data: 

event:heartbeat
data: 

...

event:message
data:{"message":"盘","sources":[],"code":100,"finished":0}

event:message
data:{"message":"，","sources":[],"code":100,"finished":0}

event:message
data:{"message":"撒","sources":[],"code":100,"finished":0}

event:message
data:{"message":"上","sources":[],"code":100,"finished":0}

event:message
data:{"message":"葱","sources":[],"code":100,"finished":0}

event:message
data:{"message":"花","sources":[],"code":100,"finished":0}

event:message
data:{"message":"即可","sources":[],"code":100,"finished":0}

event:message
data:{"message":"。","sources":[],"code":100,"finished":0}

event:heartbeat
data: 

event:heartbeat
data: 

event:message
data:{"message":"红烧肉配什么菜？  ","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"红烧肉怎么做快手版？  ","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"红烧肉怎么做不油腻？","sources":[],"finished":0,"msgType":"follow_up"}

event:message
data:{"message":"","sources":[{"docId":360,"type":"ubot","fileUrl":"https://staging-udesk.oss-cn-beijing.aliyuncs.com/Data/1/ad1da38f-9184-46c6-8199-2d01e8d8abb1/菜谱.txt","docSegment":"一，红烧肉\n红烧肉是很受欢迎的家常菜，要想做好，需要掌握一定的技巧，煸炒五花肉时，要少放油，因为肉本身会出油的，放太多油的话，做好后的红烧肉口感会比较腻，\n推荐食谱：【红烧肉】\n所需食材：肉 葱姜 米酒\n调味料：盐 生抽 冰糖 老抽 蚝油\n1、准备一块上等的五花肉，先把五花肉给清洗一下，然后再把五花肉的肉皮给烧一烧，这样可以去掉表面的绒毛，也可以去腥，烧过之后，放水中浸泡，然后把烧焦的部分给刮一刮，再给洗净\n2、猪肉处理好，冷水下锅，放入葱姜 倒入料酒，大火煮开焯水，煮开后，把表面的浮沫给撇干净然后再继续煮10分钟\n3、五花肉煮好捞出 ，不烫手的时候，直接切成小块。不要切得太小了，不然吃起来不过瘾。切好的肉块放在一边备用\n4、锅中烧油，放入一把冰糖炒糖色，先大火炒融化，然后再小火烧至呈现枣红色的密集小泡泡，倒入开水，糖色炒好盛入碗中备用\n5、锅中再次烧油，放入五花肉放进去炒一炒，五花肉炒到均匀上色，煸炒出里面的油脂，炒到五花肉微微焦黄，然后再放入葱姜蒜炒香。然后再放入大料 桂皮 香叶 八角 花椒，炒出香味\n6、炒香后 再放入适量的米酒，之后把炒好的糖色给倒进来，然后再倒入开水，开水要没过五花肉，开始要一次加足。接下来添加 盐 生抽 冰糖 老抽 蚝油 调味，大火煮开，转中火焖50分钟\n7、焖好之后，把里面的大料给挑出来，然后大火收汁，汤汁收到浓稠的时候，关火，然后盛入盘中，撒上芝麻 葱花 美味好吃的红烧肉就做好了","title":"菜谱.txt"}],"code":200,"finished":1}