{"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\"api_template_id\": \"62\",\n\t\t\"tags\": {\n\t\t\t\"valor\": [\"10,00\"],\n\t\t\t\"estabelecimento\": [\"Supermecado X\"],\n\t\t\t\"status\": [\"aprovada\"]\n\t\t},\n\t\t\"identifier\": [\"IDENTIFICADO_DO_SEU_USUÁRIO\"]\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":"api_template_id","type":"int","default":"","desc":"ID do template gerado. Este valor será retornado após o cadastramento do template na plataforma","required":true,"in":"body","ref":"","_id":"57241e23eae5090e00ee624c"},{"name":"tags","type":"array_string","default":"","desc":"Conjunto de campos chave que serão substituídos pelo conteúdo informado","required":false,"in":"body","ref":"","_id":"57b5191ed3092517007cfaaf"},{"name":"identifier","type":"string","default":"","desc":"Identificador do usuário que receberá o Push. Informe **all** para enviar a mensagem para todos os assinantes ativos.","required":true,"in":"body","ref":"","_id":"57241e23eae5090e00ee624e"},{"name":"Content-Type","type":"string","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"594ec956587e95001bdb2e29"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"sendPushResponse\": {\n\t\t\"statusCode\": \"1\",\n\t\t\"statusDescription\": \"Mensagem entregue ao provedor APNS com sucesso\",\n\t\t\"id\": \"168419\"\n\t}\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"/message (templates)","type":"endpoint","slug":"api-template","excerpt":"Envio de mensagens utilizando API Templates. Este recurso permitirá a troca de campos chave pelo conteúdo informado, promovendo maior flexibilidade e desacoplamento da integração.","body":"[block:api-header]\n{\n  \"title\": \"Cadastrando um novo template\"\n}\n[/block]\nO cadastro de um template pode ser feito pelo nosso dashboard. Veja a seguir como é simples criar um novo template:\n1. Inicialmente acesse **Push Notifications** > **API Templates** e clique no botão \"Nova API Template\".\n2. Defina o nome do template e opcionalmente uma descrição para o mesmo.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2033157-API_Template01.png\",\n        \"API_Template01.png\",\n        1632,\n        428,\n        \"#e7f0f0\"\n      ],\n      \"caption\": \"Dados básicos do template\"\n    }\n  ]\n}\n[/block]\n3. Defina os campos chave que terão os seus valores definidos durante a chamada da API.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e5de203-Template_02.png\",\n        \"Template_02.png\",\n        1632,\n        622,\n        \"#f0f4f4\"\n      ],\n      \"caption\": \"Campos chave da mensagem\"\n    }\n  ]\n}\n[/block]\n4. Defina o título e a mensagem do template. Os campos chave definidos no passo anterior devem ficar entre **{{** e **}}**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e6360f3-Template_03.png\",\n        \"Template_03.png\",\n        1646,\n        634,\n        \"#eef4f4\"\n      ],\n      \"caption\": \"Título e mensagem do template\"\n    }\n  ]\n}\n[/block]\nPara simplificar o apontamento de um campo chave, basta clicar no seguinte botão: \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2dc4bba-Template04.png\",\n        \"Template04.png\",\n        300,\n        342,\n        \"#e7ecec\"\n      ],\n      \"sizing\": \"smart\",\n      \"caption\": \"Botão para seleção de campos chave\"\n    }\n  ]\n}\n[/block]\n5. Clicando no botão \"Gerar código\" o template será salvo e o *request body* para a chamada da API será gerado.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d0b5577-Template_05.png\",\n        \"Template_05.png\",\n        1746,\n        1068,\n        \"#3e8ac1\"\n      ]\n    }\n  ]\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"586fdd5405fce30f00513d0a","createdAt":"2017-01-06T18:09:24.816Z","parentDoc":null,"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},"user":"5724b9982ad0bc17001227fa","__v":2,"githubsync":"","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},"project":"57240e292887bb0e00bb9d93"}

post/message (templates)

Envio de mensagens utilizando API Templates. Este recurso permitirá a troca de campos chave pelo conteúdo informado, promovendo maior flexibilidade e desacoplamento da integração.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

app_token:
required
string
Token de acesso do aplicativo
api_template_id:
required
integer
ID do template gerado. Este valor será retornado após o cadastramento do template na plataforma
tags:
array of strings
Conjunto de campos chave que serão substituídos pelo conteúdo informado
identifier:
required
string
Identificador do usuário que receberá o Push. Informe **all** para enviar a mensagem para todos os assinantes ativos.

Headers

Content-Type:
stringapplication/json

Examples


Result Format


Documentation

[block:api-header] { "title": "Cadastrando um novo template" } [/block] O cadastro de um template pode ser feito pelo nosso dashboard. Veja a seguir como é simples criar um novo template: 1. Inicialmente acesse **Push Notifications** > **API Templates** e clique no botão "Nova API Template". 2. Defina o nome do template e opcionalmente uma descrição para o mesmo. [block:image] { "images": [ { "image": [ "https://files.readme.io/2033157-API_Template01.png", "API_Template01.png", 1632, 428, "#e7f0f0" ], "caption": "Dados básicos do template" } ] } [/block] 3. Defina os campos chave que terão os seus valores definidos durante a chamada da API. [block:image] { "images": [ { "image": [ "https://files.readme.io/e5de203-Template_02.png", "Template_02.png", 1632, 622, "#f0f4f4" ], "caption": "Campos chave da mensagem" } ] } [/block] 4. Defina o título e a mensagem do template. Os campos chave definidos no passo anterior devem ficar entre **{{** e **}}**. [block:image] { "images": [ { "image": [ "https://files.readme.io/e6360f3-Template_03.png", "Template_03.png", 1646, 634, "#eef4f4" ], "caption": "Título e mensagem do template" } ] } [/block] Para simplificar o apontamento de um campo chave, basta clicar no seguinte botão: [block:image] { "images": [ { "image": [ "https://files.readme.io/2dc4bba-Template04.png", "Template04.png", 300, 342, "#e7ecec" ], "sizing": "smart", "caption": "Botão para seleção de campos chave" } ] } [/block] 5. Clicando no botão "Gerar código" o template será salvo e o *request body* para a chamada da API será gerado. [block:image] { "images": [ { "image": [ "https://files.readme.io/d0b5577-Template_05.png", "Template_05.png", 1746, 1068, "#3e8ac1" ] } ] } [/block]