在开放平台, 会话是指用户与智能体的对话过程,可以包含多个轮次的问答。通过调用本接口,开发者可以创建一个新的会话。
前提条件
- 在调用本接口前,请先完成应用的发布,若无,请参见:发布应用,完成相关事项。
请求地址
POSThttps://api.tbox.cn/api/conversation/create
请求头
参数名 |
是否必填 |
类型 |
说明 |
示例 |
Authorization |
是 |
String |
用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 |
|
请求参数
参数名 |
是否必填 |
类型 |
说明 |
示例 |
appId |
是 |
String |
应用 ID,需要通过 API 进行集成的应用 ID。获取方式可参见:获取AppID。 |
202506e******00450562 |
请求示例
curl --location 'https://api.tbox.cn/api/conversation/create' \ --header 'Authorization: {your_token}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --data '{ "appId":{your_appId} }'
返回参数
参数名 |
类型 |
说明 |
示例 |
errorCode |
String |
错误码,为 0 表示成功。 |
0 |
errorMsg |
String |
错误信息。 |
success |
data |
String |
会话 ID。 |
- |
traceId |
String |
traceId,用于排查问题 |
0a42******9265 |
返回示例
成功返回
{ "data": "2025******3533", "errorCode": "0", "errorMsg": "success", "traceId": "0a42******9265" }
失败返回
{ "errorCode": "P_1_02_084", "errorMsg": "app不存在", "solution": "请确认参数:appId是否有效" }