{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"996361a9-16f3-466f-8b9b-d191dc91f367","name":"Uzapi - Documentação da API","description":"A Uzapi é uma solução que permite você integrar qualquer aplicação com seu WhatsApp por meio de uma API robusta.\n\n# Conectando seu WhatsApp na API\n\nAo acessar o painel da Uzapi, você deverá informar os seguintes dados de conexão:\n\n---\n\nSession: um nome qualquer para identificar qual whatsapp você está conectando. Use nomes curtos, tudo minúsculo, sem espaços e sem acentos. Ex: empresa1\n\n---\n\nSessionKey: pode ser o mesmo nome da session. Use nomes curtos, tudo minúsculo, sem espaços e sem acentos Ex: empresa1\n\n---\n\nToken: código único que permite estabelecer a conexão com a API (ele é fornecido ao usuário da uZapi após aquisição da API).\n\n---\n\nWebhooks (Opcional): informar as urls que irão receber as respostas da API para cada um desses eventos: Mensagens Enviadas, Mensagens Recebidas, Status da Conexão e Exibição do QR Code. Você pode obter uma URL de Webhook no site [https://webhook.site](https://webhook.site) e usá-la nos 4 eventos.\n\nApós fornecer os dados acima, basta clicar no botão Conectar e aguardar a exibição do QR Code. Ao ler o QR Code, aguardar a alteração do Status para Conectado.\n\nA partir de então, já será possível usar o formulário de teste de envios para assegurar que seu WhatsApp está devidamente conectado à API.\n\n# Observações\n\n1 - A API pode ser testada gratuitamente através do link: [https://uzapi.com.br](https://uzapi.com.br)\n\n---\n\n2 - Para utilizar a API no webhook da versão 2.X do Mautic, deverá substituir o arquivo app/bundles/WebhookBundle/Helper/CampaignHelper.php por esse aqui: [https://raw.githubusercontent.com/ericabouaf/mautic/c8c1684cc75e473be4a6d2b9871fd1726a0ae644/app/bundles/WebhookBundle/Helper/CampaignHelper.php](https://raw.githubusercontent.com/ericabouaf/mautic/c8c1684cc75e473be4a6d2b9871fd1726a0ae644/app/bundles/WebhookBundle/Helper/CampaignHelper.php3)\n\n---\n\n3 - Para quebra de linha no texto, utilizar % 0 A (tudo junto) ou \\\\n.\n\n---\n\n4 - Ao mencionar um número de Whatsapp nos parâmetros da API, o mesmo deverá estar em um desses formatos:  \n**Contato**  \n5521989848442 (com dígito 9)  \n552189848442 (sem dígito 9)  \n+5521989848442 (DDI com sinal de mais)  \n55 21 989848442 (DDI e DDD com espaços)  \n**Grupo**  \n5521989848442-1621295826 (WhatsApp do admin + ID do grupo).\n\n---\n\n5 - Em casos que a API não consegue se reconectar, o usuário recebe uma notificação por e-mail solicitando uma nova conexão.\n\n---\n\n6 - A API possui um delay fico de 5 segundos entre os envios de mensagens. Porém, o usuário pode aumentar esse delay de envio pelo n8n, acrescentando segundos a mais usando no node Split In Batches com o node Wait.\n\n---\n\n7 - Em alguns casos, o **N8N** pode apresentar um erro desconhecido durante a execução de um node **Http Request** (com os parâmetros da API). Geralmente é um erro com os dizeres **Socket Hang Up** ou **ECONNRESET**.  \nPara resolver este erro, basta realizar uma das ações:  \n• Verificar se o endpoint da API está com **http**, se sim, deve-se alterar para **https**.  \n• Verificar seu o número (number) de WhatsApp está no formato Number. Se tiver, tem que colocá-lo no formato String (com aspas).  \n• Excluir e criar novamente o node Http Request e inserir novamente os parâmetros da API.\n\n---\n\n8 - A API só consegue enviar vídeos de **até 16MB,** que é o tamanho máximo permitido pelo WhatsApp Web.\n\n---\n\n9 - As URLs para envio de arquivos **não podem conter caracteres especiais**. Procure nomear os arquivos sem esses caracteres.  \n**Ex:** Ao invés de **áudio-superação.mp3**, use **audio-superacao.mp3**\n\n---\n\n10 - WhatsApp com histórico grande de conversas ou muitas requsições à Uzapi no mesmo segundo podem ocasionar timeout na API. Procure excluir algumas conversas no WhatsApp e/ou colocar delay entre os envios (principalmente se for de arquivos). Em caso de timeout da API, deve-se clicar no botão Desconectar no painel da Uzapi e excluir todas as sessões **uzapi** do dispositivo (aparelhos conectados).\n\n---\n\n11 - Os endpoints **/sendList** e **/sendButton** pode não funcionar caso o número conectado esteja logado no WhatsApp Web.\n\n---\n\n12 - Para conexão **a partir do segundo número**, é necessário acessar o painel de conexão da Uzapi em uma **nova janela anônima** do navegador.\n\n---\n\n13 - O uso constante de webhooks (principalmente de urls inexistentes) por causar **timeout na API**. Use essa opção com moderação e somente se necessário para a automação.\n\n---\n\n14 - Outra causa comum de timeout são as **constantes sincronização de mensagens** ao abrir o app do WhatsApp com frequência. Nesse caso, é aconselhável **diminuir a frequência do uso do app ou então limpar conversas antigas** para tornar as sincronizações mais \"leves\", evitando o \"crash\" do whatsapp web (usado pela sessão na Uzapi).\n\n# Erros\n\n400 - parâmetro ou valor inválido.\n\n401 - session/sessionkey incorreto (não existe ou desconectado).\n\n404 - endpoint/comando incorreto.\n\n500 - erro do servidor (entrar em contato com o suporte)\n\nERR_INVALID_ARG_TYPE - Erro de SSL (Habilitar o option Ignore SSL Issues no N8N)\n\n# Payload (Webhook)\n\nConfira o payload dos principais eventos da Uzapi:\n\n- **Mensagem Enviada**\n    \n\nwook:MESSAGE_STATUS  \nstatus:RECEIVED  \nid:[true_5521989848442@c.us_AC78E6A1AADCE1B7574F08977275C7CC](https://mailto:true_5521989848442@c.us_AC78E6A1AADCE1B7574F08977275C7CC)  \nsession:uzapi  \nphone:5521988888888  \ncontent:Oi  \ntimestamp:1764387586  \ntype:text\n\n- **Mensagem Recebida**\n    \n\nwook:RECEIVE_MESSAGE  \ntype:text  \nid:[false_5521989848442@c.us_A59021A4597427AD7FC18F255E39F542](https://mailto:false_5521989848442@c.us_A59021A4597427AD7FC18F255E39F542)  \nsession:uzapi  \nisGroupMsg:false  \nname:Autotic  \nauthor:null  \nphone:5521988888888  \nsender:5521977777777  \ncontent:Olá  \nstatus:RECEIVED  \ndatetime:29-11-2025 00:58:08\n\n- **Status da Conexão**\n    \n\nwook:STATUS_CONNECT  \nresult:200  \nsession:uzapi  \nstatus:desconnectedMobile  \nnumber:null  \nbrowserless:null  \ntokens:\\[empty array\\]\n\n- **Exibição do QRCode**\n    \n\nwook:QRCODE  \nresult:200  \nsession:uzapi  \nqrcode:data:image/png;base64,hash-base64\n\n# Changelog\n\nA Uzapi utiliza versionamento semântico (X.Y.Z) para indicar as mudanças ocorridas em cada versão, onde:\n\n**X = Mudanças significativas na estrutura do código-fonte.**  \n**Y = Inclusão de novas funcionalidades.**  \n**Z = Correção de bugs e melhorias referente à desemepenho ou usabilidade.**\n\n| **Versão 1.3.1 - 06/03/2026** |\n| --- |\n| Correção da exibição do QRCode \n\n| **Versão 1.3.0 - 05/01/2026** |\n| --- |\n| Correção na reprodução de áudio no app do WhatsApp do Android. |\n\n| **Versão 1.2.9 - 28/12/2025** |\n| --- |\n| Atualização automática de versão. |\n\n| **Versão 1.2.8 - 09/11/2025** |\n| --- |\n| Tratamento do @lid para exibição do phone number no payload do webhook |\n\n| **Versão 1.2.7 - 24/11/2025** |\n| --- |\n| Correção de envio de mensagens |\n\n| **Versão 1.2.6 - 20/10/2025** |\n| --- |\n| Correção de envio de mensagens |\n\n| **Versão 1.2.5 - 06/10/2025** |\n| --- |\n| Correção de envio de mensagens |\n\n| **Versão 1.2.4 - 02/09/2025** |\n| --- |\n| Correção de envio de mensagens |\n\n| **Versão 1.2.3 - 26/03/2025** |\n| --- |\n| Correção de envio de mensagens |\n\n| **Versão 1.2.2 - 02/12/2024** |\n| --- |\n| Correção da exibição do QRCode |\n\n| **Versão 1.2.1 - 30/10/2024** |\n| --- |\n| Correção da exibição do QRCode |\n\n| **Versão 1.2.0 - 07/07/2024** |\n| --- |\n| Correção da exibição do base64 da imagem (webhook) |\n| Melhoria na estabilidade de conexão |\n| Formatação da data/hora de recebimento das mensagens (webhook e endpoints) |\n| Correção do endpoint de listagem de grupos |\n| Inclusão de Blacklist |\n| Inclusão do menu Disparador |\n\n| **Versão 1.1.2 - 28/06/2024** |\n| --- |\n| Correção da exibição do QRCode |\n\n| **Versão 1.1.1 - 26/05/2024** |\n| --- |\n| Correção da exibição do QRCode |\n| Correção no Tratamento do timeout |\n| Correção no Tratamento de alto consumo de RAM |\n| Formatação da session e sessionkey no painel de conexão |\n| Ocultação da versão da API no painel de conexão |\n\n| **Versão 1.1.0 - 01/03/2024** |\n| --- |\n| Tratamento do timeout |\n| Correção do envio de vídeo |\n\n| **Versão 1.0.1 - 28/01/2024** |\n| --- |\n| Correção da exibição do QRCode |\n\n| **Versão 1.0.0 - 03/11/2023** |\n| --- |\n| Primeira versão |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"131526","team":2467090,"collectionId":"996361a9-16f3-466f-8b9b-d191dc91f367","publishedId":"U16hsmcg","public":true,"publicUrl":"https://documenter-api.postman.tech/view/131526/U16hsmcg","privateUrl":"https://go.postman.co/documentation/131526-996361a9-16f3-466f-8b9b-d191dc91f367","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"28504F"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-08-21T19:02:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f5d96e71480c398f966f61678e19fc23ce85dae798d8f85ec75f02304cabc278","favicon":"https://res.cloudinary.com/postman/image/upload/v1661038448/team/jj9vnsi5vy1eio8hbv7b.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/U16hsmcg"}