Visão geral da Messaging API v2

A Messaging API v2 é um único endpoint REST/JSON para criar mensagens de saída em todos os canais que o Pushwoosh suporta:

Push: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
E-mail
SMS
Telegram, Kakao, LINE, WhatsApp

O Canal é selecionado pelo tipo de payload (payload para push / SMS / mensageiros, email_payload para e-mail).

O Direcionamento é selecionado pelo tipo de solicitação (segment para segmentos de público, transactional para listas explícitas de dispositivos ou usuários).

URL Base

https://api.pushwoosh.com

Se você usa uma região dedicada ou uma implantação privada, confirme a URL base exata com seu Gerente de Sucesso do Cliente Pushwoosh.

Autenticação

Cada solicitação deve incluir um cabeçalho Authorization com um token de acesso à API do Pushwoosh do lado do servidor:

Authorization: Token YOUR_API_TOKEN

Use o mesmo token que você já emite para chamadas de API de servidor para servidor. Não exponha este token em aplicativos cliente.

Métodos

Notify: POST /messaging/v2/notify. Cria e envia uma única mensagem (de segmento ou transacional).

Formato de solicitação e resposta

Tipo de conteúdo: application/json.
Nomes de campo usam snake_case. Grupos oneof aparecem como objetos aninhados com exatamente uma chave definida.
Valores de enumeração são serializados como seus nomes de string (por exemplo, "IOS", "MESSAGE_TYPE_MARKETING").
Respostas bem-sucedidas retornam HTTP 200 com um corpo JSON; erros usam o envelope de erro padrão do gRPC-Gateway — { "code": ..., "message": ..., "details": [...] }.

Início rápido

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "body": "Hello from v2!" },
              "android": { "body": "Hello from v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

Próximos passos

Notify

Referência de payload

Referência de payload de e-mail

Migração da v1