添付ファイル付きで作成 POST 有料
画像ファイルを添付したプッシュ通知を送信します。
有料機能
このエンドポイントは有料プランでのみ利用できます。
エンドポイント
POST https://api.pocketalert.app/v1/messages認証
必須
リクエストには次のヘッダーのいずれかを含めてください:
リクエスト
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Content-Type | ✅ | multipart/form-data |
Token | ✅ | API キー |
ボディパラメータ (multipart/form-data)
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
title | string | ✅ | 通知のタイトル |
message | string | ✅ | 通知の本文 |
application_id | string | ❌ | アプリケーションの TID |
device_id | string | ❌ | デバイスの TID (省略するとすべてのデバイスに送信) |
image | file | ❌ | 添付する画像 (.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
添付ファイル付きのメッセージが正常に作成されました
| フィールド | 型 | 説明 |
|---|---|---|
tid | string | メッセージの一意の識別子 |
title | string | メッセージのタイトル |
message | string | メッセージの本文 |
attachment | object | 添付ファイルの詳細 |
attachment.tid | string | 添付ファイルの識別子 |
attachment.file_name | string | 保存されたファイル名 |
attachment.content_type | string | MIME タイプ |
attachment.file_size | integer | ファイルサイズ (バイト) |
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 | 1 日の上限に達しました — 何も保存もアップロードもされません。1 日のメッセージ上限をご覧ください。 |