图片删除 API
通过此 API,您可删除先前上传到 PaaSoo 平台的图片文件。该操作适用于主动清理不再需要的图片资源,从而减少冗余占用。
1. 调用方式
调用方式
- HTTP Method:
GET - API Endpoint:
https://api.paasoo.cn/image/delete - 请求参数:通过
key、secret和address拼接于 URL 中。
注意事项:address 参数必须进行 URL 编码,以避免传递特殊字符时出错。
2. 请求示例
以下为直接在浏览器或命令行中 GET 请求的示例:
https://api.paasoo.cn/image/delete?key=API_KEY&secret=API_SECRET&address=ENCODED_IMAGE_URL
说明
- ENCODED_IMAGE_URL 指将原始图片链接使用 UTF-8 格式进行 URL 编码后的结果。
- 若需测试编码效果,可使用在线工具进行文本转换。
3. 请求参数说明
| 参数 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| key | string | 是 | API Key(字母或数字构成,共 8 位),用于唯一标识您的账户。可在PaaSoo 客户端后台获取。 | Abcdefgh |
| secret | string | 是 | API Secret(字母或数字构成,共 8 位),与 key 配合使用以进行身份验证。可在PaaSoo 客户端后台获取。 | Abc123EF |
| address | string | 是 | 待删除图片的地址,请进行 URL 编码 后再附加到请求参数。 | https%3A%2F%2Ffiles.example.com%2Fimages%2Fxxx.jpg |
4. 响应参数说明
4.1 响应字段说明
| 参数 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 提交至 PaaSoo 云通讯平台的响应状态码。 接口状态码列表:
| 0 |
| status_code | string | 状态描述。 | Missing parameters |
4.2 成功响应示例
{
"status": 0,
"status_code": "success"
}
说明:status = 0 表示图片文件已成功删除。
4.3 失败响应示例
{
"status": 2,
"status_code": "Missing parameters."
}
说明:status = 2 表示请求中缺少必要参数。
5. 最佳实践与注意事项
- 删除不可恢复:一旦执行此删除操作,被删除的图片将无法恢复,请谨慎调用。
- 安全性:建议结合 HTTPS 协议与 IP 白名单进行保护,避免非授权请求恶意删除资源。
- 参数校验:在提交删除请求前,请确保已正确进行 URL 编码,并且
key、secret无误。 - 配合使用:建议将本 API 与 图片上传 API、彩信发送 API结合使用,及时清理过期或不再需要的图片。
- 自动清理:为提升系统效率,PaaSoo 可能会在图片上传 30 天后自动删除该图片。如果您在 30 天后调用本接口,图片可能已被系统清理而无法再次删除。
6. 附录
- 日志记录:对删除操作进行日志记录,可在后续进行审计或问题排查时作为参考。
- 自动化策略:如有定期清理需求,可在业务端开发自动任务,调用该接口进行批量删除。
技术支持
如在 API 对接过程中遇到任何技术问题或业务疑问,欢迎随时联系我们的开发者支持团队:support@paasoo.com。我们将竭诚为您提供技术协助。