{"info":{"_postman_id":"c0628315-dadc-42a3-aa02-fab0a2de3e9c","name":"API PARA INTEGRAÇÃO","description":"

API REST JSON Envios

\n

Permite a integração do WhatsApp com seu sistema de qualquer aplicação por meio de requisições POST/GET;

\n

Esta Api, segue os mesmos termos de serviço do WhatsApp. É importante que você leia atentamente a estes termos. Você é responsável pelo uso da ferramenta e pelas conseqüências do mau uso. A violação dos termos pode acarretar no bloqueio e banimento definitivo de sua conta no WhatsApp.

\n

It allows the integration of WhatsApp with any application through POST / GET requests;

\n

This Api follows the same terms of service as WhatsApp. It is important that you read these terms carefully. You are responsible for the use of the tool and for the consequences of misuse. Violation of the terms may result in the blocking and permanent banning of your WhatsApp account.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8253827","collectionId":"c0628315-dadc-42a3-aa02-fab0a2de3e9c","publishedId":"2s8479ywdv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"A60DA6"},"publishDate":"2022-10-14T18:31:00.000Z"},"item":[{"name":"Envios","item":[{"name":"Enviar template ID","id":"8802826e-4a26-493d-8e20-c5252a7337e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": 30,\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"id_template\": 14\r\n /*,\r\n \"variaveis\":[\r\n {\r\n \"@nome\":\"XXXXXXX\"\r\n }\r\n ]*/\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/index.php","description":"

enviar Texto

\n\n","urlObject":{"path":["sendmsg","index.php"],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"8802826e-4a26-493d-8e20-c5252a7337e7"},{"name":"Enviar texto","id":"fc21b8f9-734a-4ab1-8edd-34b408d6c71f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"0\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"text\": \"Teste de Envio\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar Texto

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc21b8f9-734a-4ab1-8edd-34b408d6c71f"},{"name":"Enviar imagem","id":"189cf18d-ba34-408c-bb95-594c1e8253dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"1\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"text\": \"Teste de Envio\",\r\n \"url_arquivo\": \"https://blog.sucuri.net/wp-content/uploads/2019/08/08062019-magento-skimmers-from-atob-alibaba_blog.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar Imagem

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"189cf18d-ba34-408c-bb95-594c1e8253dc"},{"name":"Enviar arquivo","id":"07dc34a4-be35-4819-b141-c0fae7f8af08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"2\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"filename\": \"none do arquivo\",\r\n \"url_arquivo\": \"https://eppg.fgv.br/sites/default/files/teste.pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar arquivo

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"07dc34a4-be35-4819-b141-c0fae7f8af08"},{"name":"Enviar audio","id":"e028060d-d460-4f50-a745-653019141b1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"3\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"url_arquivo\": \"https://www.learningcontainer.com/wp-content/uploads/2020/02/Kalimba.mp3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar audio

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"e028060d-d460-4f50-a745-653019141b1e"},{"name":"Enviar video","id":"70cbf63b-4d0e-474f-be9f-1fe09d6101a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"4\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"url_arquivo\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ForBiggerMeltdowns.mp4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar vídeo

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"70cbf63b-4d0e-474f-be9f-1fe09d6101a6"},{"name":"Enviar localização","id":"00069ca5-860c-4757-9a26-45a3d519f26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"5\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"lat\": -15.8413105,\r\n \"log\": -48.0270346,\r\n \"title\": \"Minha Clínica\",\r\n \"address\": \"Quadra 205 Lote 5 - Brasília-DF\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

enviar localização

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"00069ca5-860c-4757-9a26-45a3d519f26f"}],"id":"2855ad42-046c-41c1-853d-d27683e62f9b","_postman_id":"2855ad42-046c-41c1-853d-d27683e62f9b","description":""},{"name":"Webhook","item":[{"name":"Ao receber uma mensagem","item":[],"id":"2abddac0-7fb2-49e2-9973-1882424206c4","description":"

Ao receber uma mensagem a API enviará a seguinte informação:\n

\n
\n\n{\n  \"wook\": \"RECEIVE_MESSAGE\",\n  \"type\": \"image\",\n  \"id\": \"false_5521991977392@c.us_DBD9229B19E264CA4F69082B88897AD1\",\n  \"session\": \"1\",\n  \"isGroupMsg\": false,\n  \"author\": null,\n  \"phone\": \"5569984000685\",\n  \"content\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEABsbGxscGx4hIR4qLSgtKj04MzM4PV1CR0JHQl2NWGdYWGdYjX2Xe3N7l33gsJycsOD/2c7Z//////////////8BGxsbGxwbHiEhHiotKC0qPTgzMzg9XUJHQkdCXY1YZ1hYZ1iNfZd7c3uXfeCwnJyw4P/Zztn////////////////CABEIAEUASAMBIgACEQEDEQH/xAAuAAEAAwEBAQAAAAAAAAAAAAAAAgMEAQUGAQEBAQAAAAAAAAAAAAAAAAAAAQL/2gAMAwEAAhADEAAAAPpgY+a8skqrIHdldtAopM8bc8xfPP6CwsrzN7RYhMU4dcJmrRXcZt8Z2goDNwkqLqzuzLqAUDHETvAaxZg//8QAJxAAAgICAQMDBAMAAAAAAAAAAQIAAxESBBMgIRAiMRQVMkFjcYH/2gAIAQEAAT8A9LXvDnUZEW7kkgFIbLyHwP6nU5Z+Ei2cknysUnHnsb9YIjLYHOjjzK1vBOzCBeRny4xONsAdmB7HsSvGxl/TazBdh4hShhkWH2w0i7V1c4xBwv5DKOL0mzuey4B2Chcx1KkdVQROUqIFRB+UW3BWkf6Yr1rgbS60KhwZxGuYkt8etivsChxGruI8kS6spfXmYpSxvdiM3GGA0ccdx+cqUKgx2WNetnsXxLGt3AFYMYOVDGobZiIrrmxRmdCgEYXuai/yd4aLSijeGuweNzKls3BLHtbmpVbprPuKjPtOIvPRzWB8tPrqwTlDF5te6KB5IlNotBIHZZxFewuTPok+Cxx+hK+FXWwYQ8JSTliRBwawQcnIlaaAj0//xAAUEQEAAAAAAAAAAAAAAAAAAABA/9oACAECAQE/AE//xAAZEQEAAwEBAAAAAAAAAAAAAAABABARISD/2gAIAQMBAT8AstcFgjA49LTZkDxzxky//9k=\",\n  \"caption\": \"\",\n  \"file\": \"40f66a02f9e7efe3a4a939fd7ba7ee80.jpeg\",\n  \"status\": \"RECEIVED\",\n  \"timestamp\": 1615310701\n}\n\n
\n
\nArquivos Recebido\nTodos os arquivos recebidos no parâmetro (file:) estão acessíveis através da URL/ de sua API\n
\n\n

type
\ntext / image / video / audio / document / link / vcard / location / ptt / sticker\n
\n

\n","_postman_id":"2abddac0-7fb2-49e2-9973-1882424206c4"},{"name":"Confirmações","item":[],"id":"354a9f95-095d-4ea6-b159-5dab8d7b4642","description":"

Quando for enviado uma mensagem e a mesma for recebida pelo destinatário você receberá uma confirmação:

\n
\n\n{\n  \"wook\": \"MESSAGE_STATUS\",\n  \"status:\": \"RECEIVED\",\n  \"id\": \"true_556181590153@c.us_C3107E3BF0E41BCA40EC0BAF8BF2D74C\",\n  \"session\": \"1\",\n  \"phone\": \"5569984000685\",\n  \"content\": \"Oi\",\n  \"timestamp\": 1615310561,\n  \"type\": \"text\"\n}\n\n
\n
\nStatus

\n\n

SENT
\nQuando a mensagem é enviada esse parâmetro e retornado

\n

RECEIVED
\nQuando a mensagem e recebida esse parâmetro e retornado\n

\n

READ
\nQuando a mensagem é lida esse parâmetro e retornado\n

\n

FAILED
\nQuando ocorre falha esse parâmetro e retornado

\n","_postman_id":"354a9f95-095d-4ea6-b159-5dab8d7b4642"}],"id":"635ca1bc-3aed-4ae2-b74c-458bdfe50a4e","description":"

Os Webhooks são muito usados para receber em tempo real as mensagens recebidas pela API, mas para ativar essa funcionalidade você deve deve ativar nas configuração do Canal a URL de retorno.

\n","_postman_id":"635ca1bc-3aed-4ae2-b74c-458bdfe50a4e"},{"name":"Requisições","item":[{"name":"Verificar Numero Válido","id":"2d1b7098-09e4-4698-810d-30a4a6d3117b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"20\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

Testar numero

\n

StartFragment

\n\n

EndFragme

\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d1b7098-09e4-4698-810d-30a4a6d3117b"},{"name":"Baixar anexo por ID","id":"30b8c608-edcd-4641-b2a1-a18397605d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"21\",\r\n \"token\": \"SEU-TOKEN\",\r\n \"numero\": \"555190198485\",\r\n \"idmsg\": \"234JN423JH4JSF456\",\r\n \"mimetype\":\"pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/sendmsg/","description":"

Baixar anexo por ID

\n\n","urlObject":{"path":["sendmsg",""],"host":["https://SEU-DOMINIO"],"query":[],"variable":[]}},"response":[],"_postman_id":"30b8c608-edcd-4641-b2a1-a18397605d5a"},{"name":"Buscar ID da msg do whatsApp","id":"0918c6b0-b0ff-43da-a872-7c81cd29ef1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"buscar\": \"id\",\r\n \"session\": \"201\",\r\n \"protocolo\": \"2017495311041335\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://SEU-DOMINIO/webhook_wh_APIMQ/?token=58f12f96d957b6182dea0aeece012a2a","urlObject":{"path":["webhook_wh_APIMQ",""],"host":["https://SEU-DOMINIO"],"query":[{"key":"token","value":"58f12f96d957b6182dea0aeece012a2a"}],"variable":[]}},"response":[],"_postman_id":"0918c6b0-b0ff-43da-a872-7c81cd29ef1a"}],"id":"1efe23f6-92b3-48ce-b8d0-77e884d7850b","_postman_id":"1efe23f6-92b3-48ce-b8d0-77e884d7850b","description":""}],"event":[{"listen":"prerequest","script":{"id":"2c300c40-8598-4fb0-b109-20c82d7d9b11","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ae337a56-eb4c-41fb-a781-f7d42184ca33","type":"text/javascript","exec":[""]}}],"variable":[{"key":"URL","value":"https://SEU-DOMINIO","type":"string"},{"key":"TOKEN","value":"SEU-TOKEN","type":"string"},{"key":"CEL","value":"555190198485","type":"string"}]}