图片上传 API
通过此 API,您可将经过 Base64 编码的图片文件上传至 PaaSoo 服务器,并获取一个唯一的图片链接 (address)。 在后续发送彩信(MMS)时,可将此链接用作 attachment 字段的值,实现图片彩信的快速交付。
1. 调用方式
调用方式
- HTTP Method:
POST - Content-Type:
application/json - API Endpoint:
https://api.paasoo.cn/image/upload - 安全性:建议使用 HTTPS 协议,需携带正确的
key与secret。 - 图片大小限制:建议 300KB 以内。超出限制需与 PaaSoo 协商或进行适当压缩。
2. 请求示例
以下以 cURL 为例,展示如何通过 POST + application/json 的方式上传图片:
cURL
curl -X POST "https://api.paasoo.cn/image/upload" \
-H "Content-Type: application/json" \
--data-raw '{ "key": "API_KEY", "secret": "API_SECRET", "content": "xxxx", "format": "jpg" }'
说明
content 应为 Base64 编码的图片数据;请确认图片大小在 300KB 以内。
format 仅支持 jpg 或 png。
3. 请求参数说明
| 参数 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| key | string | 是 | API Key(字母或数字构成,共 8 位),用于唯一标识您的账户。可在PaaSoo 客户端后台获取。 | Abcdefgh |
| secret | string | 是 | API Secret(字母或数字构成,共 8 位),与 key 配合使用以进行身份验证。可在PaaSoo 客户端后台获取。 | Abc123EF |
| content | string | 是 | Base64 编码的图片内容,大小建议 <300KB。 | iVBORw0KGgoA... |
| format | string | 是 | 图片格式,仅支持 jpg 或 png。 | jpg |
4. 响应参数说明
4.1 响应字段说明
| 参数 | 类型 | 描述 | 示例 |
|---|---|---|---|
| status | integer | 提交至 PaaSoo 云通讯平台的响应状态码。 接口状态码列表:
| 0 |
| status_code | string | 状态描述。 | Missing parameters |
| address | string | 图片在 PaaSoo 服务器上的唯一访问链接。 | https://files.example.com/images/mms/example.jpg |
| format | string | 图片类型,例如 jpg 或 png。 | jpg |
| size | integer | 图片大小 (单位:KB)。 | 233 |
4.2 成功响应示例
{
"status": 0,
"address": "https://files.example.com/images/mms/example.jpg",
"format": "jpg",
"size": 233
}
说明
status = 0 表示上传成功。
address 为图片的唯一访问链接,可在后续彩信中使用。
format 与 size 分别表示图片的文件格式与大小(单位:KB)。
4.3 失败响应示例
{
"status": 2,
"status_code": "Missing parameters."
}
说明
status = 2 表示请求参数缺失或错误。
5. 最佳实践与注意事项
- 图片格式与体积:为确保彩信发送的稳定性与兼容性,请使用 JPG 或 PNG 格式,且大小尽量控制在 300KB 以内。
- 图片质量与显示:彩信在不同终端与运营商网络上可能存在因转码或压缩导致的清晰度差异,请提前测试。
- 加密与安全:建议使用 HTTPS 协议进行上传,以防止敏感数据(
key、secret)被截获。 - 回调与日志:若需对上传记录和使用情况进行追踪,建议在业务逻辑中保留上传成功后返回的
address,并与目标彩信记录关联。 - 自动清理:所有已上传的图片可能会在 30 天后自动从服务器上删除。如果您需要更长时间保留,请提前与 PaaSoo 协商。
6. 附录
- 后续使用:获得的
address可直接填入彩信发送接口的attachment参数,实现低延迟、高可用的图片传输。 - 重用与过期:一旦上传成功,图片链接一般不会立即过期,但如上所述,服务器或会在 30 天后自动删除图片。
- 海量图片:如果您需要频繁上传大量图片,请与我们联系,了解批量上传或额外带宽预算等方案。
技术支持
如在 API 对接过程中遇到任何技术问题或业务疑问,欢迎随时联系我们的开发者支持团队:support@paasoo.com。我们将竭诚为您提供技术协助。