{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/message/","auth":"required","examples":{"codes":[{"language":"json","code":"{\n\t\"sendPushRequest\": {\n\t\t\"app_token\": \"SEU_APP_TOKEN\",\n\t\t\"identifier\": \"IDENTIFIER_DO_SEU_USUARIO\",\n    \"title\": \"TITULO_DA_NOTIFICACAO\",\n\t\t\"message\": \"CONTEUDO_DA_NOTIFICACAO\"\n\t}\n}"}]},"method":"post","params":[{"name":"app_token","type":"string","default":"","desc":"Token de acesso do aplicativo","required":true,"in":"body","ref":"","_id":"57241e23eae5090e00ee624f"},{"name":"identifier","type":"string","default":"","desc":"Identificador do usuário que receberá o Push. Informe **all** para enviar a mensagem para todos os assinantes.","required":true,"in":"body","ref":"","_id":"57241e23eae5090e00ee624e"},{"name":"title","type":"string","default":"","desc":"Título do notificação a ser exibida no dispositivo do usuário","required":false,"in":"body","ref":"","_id":"57241e23eae5090e00ee624d"},{"name":"message","type":"string","default":"","desc":"Conteúdo da notificação a ser enviado","required":true,"in":"body","ref":"","_id":"57241e23eae5090e00ee624c"},{"name":"schedule","type":"datetime","default":"","desc":"Data e hora em que a mensagem será enviada (YYYY-MM-DDThh:mm:ss)","required":false,"in":"body","ref":"","_id":"57242455d872170e004c1aa3"},{"name":"url","type":"string","default":"","desc":"URL a ser aberta pelo Push (formato: http://www.google.com.br)","required":false,"in":"body","ref":"","_id":"578c16f37857db17000f0056"},{"name":"additional_data","type":"array_object","default":"","desc":"Conjunto de dados adicionais a serem recebidos pelo app. Exemplo: \"additional_data\": { \t\t\t\"action\": \"service\", \t\t\t\"id\": \"1\", \t\t\t\"window\": \"main\" \t\t}","required":false,"in":"body","ref":"","_id":"57b5191ed3092517007cfaaf"},{"name":"audiences","type":"array_string","default":"","desc":"ID da audiência, \"audiences\": [\"124\"]","required":false,"in":"body","ref":"","_id":"586c0d9550fe5a0f004ab7be"}],"results":{"codes":[{"status":200,"name":"","code":"{\n\t\"sendPushResponse\": {\n\t\t\"statusCode\": \"1\"\n\t\t\"statusDescription\": \"Mensagem entregue ao provedor com sucesso.\"\n\t\t\"id\": \"100\"\n\t}\n}","language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"/message (enviar push)","type":"endpoint","slug":"message","excerpt":"Envio de Push Notification via API","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Tabela de Retornos\",\n  \"body\": \"As chamadas à API irão retornar dois parâmetros. Um **statusCode** e **statusDescription**. A seguir, veja a lista de status suportados pela nossa API:\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"statusCode\",\n    \"h-1\": \"statusDescription\",\n    \"0-0\": \"<span style=\\\"margin:auto; display:table;\\\">1</span>\",\n    \"0-1\": \"Mensagem entregue ao provedor com **sucesso**\",\n    \"1-0\": \"<span style=\\\"margin:auto; display:table;\\\">2</span>\",\n    \"1-1\": \"Mensagem agendada com **sucesso**\",\n    \"2-0\": \"<span style=\\\"margin:auto; display:table;\\\">3</span>\",\n    \"2-1\": \"O provedor retornou um **erro** ao tentar enviar a mensagem.\",\n    \"3-0\": \"<span style=\\\"margin:auto; display:table;\\\">4</span>\",\n    \"3-1\": \"Ocorreu um **erro**, parâmetro {0} não informado.\",\n    \"4-0\": \"<span style=\\\"margin:auto; display:table;\\\">5</span>\",\n    \"4-1\": \"Ocorreu um **erro** ,parâmetro {0} inválido.\",\n    \"5-0\": \"<span style=\\\"margin:auto; display:table;\\\">6</span>\",\n    \"5-1\": \"Ocorreu um **erro**, chave de API do Google inválida.\",\n    \"6-0\": \"<span style=\\\"margin:auto; display:table;\\\">7</span>\",\n    \"6-1\": \"Ocorreu um **erro**, certificado APNS não configurado.\",\n    \"7-1\": \"Ocorreu um erro, chave de API não autorizada no GCM.\",\n    \"7-0\": \"<span style=\\\"margin:auto; display:table;\\\">8</span>\",\n    \"8-0\": \"<span style=\\\"margin:auto; display:table;\\\">10</span>\",\n    \"8-1\": \"Ocorreu um erro, JSON inválido.\",\n    \"9-0\": \"<span style=\\\"margin:auto; display:table;\\\">99</span>\",\n    \"9-1\": \"Ocorreu um erro inesperado.\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"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.\",\n  \"title\": \"Identificador do Push\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57241e23eae5090e00ee624b","parentDoc":null,"user":"57240d9f110e570e00486ca0","createdAt":"2016-04-30T02:53:23.016Z","editedParams2":true,"project":"57240e292887bb0e00bb9d93","__v":5,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"(Notificações) API REST","slug":"notificações","order":9,"from_sync":false,"reference":false,"_id":"5f984feb8aed05003a0032dc","createdAt":"2020-10-27T16:50:51.031Z","version":"57240e292887bb0e00bb9d96","project":"57240e292887bb0e00bb9d93","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["57240e292887bb0e00bb9d97","57241b7deae5090e00ee6249","57241c06eae5090e00ee624a","57242abb2ad0bc170012279b","5734d18c7b9859320047f4b1","57688cc71f818b0e00695efb","577ead2ca74eb40e00d97bca","57b66af649a12a0e007b461b","597e5f8f13505b0014251a79","59964eb2f824b4000f961fbe","5a15ab12f2643f001ee8737c","5ab1151799750500797334e0","5c597e8b0abe110014bf1a11","5e395a05470bc3002d78d886","5e42a9647515f300509a594d","5f5e716dcc85f9004a4fa193","5f6dd615c624d800180bd237","5f984feb8aed05003a0032dc","60ac0e9c4c04970016613c6c"],"_id":"57240e292887bb0e00bb9d96","createdAt":"2016-04-30T01:45:13.341Z","project":"57240e292887bb0e00bb9d93","releaseDate":"2016-04-30T01:45:13.341Z","__v":19},"editedParams":true,"githubsync":""}

post/message (enviar push)

Envio de Push Notification via API

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

app_token:
required
string
Token de acesso do aplicativo
identifier:
required
string
Identificador do usuário que receberá o Push. Informe **all** para enviar a mensagem para todos os assinantes.
title:
string
Título do notificação a ser exibida no dispositivo do usuário
message:
required
string
Conteúdo da notificação a ser enviado
schedule:
datetime
Data e hora em que a mensagem será enviada (YYYY-MM-DDThh:mm:ss)
url:
string
URL a ser aberta pelo Push (formato: http://www.google.com.br)
additional_data:
array of objects
Conjunto de dados adicionais a serem recebidos pelo app. Exemplo: "additional_data": { "action": "service", "id": "1", "window": "main" }
audiences:
array of strings
ID da audiência, "audiences": ["124"]

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Tabela de Retornos", "body": "As chamadas à API irão retornar dois parâmetros. Um **statusCode** e **statusDescription**. A seguir, veja a lista de status suportados pela nossa API:" } [/block] [block:parameters] { "data": { "h-0": "statusCode", "h-1": "statusDescription", "0-0": "<span style=\"margin:auto; display:table;\">1</span>", "0-1": "Mensagem entregue ao provedor com **sucesso**", "1-0": "<span style=\"margin:auto; display:table;\">2</span>", "1-1": "Mensagem agendada com **sucesso**", "2-0": "<span style=\"margin:auto; display:table;\">3</span>", "2-1": "O provedor retornou um **erro** ao tentar enviar a mensagem.", "3-0": "<span style=\"margin:auto; display:table;\">4</span>", "3-1": "Ocorreu um **erro**, parâmetro {0} não informado.", "4-0": "<span style=\"margin:auto; display:table;\">5</span>", "4-1": "Ocorreu um **erro** ,parâmetro {0} inválido.", "5-0": "<span style=\"margin:auto; display:table;\">6</span>", "5-1": "Ocorreu um **erro**, chave de API do Google inválida.", "6-0": "<span style=\"margin:auto; display:table;\">7</span>", "6-1": "Ocorreu um **erro**, certificado APNS não configurado.", "7-1": "Ocorreu um erro, chave de API não autorizada no GCM.", "7-0": "<span style=\"margin:auto; display:table;\">8</span>", "8-0": "<span style=\"margin:auto; display:table;\">10</span>", "8-1": "Ocorreu um erro, JSON inválido.", "9-0": "<span style=\"margin:auto; display:table;\">99</span>", "9-1": "Ocorreu um erro inesperado." }, "cols": 2, "rows": 10 } [/block] [block:callout] { "type": "warning", "body": "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.", "title": "Identificador do Push" } [/block]