Hosteg WhatsApp API — Documentação

Autenticação

Todas as requisições precisam de um token de API gerado no painel Hosteg.

Headers obrigatórios

X-Api-Token: seu_token_aqui
X-Domain:    meusite.com.br
Content-Type: application/json

ℹ️ Sobre o X-Domain: deve coincidir exatamente com o domínio cadastrado no token. Tokens são vinculados a um domínio e a uma instância WhatsApp específica.

Precisa de um token?

Crie sua conta gratuita e gere tokens de API no painel Hosteg.

🔑 Gerar token →

Enviar mensagem

Envia uma mensagem de texto ou mídia para um número WhatsApp. O envio é assíncrono — a mensagem é enfileirada e entregue em seguida.

POST /v1/send Enviar texto ou mídia

Exemplo — mensagem de texto:

POST https://core.hosteg.api.br/v1/send
X-Api-Token: seu_token_aqui
X-Domain:    meusite.com.br
Content-Type: application/json

{
  "phone":        "5511999999999",
  "message":      "Olá! Seu pedido foi confirmado. 🎉",
  "trigger_type": "woocommerce"
}

Exemplo — com mídia (imagem, vídeo, documento):

{
  "phone":      "5511999999999",
  "message":    "Segue seu comprovante de pagamento:",
  "media_url":  "https://meusite.com.br/comprovante.pdf",
  "media_type": "document",
  "caption":    "Comprovante - Pedido #1234"
}

Resposta de sucesso (202):

{
  "success": true,
  "queued":  true,
  "job_id":  "42",
  "log_id":  "uuid-do-log"
}

Parâmetro	Tipo	Obrig.	Descrição
phone	string	sim	Número com DDI, apenas dígitos. Ex: `5511999999999`
message	string	sim	Texto da mensagem. Suporta negrito, _itálico_, ~tachado~
trigger_type	string	não	Identificador do evento para filtros e logs (ex: `woocommerce`, `cf7`)
media_url	string	não	URL pública da mídia a ser enviada
media_type	string	não	`image` \| `video` \| `audio` \| `document`
caption	string	não	Legenda da mídia

Validar token

Verifica se o token é válido e retorna informações sobre a instância WhatsApp vinculada.

POST /v1/validate Verificar autenticidade do token

POST https://core.hosteg.api.br/v1/validate
X-Api-Token: seu_token_aqui
X-Domain:    meusite.com.br
Content-Type: application/json

{}

Resposta:

{
  "success": true,
  "whatsapp": {
    "connected":   true,
    "status":      "connected",
    "profileName": "Minha Empresa",
    "phoneNumber": "5511999999999"
  }
}

Status da conexão

Retorna o status atual da instância WhatsApp vinculada ao token.

GET /v1/status Status da instância WhatsApp

GET https://core.hosteg.api.br/v1/status
X-Api-Token: seu_token_aqui
X-Domain:    meusite.com.br

Resposta:

{
  "connected":   true,
  "status":      "connected",
  "phoneNumber": "5511999999999",
  "profileName": "Minha Empresa"
}

Códigos de resposta

A API usa códigos HTTP padrão para indicar sucesso ou falha.

202 Mensagem enfileirada com sucesso

200 Requisição processada com sucesso

400 Parâmetros inválidos ou ausentes

401 Token não informado ou inválido

403 Domínio não autorizado ou conta inativa

429 Cota diária de envios atingida

503 Instância WhatsApp desconectada

⚠️ Erros retornam JSON: todas as respostas de erro incluem um campo error com a descrição.

{ "error": "Token inválido ou revogado" }

Plugin WordPress

O plugin oficial conecta seu WordPress à API automaticamente. Suporta WooCommerce, Contact Form 7, Gravity Forms, cadastro de usuários e wp_mail().

⬇ Baixar plugin (.zip) 🔑 Gerar token

Instalação

Baixe o arquivo .zip acima
No WordPress: Plugins → Adicionar novo → Enviar plugin
Selecione o arquivo hosteg-whatsapp.zip e instale
Ative o plugin e vá em WhatsApp → Configurações
Cole o Token de API gerado no painel Hosteg e salve

ℹ️ Configuração mínima: token de API + domínio do site cadastrado no token. O plugin detecta automaticamente o WooCommerce, CF7 e Gravity Forms instalados.

Exemplos de código

Como enviar mensagens nos principais ambientes.

cURL

curl -X POST https://core.hosteg.api.br/v1/send \
  -H "X-Api-Token: seu_token_aqui" \
  -H "X-Domain: meusite.com.br" \
  -H "Content-Type: application/json" \
  -d '{"phone":"5511999999999","message":"Olá! Teste Hosteg ✅"}'

JavaScript (fetch)

await fetch('https://core.hosteg.api.br/v1/send', {
  method: 'POST',
  headers: {
    'X-Api-Token':  'seu_token_aqui',
    'X-Domain':     'meusite.com.br',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    phone:   '5511999999999',
    message: 'Olá! Teste Hosteg ✅',
  }),
});

Python (requests)

import requests

response = requests.post(
    'https://core.hosteg.api.br/v1/send',
    headers={
        'X-Api-Token':  'seu_token_aqui',
        'X-Domain':     'meusite.com.br',
        'Content-Type': 'application/json',
    },
    json={
        'phone':   '5511999999999',
        'message': 'Olá! Teste Hosteg ✅',
    }
)
print(response.json())

PHP (wp_remote_post)

$response = wp_remote_post('https://core.hosteg.api.br/v1/send', [
    'headers' => [
        'X-Api-Token'  => 'seu_token_aqui',
        'X-Domain'     => 'meusite.com.br',
        'Content-Type' => 'application/json',
    ],
    'body' => wp_json_encode([
        'phone'   => '5511999999999',
        'message' => 'Olá! Teste Hosteg ✅',
    ]),
]);

Integrações sem código

Qualquer plataforma que suporte requisições HTTP pode integrar com a API Hosteg.

Make (Integromat) Módulo HTTP → Make a request

Zapier Módulo Webhooks → Custom request

n8n Nó HTTP Request

Bubble API Connector → POST

FlutterFlow API Calls → Custom

Pabbly Connect HTTP Request action