跳到主要内容

删除画布

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 Restful API 删除指定 recordId 对应的画布。

前提条件​

  • 已经完成英飞画布的创建动作，并持有对应的 recordId 信息
  • 了解 Restful API 请求签名的生成方式（详见生成签名）

Http 请求​

  • 请求路径
https://api.infi.cn/u3wbs/wbs/websdk/deleteBoards
  • query 参数：
字段
类型
描述
appId
string
应用 appId，可以在控制台中获取
expire
integer
签名过期时间戳（毫秒）
signature
string
签名，生成方式见链接

query 参数示例：

appId=test&expire=12345678901234&signature=70D59A285EE91C666020FB3D0359FBAAA1867145

请求的参数连同请求签名需要以 Url Search Params 形式拼接至接口路径之后。

  • body 参数：
字段
类型
描述
recordIds
Array<string>
待删除的画布 recordId 数组

示例：

{
  "recordIds": [ "record1", "record2"]
}

与 query 参数不同，body 参数需要作为常规 POST 请求的 application/json body payload 发送。

  • 完整请求 curl 示例:
curl --location --request POST 'https://api.infi.cn/u3wbs/wbs/websdk/deleteBoards?
appId=dx_test&expire=12345678901234&signature=155E5369D58D3C01DF40A8CE618B96150E637843' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recordIds":["record1","record2"]
}'

  • 响应包体

    • 请求成功情况 如果请求受理成功，则响应的数据内状态码为 0。 需要注意的是，正在被使用的画布无法被删除，所以在调用删除画布接口时，部分画布可能会删除失败。 故请求成功的返回体中，会包含一个 failedRecordIds 字段，用以标识哪些画布删除失败了。

      • 如果 failedRecordIds 为空数组，则表明指定的画布已经全部删除成功。
      • 如果 failedRecordIds 不为空，调用侧需要记录这些删除失败的画布 recordId，并另寻时机重新尝试删除。

      请求成功包体示例：

{
  "code": 0,
  "reqId": "string",
  "reqTime": 0,
  "obj": {
    "failedRecordIds": [
      "record2"
    ]
  }
}
  • 请求失败情况 响应包体中 code 字段不为 0 时表请求失败，失败信息请查询错误码列表。