蓝心九问
Bot接口会话

更新会话名称

接口描述

此接口允许您更新指定会话的名称。这对于用户管理会话、对重要对话进行标记或重命名非常有用。

基础信息

请求地址/conversations/{conversation_id}/name
请求域名• 办公网域名:http://jiuwen-api.vmic.xyz/v1 • IDC域名:http://jiuwen-api.vivo.lan:8080/v1
请求方法POST
接口说明对会话进行重命名,会话名称用于显示在支持多会话的客户端上。

请求参数

Request Header

参数取值说明
AuthorizationBearer {{API-SECRET-KEY}} 用于验证客户端身份的 [API密钥]。注意:请只替换红色部分!Bearer和密钥中间有一个空格,请勿删除!
Content-Typeapplication/json响应的HTTP内容类型。

Path Params

参数类型说明
conversation_idString会话ID

Request Body

参数类型是否必传默认值说明
nameString是新的名称
userString否用户标识,由开发者定义规则,需保证用户标识在应用内唯一。

示例

Request

curl --location --request POST 'http://chato-console-test.vmic.xyz/v1/conversations/{conversation_id}/name' \
--header 'Authorization: Bearer {{API-SECRET-KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{ 
 "name": "", 
 "user": "abc-123"
}'

注意: 请只替换{{API-SECRET-KEY}}!Bearer和密钥中间有一个空格,请勿删除!

Response

{
  "result": "success"
}

On this page