Documentação da API — Envio via JovEnvios Qrcode
Envie mensagens de texto, imagens, PDFs, boletos e PIX via WhatsApp usando instâncias conectadas pelo JovEnvios Qrcode. Ideal para integrações com ERPs, sistemas de cobrança (SGP e outros) e automações.
https://softpower.net.br/jov_whatsapp/api_v3/
JSON
Autenticação
Toda requisição precisa do seu clientToken, via header ou no corpo da requisição.
Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
{ "token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" }POST /mensagem
Envia texto livre, imagem, documento, boleto e/ou PIX para um número, através de uma instância conectada.
https://softpower.net.br/jov_whatsapp/api_v3/mensagem
| Campo | Tipo | Obrig. | Descrição |
|---|---|---|---|
connect | string | sim | Nome da instância conectada (JovEnvios Qrcode) |
phone | string | sim | Número com DDI, ex: 5511999998888 |
message | string | não | Texto principal da mensagem |
boleto_codigo | string | não | Linha digitável do boleto |
boleto_pdf_url | string | não | URL pública do PDF do boleto |
pix_copia_cola | string | não | Código PIX "copia e cola" (EMV) |
pix_qrcode_url | string | não | URL da imagem do QR Code do PIX — se omitido, é gerado automaticamente a partir do pix_copia_cola |
pix_mensagem | string | não | Texto explicativo customizado antes do código PIX — se omitido, usa o texto padrão (ver seção abaixo) |
nome_cliente, valor, vencimento | string | não | Dados adicionais da cobrança |
message, boleto_codigo ou pix_copia_cola precisa estar preenchido."connect": sua_instancia_aqui, "phone": 55XXXXXXXXXXX, "message": "Olá Nome Exemplo! Sua fatura de R$ XXX.XX vence em XX/XX/XXXX.", "boleto_codigo": XXXXX.XXXXX XXXXX.XXXXXX XXXXX.XXXXXX X XXXXXXXXXXXXXX, "boleto_pdf_url": "https://seusite.com.br/boletos/XXXXX.pdf", "pix_copia_cola": 000201XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX, "nome_cliente": Nome Exemplo, "valor": XXX.XX, "vencimento": XX/XX/XXXX
curl -s -X POST "https://softpower.net.br/jov_whatsapp/api_v3/mensagem" \
-H "Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" \
-H "Content-Type: application/json" \
-d '{
"connect": "sua_instancia_aqui",
"phone": "55XXXXXXXXXXX",
"message": "Olá Nome Exemplo! Sua fatura de R$ XXX.XX vence em XX/XX/XXXX.",
"boleto_codigo": "XXXXX.XXXXX XXXXX.XXXXXX XXXXX.XXXXXX X XXXXXXXXXXXXXX",
"pix_copia_cola": "000201XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"nome_cliente": "Nome Exemplo",
"valor": "XXX.XX",
"vencimento": "XX/XX/XXXX"
}'
{
"ok": true,
"ids": [4821, 4822, 4823, 4824, 4825],
"total_msgs": 5,
"token_envio": "XXXXXXXXXXXXXXXX",
"tipo": "multiplas",
"status": "fila",
"detalhes": [
{ "id": 4821, "tipo": "texto", "preview": "Olá Nome Exemplo!..." }
]
}
token_envio retornado para consultar o status real em GET /status.POST /sgp
Endpoint estruturado para integrações de cobrança (ex: SGP) — separa os dados em envio, controle_envio e cliente, permitindo escolher exatamente o que enviar em cada chamada.
https://softpower.net.br/jov_whatsapp/api_v3/sgp
| Campo (controle_envio) | Padrão | Efeito |
|---|---|---|
enviar_texto | true | Envia o texto de envio.text |
enviar_boleto_linha_digitavel | true | Envia texto explicativo + linha digitável do boleto |
enviar_boleto_url | true | Envia o PDF do boleto (envio.boleto.pdf_url) |
enviar_pix | true | Envia texto explicativo + código PIX copia-e-cola |
enviar_qrcode_pix | true | Envia a imagem do QR Code do PIX |
enviar_link_pagamento | false | Envia link de pagamento (envio.link_pagamento.url) |
controle_envio são opcionais — por padrão tudo que tiver dado preenchido é enviado, exceto enviar_link_pagamento (precisa ser ativado explicitamente).{
"token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"phone": "55XXXXXXXXXXX",
"connect": "sua_instancia_aqui",
"apiId": 4,
"message": {
"envio": {
"text": "Olá Nome Exemplo! Sua fatura de R$ XXX.XX vence em XX/XX/XXXX.",
"boleto": {
"linha_digitavel": "XXXXX.XXXXX XXXXX.XXXXXX XXXXX.XXXXXX X XXXXXXXXXXXXXX",
"pdf_url": "https://seusite.com.br/boletos/XXXXX.pdf"
},
"pix": {
"codigo_pix": "000201XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"imagem_qrcode": ""
}
},
"controle_envio": {
"enviar_texto": true,
"enviar_boleto_linha_digitavel": true,
"enviar_boleto_url": true,
"enviar_pix": true,
"enviar_qrcode_pix": true
},
"cliente": { "nome": "Nome Exemplo" }
}
}
curl -s -X POST "https://softpower.net.br/jov_whatsapp/api_v3/sgp" \
-H "Content-Type: application/json" \
-d '{"token":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","phone":"55XXXXXXXXXXX","connect":"sua_instancia_aqui","message":{"envio":{"text":"Olá Nome Exemplo!","pix":{"codigo_pix":"000201XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}},"controle_envio":{"enviar_pix":true}}}'
GET /status
Consulta o status atual de uma mensagem/grupo de mensagens pelo token_envio.
https://softpower.net.br/jov_whatsapp/api_v3/status?token_envio={TOKEN_ENVIO}
curl -s "https://softpower.net.br/jov_whatsapp/api_v3/status?token_envio=XXXXXXXXXXXXXXXX" \
-H "Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
{
"ok": true,
"id": 4821,
"status_envio": "Enviado",
"status_code": "200",
"status_wpp": "DELIVERY_ACK",
"phone": "55XXXXXXXXXXX",
"message_sent_on": "2026-07-16 14:32:07",
"created_at": "2026-07-16 14:31:58"
}
| status_envio | Significado |
|---|---|
Fila | Ainda aguardando o processamento (cron) enviar ao JovEnvios Qrcode |
Enviado | Confirmado como enviado pelo JovEnvios Qrcode |
Falha | Erro ao enviar — veja status_code para detalhes |
Textos padrão de PIX e Boleto
Quando você envia pix_copia_cola ou boleto_codigo sem um texto customizado, o sistema envia automaticamente um texto explicativo antes do código:
pix_mensagem no /mensagem.QR Code do PIX
Se você não enviar pix_qrcode_url, a imagem do QR Code é gerada automaticamente a partir do pix_copia_cola.
%20, senão a URL quebra. Se preferir, não envie pix_qrcode_url e deixe o sistema gerar automaticamente, já tratando isso.
https://quickchart.io/qr?size=400&text=000201XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Ordem de envio das mensagens
Quando vários conteúdos são informados na mesma chamada, são enviados nesta ordem, como mensagens separadas:
Códigos de retorno
| HTTP | Quando ocorre |
|---|---|
200 | Mensagem(ns) aceita(s) e colocada(s) na fila de envio |
400 | Campo obrigatório ausente (ex: phone, connect) ou nenhum conteúdo informado |
401 | Token ausente ou inválido |
403 | A instância informada não pertence a este cliente |
404 | token_envio não encontrado (GET /status) |
405 | Método HTTP incorreto (use POST nos endpoints de envio) |
500 | Erro interno ao registrar a mensagem |
{
"ok": false,
"message": "Campo \"phone\" é obrigatório."
}