上傳檔案的API
需要上傳檔案時,使用這個 API 來上傳檔案,上傳成功後會返回 blobId。此 API 只會有一個回傳結果,不會有其他事件。
URI
{{base_url}}/generic/ns/{{namespace}}/bot-provider/{{bot_provider_name}}/blob
HTTP Method
POST
Headers
如果您有設定使用 API-Key 功能,請在 Header 中加入 X-API-KEY
欄位,值為您在 Asgard 後台設定的 API-Key。否則會無法正常連線。
名稱 | 類型 | 描述 |
---|---|---|
X-API-KEY | string | 您使用的 API-Key |
Content-Type
multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Request Parameters
使用 multipart/form-data
格式上傳檔案:
名稱 | 類型 | 描述 |
---|---|---|
customChannelId | string | 聊天頻道 ID,請使用同啟動請求用的頻道 ID。同一頻道 ID 才會記憶對話內容。 |
file | file | 要上傳的檔案 |
Response
成功上傳後會收到以下 JSON 回應:
{
"isSuccess": true,
"data": [
{
"channelId": "1939596381945597952",
"blobId": "1939596382025289728",
"fileType": "IMAGE",
"fileName": "image.png",
"size": 326492,
"mime": "image/png"
}
],
"paging": null,
"error": null,
"errorCode": null
}
請記錄回應中的 blobId
,以便在後續的訊息 API 中使用。
實際應用範例
請參考下方的請求操作教學,內含完整 JSON 範例與應用說明: