Перейти к содержимому

Создание с вложением POST Платный ​

Отправка push-уведомления с прикреплённым файлом изображения.

Платная функция

Этот эндпоинт доступен только на платных тарифах.

Эндпоинт ​

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
  }
}

Ответы с ошибками ​

СтатусОписание
401Unauthorized — неверный или отсутствующий токен
403Forbidden — функция доступна только на платном тарифе
400Bad Request — отсутствует title или message, либо файл не поддерживается
404Not Found — application_id или device_id не существует
429Достигнут дневной лимит — ничего не сохраняется и не загружается. См. Дневные лимиты сообщений.

Документация Pocket Alert