会话上传本地文件。
接口说明
请求说明
该 API 用于上传会话临时文件,采用文件中转上传模式(fileTransfer):文件二进制不经本 API 的请求体传输,而是先落到 OSS,再把 OSS 地址通过 FileUrl 入参交给后端;后端从该地址取回字节并写入自己的 OSS,创建会话临时文件记录。
调用方式
推荐:使用 SDK 生成的
UploadChatFileAdvance方法,传入本地文件流,SDK 自动完成中转上传并回填FileUrl。直传:自行将文件上传到可被服务端访问的 OSS 地址,然后直接调用本 API 并传入
FileUrl。
入参
FileUrl:必填,文件的 OSS 地址。使用 Advance 方法时由 SDK 自动回填,无需手动赋值。
FileName:必填,原始文件名(含后缀,如
report.pdf)。中转生成的 OSS 地址不携带原始文件名,后端据此确定文件后缀与展示名,因此必须显式传入。ContentType:可选,文件 MIME 类型;不传时按
application/octet-stream处理。OperatingObjectName:可选,Agent 命名空间标识,决定文件入库路径。
出参
返回 OSS 对象路径 objectName、入库地址 fileUrl、公开访问地址 filePublicUrl(有效期 1 小时)、文件记录 ID fileRecordId 等;uploadSignatureUrl 在本模式下恒为空。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
winnexo:UploadChatFile |
none |
*全部资源
|
无 | 无 |
请求语法
POST /openapi/uploadChatFile HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
生效租户 ID。 |
10000 |
| fileUrl |
string |
是 |
宜搭附件地址。 |
http://winnexo-file-transfer.oss-cn-hangzhou.aliyuncs.com/openapi/2026-08-06/9f8c2a1b |
| fileName |
string |
是 |
文件全路径名称 |
report.pdf |
| contentType |
string |
否 |
文件内容类型,取值:
|
application/pdf |
| operatingObjectName |
string |
否 |
数字员工名称(运营对象 name,可选) |
string_value |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| code |
string |
状态码。 |
200 |
| message |
string |
状态码描述。 |
ok |
| requestId |
string |
请求 ID |
019FF406-1B10-0065-A97D-2D1920C2A03D |
| objectName |
string |
对象名称 |
string_value |
| fileUrl |
string |
宜搭附件地址。 |
https://example.com/winnexo/resource |
| filePublicUrl |
string |
阿里钉在线文档的可公开访问 URL |
https://example.com/winnexo/resource |
| uploadSignatureUrl |
string |
签名 url |
https://example.com/winnexo/resource |
| fileRecordId |
string |
文件记录 ID(可选,对应 settings.file_record_id) |
exampleFileRecordId |
| contentType |
string |
文件内容类型,取值:
|
string_value |
| fileName |
string |
文件全路径名称 |
example.pdf |
示例
正常返回示例
JSON格式
{
"code": "200",
"message": "ok",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
"objectName": "string_value",
"fileUrl": "https://example.com/winnexo/resource",
"filePublicUrl": "https://example.com/winnexo/resource",
"uploadSignatureUrl": "https://example.com/winnexo/resource",
"fileRecordId": "exampleFileRecordId",
"contentType": "string_value",
"fileName": "example.pdf"
}