Envio de Push Notification via API
Endpoint utilizado para envio de Push Notification via API.
📘Tabela de Retornos
As chamadas à API irão retornar dois parâmetros. Um statusCode e statusDescription. A seguir, veja a lista de status suportados pela nossa API:
| statusCode | statusDescription |
|---|---|
| 1 | Mensagem entregue ao provedor com sucesso |
| 2 | Mensagem agendada com sucesso |
| 3 | O provedor retornou um erro ao tentar enviar a mensagem. |
| 4 | Ocorreu um erro, parâmetro {0} não informado. |
| 5 | Ocorreu um erro ,parâmetro {0} inválido. |
| 6 | Ocorreu um erro, chave de API do Google inválida. |
| 7 | Ocorreu um erro, certificado APNS não configurado. |
| 8 | Ocorreu um erro, chave de API não autorizada no GCM. |
| 10 | Ocorreu um erro, JSON inválido. |
| 99 | Ocorreu um erro inesperado. |
🚧 Identificador do Push
Ao enviar um Push, recomendamos que você utilize o parâmetro de retorno id. Ele serve como um identificador único de sua mensagem em nossa plataforma e pode ser utilizado para consulta de status ou mesmo para proteção contra envios duplicados.
Body Params
| Item | Tipo | Obrigatório ? |
|---|---|---|
| app_token | String | obrigatório |
| api_template_id | String | opcional |
| tags* | String | opcional |
| identifier** | String | obrigatório |
| phone_number** | Int | obrigatório |
*tags são opcionais porem devem ser cadastradas anteriormentes no dashboard, na tela de Push Notifications > API Templates e clique no botão "Nova API Template.
**identifier e phone_number são obrigatórios porem é necessario ter ao menos um dos itens, ou seja toda requisição deve ser passada ao menos com um deles ou ambos.