上传消息文件

上传一个或多个文件到 PBX，用于在消息群发活动或消息会话中发送。

注：

  • 上传的文件将存储在文件夹 /ysdisk/cache/chat 下，这些文件会与聊天消息一起定期被清理。

  • 上传文件的总大小不得超过 100 MB。

请求 URL

POST {base_url}/{api_path}/message/batchupload?access_token={access_token}

请求参数

参数 是否必填 类型 说明
files 是 file 通过 form-data 上传的文件资源列表。
注： 支持同时上传多个文件。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
list Array <File_Info> 上传文件的详细信息。
File_Info
参数 类型 说明
id String 文件 ID。
name String 文件名称。
uri String 文件访问的 URI。
type String 文件类型。
size Integer 文件大小 (单位：字节)。

示例

请求示例

POST /openapi/v1.0/message/batchupload?access_token=cIRvlHGgdMSuY0eiWE9JkXLCcHZHRTXm HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="/D:/projects/files/demo.wav"
Content-Type: audio/wav

(binary data) # actual file content here
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="/D:/projects/files/demo.jpg"
Content-Type: image/jpeg

(binary data) # actual file content here
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="/D:/projects/files/demo.mp4"
Content-Type: video/mp4

(binary data) # actual file content here
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files"; filename="/D:/projects/files/demo.csv"
Content-Type: text/csv

(binary data) # actual file content here
------WebKitFormBoundary7MA4YWxkTrZu0gW--
图 1. Postman 请求示例

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "list": [
        {
            "id": "da20742bf760466aa0aac64c07c05353",
            "name": "demo.wav",
            "uri": "20250728/da20742bf760466aa0aac64c07c05353",
            "type": "audio/wave",
            "size": 202812
        },
        {
            "id": "98027f003d3d47328f2e5dbeb0f65879",
            "name": "demo.jpg",
            "uri": "20250728/98027f003d3d47328f2e5dbeb0f65879",
            "type": "image/jpeg",
            "size": 95896
        },
        {
            "id": "d96bb38dafc447c5b04350df9440f74c",
            "name": "demo.mp4",
            "uri": "20250728/d96bb38dafc447c5b04350df9440f74c",
            "type": "video/mp4",
            "size": 309568
        },
        {
            "id": "75866e1ff520418a8bee0f92f6d7b161",
            "name": "demo.csv",
            "uri": "20250728/75866e1ff520418a8bee0f92f6d7b161",
            "type": "text/csv",
            "size": 56890
        }
    ]
}