会话开始接口
所有文档
menu

客悦智能客服企业版

会话开始接口

产品详情

会话开始接口

接口说明

会话开始接口,用于获取欢迎语,热点推荐问题,支持只返回欢迎语, 只返回推荐问题或两者都返回。

接口地址

https://api-ngd.baidu.com/core/v4/start

请求方法

GET/POST

Header参数

名称 类型 必填 中文名 说明
Authorization string token_info 示例:NGD access_token
access_token是bot的属性,通过bot管理列表获取,
注意:字符“NGD”与access_token字符串中间有一空格
Uid string c 端用户id
Username string c 端用户名称
ACTIVE string 调用环境 online/offline 分别代表线上环境和测试环境
公有云环境该参数不生效

请求参数说明(GET)

参数名 类型 必选 说明
type String 请求类别,不传或空返回欢迎语和推荐问,welcome:只返回欢迎语;recommend:只返回推荐问
sessionId String 会话id。
可不传值,由会话机器人生成;
若传值,使用业务方传入的sessionId,用户传入的sessionId必须保证唯一,如UUID.
channel String 渠道名称,保持整个会话周期一致
ext Map 调用方回传参数,格式为json,数据不做处理用来后期分析使用; 示例:调用会话时传入{ "uid",123 } 会话日志中ext将会存储该信息;用于后期分析

请求体(POST)

参数名 类型 必选 说明
type String 请求类别,不传或空返回欢迎语和推荐问,welcome:只返回欢迎语;recommend:只返回推荐问
sessionId String 会话id。
可不传值,由会话机器人生成;
若传值,使用业务方传入的sessionId,用户传入的sessionId必须保证唯一,如UUID.
channel String 渠道名称,保持整个会话周期一致
ext Map 调用方回传参数,格式为json,数据不做处理用来后期分析使用; 示例:调用会话时传入{ "uid",123 } 会话日志中ext将会存储该信息;用于后期分析
context Map 上下文信息

返回参数说明

参数名 类型 说明
code int 错误码
msg String 错误信息
data Map<String, Object> 返回欢迎语和推荐问信息

data

参数名 类型 说明
qaRecommend List<String> 推荐问题列表
qaRecommendTitle String 推荐问题列表引导话术
sessionId String 会话id
queryId String 请求id
queryTime String 请求时间
answerTime String 响应时间
source String 来源类型,默认system
richWelcome Map 欢迎语富文本类型,兼容welcome字段,(内容格式与answer → answerContents格式一致)

请求示例

curl -X POST http://api-ngd.baidu.com/core/v4/start -H 'authorization: NGD 142c8d88-cd69-4b1e-a4d5-443da096c3c6' \
-d '{
    "sessionId": "5cb6e7b8-e3da-45bb-ac07-98265ac54a01",
    "ext":{"uid":"0000001", "username":"ngd"}
}'

响应结果示例

{
    "time": 1574308601082,
    "data": {
        "qaRecommend": [
            "推荐问1?",
            "推荐问2?",
            "推荐问3?"
        ],
        "welcome": "您好,很高兴为您服务!这是demo哦",
        "sessionId": "5cb6e7b8-e3da-45bb-ac07-98265ac54a01",
        "botName": "租车bot",
        "botDesc": null,
        "botVersion": null,
        "queryId": "6cc36192-593e-498e-a0af-ae312eb88c47",
        "queryTime": null,
        "answerTime": null,
        "source": "system",
        "agentType": 1,
        "queryTime":"2019-11-21 11:11:11",
        "answerTime":"2019-11-21 11:11:12"
    },
    "code": 200,
    "msg": "OK"
}
上一篇
对话接口调用说明
下一篇
流式对话接口