文档首页 > > API参考> 问答机器人> 问答会话API(即将下线)>

开启会话

开启会话

分享
更新时间:2021/02/07 GMT+08:00

功能介绍

问答会话API由开启会话、处理会话、关闭会话三个接口组成。用户可通过调用该接口创建会话。该接口即将下线,请优先使用问答机器人API接口进行调用。

URI

  • URI格式
    POST /v1/{project_id}/qabots/{qabot_id}/sessions
  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目ID,用于资源隔离。请参见获取项目ID

    qabot_id

    机器人标识符,qabot编号,UUID格式。如:303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

    进入问答机器人的Console界面,在“机器人名称/ID”列显示对应的qabot_id。

请求消息

响应消息

响应参数说明如表2所示。

表2 响应参数

名称

类型

说明

error_code

String

调用失败时的错误码,具体参见错误码列表。调用成功时无此字段。如:CBS.3254。

error_msg

String

调用失败时的错误信息。调用成功时无此字段。如:RESOURCE_NOT_EXIST_EXCEPTION。

session_id

String

会话标识符,UUID格式。如:c04e6f7b-61d7-4a2d-a0c8-f9ecd2f62359。

每轮会话有效时间为2分钟,若2分钟内无响应则session_id失效。

具体获取方式请参见开启会话章节。

greeting

String

机器人问候语。如:你好,我是你配置的机器人,现在可以跟我说话啦。

示例

  • 请求示例
    POST http://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions
    
    Request Header:
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • 响应示例
    • 成功响应样例
      {
      "session_id": "c04e6f7b-61d7-4a2d-a0c8-f9ecd2f62359",
      "greeting": "你好, 我是你配置的机器人,现在可以跟我说话啦"
      }
    • 失败响应样例
      {
      "error_msg": "RESOURCE_NOT_EXIST_EXCEPTION",
      "error_code": "CBS.3254"
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品