Ir para o conteúdo

Criar com anexo POST Pago ​

Envie uma notificação push com um arquivo de imagem anexado.

Recurso pago

Este endpoint está disponível apenas nos planos pagos.

Endpoint ​

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

Autenticação ​

Obrigatório

Inclua um destes cabeçalhos na sua requisição:

  • Token: <your-api-key> — Obtenha em Chaves de API
  • Authorization: Bearer <jwt-token> — Do Login

Requisição ​

Cabeçalhos ​

CabeçalhoObrigatórioDescrição
Content-Type✅multipart/form-data
Token✅Sua chave de API

Parâmetros do corpo (multipart/form-data) ​

ParâmetroTipoObrigatórioDescrição
titlestring✅Título da notificação
messagestring✅Texto do corpo da notificação
application_idstring❌TID do aplicativo
device_idstring❌TID do dispositivo (omita para todos)
imagefile❌Imagem anexada (.png, .jpg, .jpeg, .gif)

Exemplo de requisição ​

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();

Resposta ​

Resposta de sucesso ​

201 Created

Mensagem com anexo criada com sucesso

CampoTipoDescrição
tidstringIdentificador único da mensagem
titlestringTítulo da mensagem
messagestringCorpo da mensagem
attachmentobjectDetalhes do anexo
attachment.tidstringIdentificador do anexo
attachment.file_namestringNome do arquivo armazenado
attachment.content_typestringTipo MIME
attachment.file_sizeintegerTamanho do arquivo em bytes
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
  }
}

Respostas de erro ​

StatusDescrição
401Não autorizado — token inválido ou ausente
403Proibido — o recurso exige plano pago
400Requisição inválida — title ou message ausente, ou arquivo não suportado
404Não encontrado — application_id ou device_id não existe
429Limite diário atingido — nada é armazenado ou enviado. Veja Limites diários de mensagens.

Documentação do Pocket Alert