导入文件

POST

/sdk/v2/api/files/v1/import

导入文件过程是一个异步处理过程，接口请求成功仅代表导入服务收到并开始处理导入请求，实际是否成功需要轮询获取导入进度接口查询导入任务是否完成。

导入支持的文件格式

石墨文件类型	支持导入的文件类型
document	.docx，.doc，.md，.txt
documentPro	.docx，.doc，.wps
spreadsheet	.xlsx，.xls，.csv, .xlsm
presentation	.pptx，.ppt

请求参数

Query 参数

signature

string

可选

示例值:

token

string

可选

示例值:

123123

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

Body 参数multipart/form-data

fileId

string

必需

服务商文件的唯一 ID

示例值:

file-import-6

type

string

需要导入的文件类型

必需

示例值:

document

file

可选

需要导入的文件（如果不发送文件，就必须传fileUrl、fileName）

示例值:

file:///Users/luyang/Documents/TempDoc/shimo_test.docx

fileUrl

string

可选

需要导入的文件下载地址（有参数file，可以不用传）

示例值:

https://domain.com/files/download/test.docx

fileName

string

可选

需要导入的文件名称（有参数file，可以不用传）

示例值:

test.docx

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://office.shimoapi.com/sdk/v2/api/files/v1/import' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM' \
--form 'fileId="file-import-6"' \
--form 'type="document"' \
--form 'file=@"/Users/luyang/Documents/TempDoc/shimo_test.docx"'

返回响应

🟢200成功

application/json

Body

status

integer

必需

导入状态，非 0 表示异常

message

string

必需

导入异常时的提示信息

data

object

必需

taskId

string

必需

导入任务的标识 ID，调用导入进度接口时，请带上该参数。导入失败时请提供此 ID 用于调试

示例

{
  "status": 0,
  "message": "string",
  "data": {
    "taskId": "string"
  }
}

修改于 2025-01-14 03:34:40

创建预览文档

获取导入进度