开发工具

获取导入进度

POST

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

异步导入 v1 和 v2 接口都是用该接口获取导入进度，通过轮询该接口，直到返回的 status == 0 和 data.progress == 100 时表示导入完成，即可通过对接前端 js-sdk 进行查看或编辑。

请求参数

Query 参数

taskId

string

必需

导入文件接口返回的 taskId

示例值:

evU4ZmwHbC92T0mJ

signature

string

可选

示例值:

token

string

可选

示例值:

123

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

示例代码

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/progress?taskId=evU4ZmwHbC92T0mJ' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NTAxNTg1OTV9.lJEztf_Cw7lgnO9EKgUA44C62gGY2B1G8eqoBv-tB8U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NTAxNTg1OTV9.X8jvA-iDVwwUKOcE0IrkZxa4PERWsEisIS1ZQedoKJU'

返回响应

🟢200成功

application/json

Body

status

integer

必需

导入状态，非 0 表示异常

message

string

必需

导入异常时的提示信息

data

object

必需

progress

integer

必需

导入进度百分比，为 100 时表示导入完成

示例

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

修改于 2024-06-11 08:01:56

导入文件

导出文件