跳到正文

创建带附件的推送通知 POST 付费 ​

发送带图片附件的推送通知。

付费功能

此接口仅适用于付费套餐。

端点 ​

POST https://api.pocketalert.app/v1/messages

身份验证 ​

必填

在请求中添加以下请求头之一:

  • Token: <your-api-key> — 在 API 密钥 页面获取
  • Authorization: Bearer <jwt-token> — 来自 登录

请求 ​

请求头 ​

请求头必填说明
Content-Type✅multipart/form-data
Token✅你的 API 密钥

请求体参数(multipart/form-data) ​

参数类型必填说明
titlestring✅通知标题
messagestring✅通知正文
application_idstring❌应用 TID
device_idstring❌设备 TID(留空则发送给所有设备)
imagefile❌图片附件(.png、.jpg、.jpeg、.gif)

请求示例 ​

bash
curl -X POST "https://api.pocketalert.app/v1/messages" \
  -H "Token: your-api-key" \
  -F "title=Screenshot Alert" \
  -F "message=New screenshot captured" \
  -F "image=@/path/to/screenshot.png"
javascript
const formData = new FormData();
formData.append('title', 'Screenshot Alert');
formData.append('message', 'New screenshot captured');
formData.append('image', fileInput.files[0]);

const response = await fetch('https://api.pocketalert.app/v1/messages', {
  method: 'POST',
  headers: { 'Token': 'your-api-key' },
  body: formData
});
python
import requests

with open('screenshot.png', 'rb') as f:
    response = requests.post(
        'https://api.pocketalert.app/v1/messages',
        headers={'Token': 'your-api-key'},
        data={
            'title': 'Screenshot Alert',
            'message': 'New screenshot captured'
        },
        files={'image': f}
    )
print(response.json())
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->attach(
    'image', file_get_contents('/path/to/screenshot.png'), 'screenshot.png'
)->post('https://api.pocketalert.app/v1/messages', [
    'title' => 'Screenshot Alert',
    'message' => 'New screenshot captured',
]);

return $response->json();

响应 ​

成功响应 ​

201 Created

带附件的消息创建成功

字段类型说明
tidstring消息唯一标识符
titlestring消息标题
messagestring消息正文
attachmentobject附件详情
attachment.tidstring附件标识符
attachment.file_namestring存储的文件名
attachment.content_typestringMIME 类型
attachment.file_sizeinteger文件大小(字节)
json
{
  "tid": "zvtfxzk55fpqugz7ueslmse2a",
  "title": "Screenshot Alert",
  "message": "New screenshot captured",
  "application": "Monitoring",
  "device": "iPhone",
  "created_at": "04.01.2025 09:12:08",
  "attachment": {
    "tid": "i6k4b8un79otbcbdkmavmf4ha",
    "file_name": "5bd64bb3b76df1be1fc7f41eeb5078ca.jpg",
    "content_type": "image/jpeg",
    "file_size": 247421
  }
}

错误响应 ​

状态码说明
401未授权 — 令牌无效或缺失
403禁止访问 — 该功能需要付费套餐
400请求错误 — 缺少 title 或 message,或文件格式不受支持
404未找到 — application_id 或 device_id 不存在
429已达到每日上限 — 不会存储或上传任何内容。参见每日消息上限。

Pocket Alert 文档