Conecte uma instância ao WhatsApp e integre mensagens, chats, grupos, perfil e webhooks usando sua X-API-Key.
Os arquivos do Postman devem ser disponibilizados na pasta downloads.
{{base_url}}
Definida no Environment do Postman
X-API-Key
Formato das requisições: JSON
API Key.
A criação, conexão e operação das instâncias são feitas exclusivamente pela API.
Fluxo recomendado para realizar a primeira integração.
No painel, acesse API Keys, crie uma chave e
armazene o valor completo em local seguro.
Faça POST /whatsapp/instancias, escolhendo
Baileys ou WhatsApp Business e, se desejar, seu webhook.
Para Baileys, consulte o QR Code e leia-o no WhatsApp.
Para Business, informe o business_id na criação.
Consulte o status da conexão e, quando a instância estiver conectada, utilize a rota de envio de texto.
X-API-Key: rps_live_xxxxxxxxxxxxxxxxxxxxxxxxxPOST {{base_url}}/whatsapp/instancias
Content-Type: application/json
X-API-Key: {{generated_api_key}}
{
"nome": "Atendimento",
"integration": "WHATSAPP-BAILEYS",
"webhook_url": "https://cliente.exemplo.com/webhooks/whatsapp",
"webhook_ativo": true
}GET {{base_url}}/whatsapp/instancias/{{instanciaId}}/qrcode
X-API-Key: {{generated_api_key}}POST {{base_url}}/whatsapp/send-text
Content-Type: application/json
X-API-Key: {{generated_api_key}}
{
"instancia_id": "{{instanciaId}}",
"number": "{{numero}}",
"text": "Minha primeira mensagem pelo RPS Connect",
"delay": 1200,
"linkPreview": false
}
As expressões entre chaves duplas, como {{api_key}},
representam variáveis utilizadas na Collection do Postman.
Todas as rotas públicas exigem uma API Key ativa da sua conta.
X-API-Key. A chave identifica a empresa e limita o acesso às suas próprias instâncias; nunca a exponha em aplicações de navegador.
curl --request GET "{{base_url}}/whatsapp/instancias" \
--header "X-API-Key: {{generated_api_key}}"Crie, conecte e administre suas instâncias pelo RPS Connect. 10 rota(s)
Cria uma instância baseada em WhatsApp Web. Use o QR Code retornado ou a rota de QR Code para conectá-la.
{
"nome": "Atendimento",
"integration": "WHATSAPP-BAILEYS",
"numero": "",
"webhook_url": "https://cliente.exemplo.com/webhooks/whatsapp",
"webhook_ativo": true
}Cria uma instância integrada ao WhatsApp Business. O campo business_id é obrigatório; esse tipo não utiliza QR Code.
{
"nome": "Atendimento Oficial",
"integration": "WHATSAPP-BUSINESS",
"number": "5514999999999",
"token": "",
"business_id": "{{businessId}}",
"webhook_url": "https://cliente.exemplo.com/webhooks/whatsapp",
"webhook_ativo": true
}Retorna as instâncias vinculadas à API Key utilizada.
Remove permanentemente uma instância. Confirme o identificador antes de chamar esta rota.
Retorna o QR Code para conectar uma instância WHATSAPP-BAILEYS. Não se aplica a WhatsApp Business.
Content-Type: application/json
X-API-Key: {{api_key}}Consulta o estado atual da conexão e da configuração da instância.
Content-Type: application/json
X-API-Key: {{api_key}}Reinicia a sessão da instância informada.
Content-Type: application/json
X-API-Key: {{api_key}}{}Desconecta a sessão do WhatsApp vinculada à instância.
Content-Type: application/json
X-API-Key: {{api_key}}{}Atualiza a presença geral da instância, como disponível ou indisponível.
Content-Type: application/json
X-API-Key: {{api_key}}{
"presence": "available"
}Envie textos, mídias, contatos, localizações, enquetes e outras mensagens. 12 rota(s)
Envia uma mensagem de texto para um número de WhatsApp.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"text": "Olá, mensagem enviada pelo RPS Connect",
"delay": 1200,
"linkPreview": false
}Envia imagem, vídeo ou documento a partir de uma URL pública.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"mediatype": "image",
"mimetype": "image/png",
"caption": "Imagem enviada pelo RPS Connect",
"media": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQISNdaODyJgLXctAbcJI11rG884LVCvAaBSDNaGfFeMQ&s=10",
"fileName": "imagem.png"
}Envia um arquivo de áudio para o destinatário informado.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"audio": "http://webaudioapi.com/samples/audio-tag/chrono.mp3",
"delay": 1200,
"encoding": true
}Envia uma figurinha a partir de uma URL pública.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"sticker": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ_CntvoWQMLvijxLZKny0QQBc7Fqw89D9Wmn0F768EgQ&s"
}Envia uma localização contendo nome, endereço, latitude e longitude.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"name": "RPS Connect",
"address": "Marília/SP",
"latitude": -22.2139,
"longitude": -49.9458
}Envia um ou mais cartões de contato.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"contact": [
{
"fullName": "João Silva",
"wuid": "5514999999999",
"phoneNumber": "+55 14 99999-9999",
"organization": "Empresa Teste",
"email": "[email protected]",
"url": "https://empresa.com.br"
}
]
}Envia uma enquete com uma ou mais opções de resposta.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"name": "Qual opção você prefere?",
"selectableCount": 1,
"values": [
"Opção 1",
"Opção 2",
"Opção 3"
]
}Rota temporariamente indisponível para uso em produção.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"title": "Menu de Atendimento",
"description": "Escolha uma opção abaixo",
"buttonText": "Abrir menu",
"footerText": "RPS Connect",
"sections": [
{
"title": "Atendimento",
"rows": [
{
"title": "Comercial",
"description": "Falar com vendas",
"rowId": "comercial"
},
{
"title": "Suporte",
"description": "Falar com suporte",
"rowId": "suporte"
}
]
}
]
}Rota temporariamente indisponível para uso em produção.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"title": "Confirmação",
"description": "Deseja continuar?",
"footer": "RPS Connect",
"buttons": [
{
"type": "reply",
"displayText": "Sim",
"id": "SIM"
},
{
"type": "reply",
"displayText": "Não",
"id": "NAO"
}
]
}Envia um vídeo no formato de mensagem PTV.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"video": "https://evolution-api.com/files/video.mp4",
"delay": 1200
}Publica um status de texto ou mídia para os contatos configurados.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"type": "text",
"content": "Status enviado pelo RPS Connect",
"backgroundColor": "#008000",
"font": 1,
"allContacts": false,
"statusJidList": [
"{{numero_destino}}@s.whatsapp.net"
]
}Adiciona uma reação a uma mensagem existente.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"key": {
"remoteJid": "{{numero_destino}}@s.whatsapp.net",
"fromMe": true,
"id": "{{mensagem_id}}"
},
"reaction": "🚀"
}Consulte números, contatos, mensagens e recursos dos chats. 8 rota(s)
Verifica quais números informados possuem conta no WhatsApp.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"numbers": [
"{{numero_destino}}",
"5514888888888"
]
}Consulta os contatos disponíveis na instância.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"where": {}
}Consulta mensagens aplicando os filtros enviados no corpo da requisição.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"where": {
"key": {
"remoteJid": "{{numero_destino}}@s.whatsapp.net"
}
},
"page": 1,
"offset": 10
}Rota temporariamente indisponível para uso em produção.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}"
}Marca uma ou mais mensagens como lidas.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"readMessages": [
{
"remoteJid": "{{numero_destino}}@s.whatsapp.net",
"fromMe": false,
"id": "{{mensagem_id}}"
}
]
}Envia um estado temporário, como digitando ou gravando áudio.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"delay": 1200,
"presence": "composing"
}Consulta a foto de perfil de um número de WhatsApp.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}"
}Bloqueia ou desbloqueia um contato na instância.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"status": "block"
}Crie grupos e gerencie participantes, convites e configurações. 10 rota(s)
Cria um grupo e adiciona os participantes informados.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"subject": "Grupo Teste RPS Connect",
"description": "Grupo criado via SaaS",
"participants": [
"{{numero_destino}}"
]
}Lista os grupos da instância, com opção de incluir participantes.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"getParticipants": false /*true - lista os participantes*/
}Consulta os dados de um grupo pelo identificador JID.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}"
}Lista os participantes de um grupo.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}"
}Obtém o código de convite atual do grupo.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}"
}Revoga o código atual e gera um novo convite para o grupo.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}"
}Envia o convite de um grupo para os números informados.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}",
"description": "Acesse este link para entrar no grupo:",
"numbers": [
"{{numero_destino}}"
]
}Adiciona, remove ou altera participantes do grupo.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}",
"action": "add",
"participants": [
"{{numero_destino}}"
]
}Atualiza permissões e configurações do grupo.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}",
"action": "not_announcement"
}Remove a instância do grupo informado.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"groupJid": "{{grupo_jid}}"
}Consulte e aplique etiquetas aos contatos. 2 rota(s)
Lista as etiquetas disponíveis na instância.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}"
}Adiciona ou remove uma etiqueta de um contato.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}",
"labelId": "1",
"action": "add"
}Consulte e atualize perfil, foto, recado e configurações de privacidade. 8 rota(s)
Consulta os dados comerciais de um perfil do WhatsApp Business.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}"
}Consulta os dados públicos do perfil informado.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"number": "{{numero_destino}}"
}Atualiza o nome exibido no perfil da instância.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"name": "RPS Connect"
}Atualiza o recado ou status textual do perfil.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"status": "Atendimento via RPS Connect"
}Atualiza a foto do perfil usando uma URL pública.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"picture": "https://evolution-api.com/files/evolution-api.png"
}Remove a foto atual do perfil da instância.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}"
}Consulta as configurações atuais de privacidade.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}"
}Atualiza as preferências de privacidade da conta.
Content-Type: application/json
X-API-Key: {{api_key}}{
"instancia_id": "{{instancia_id}}",
"readreceipts": "all",
"profile": "all",
"status": "contacts",
"online": "all",
"last": "contacts",
"groupadd": "none"
}Consulte eventos recebidos e solicite o reprocessamento de falhas. 5 rota(s)
webhook_url ao criar a instância. A Evolution envia o evento ao webhook interno do RPS Connect; a plataforma o processa, registra e o encaminha para a URL do cliente. Assim, o endereço interno do SaaS não fica exposto e a URL do cliente permanece vinculada à instância.
Cliente → POST /whatsapp/instancias (webhook_url)
→ RPS Connect salva a URL do cliente
Evolution → webhook interno do RPS Connect
→ RPS Connect processa e encaminha → webhook_url do clienteLista os eventos de webhook registrados para a empresa.
X-API-Key: {{api_key}}Lista somente os eventos cujo processamento terminou com erro.
X-API-Key: {{api_key}}Lista os eventos relacionados à instância informada.
X-API-Key: {{api_key}}Consulta os detalhes de um evento específico.
X-API-Key: {{api_key}}Solicita uma nova tentativa de processamento do evento.
X-API-Key: {{api_key}}
Content-Type: application/json{}As respostas de erro são retornadas em JSON.
A chave está ausente, inválida, expirada ou revogada. Revise o cabeçalho X-API-Key.
A chave não tem acesso ao recurso solicitado ou a instância não pertence à empresa autenticada.
A instância, evento ou outro identificador informado não existe.
O corpo da requisição não passou pela validação; confira campos obrigatórios, formato e integração.
Ocorreu uma falha inesperada. Registre a resposta e entre em contato com o suporte se ela persistir.
{
"error": "mensagem explicativa",
"status": 422
}Use a Collection como referência operacional e estes exemplos para iniciar rapidamente.
await fetch("{{base_url}}/whatsapp/send-text", {
method: "POST",
headers: { "Content-Type": "application/json", "X-API-Key": apiKey },
body: JSON.stringify({ instancia_id, number: "5514999999999", text: "Olá!" })
});TRequest.New.BaseURL(BaseUrl).Resource('/whatsapp/send-text')
.AddHeader('X-API-Key', ApiKey).AddBody(BodyJson).Post;client.DefaultRequestHeaders.Add("X-API-Key", apiKey);
await client.PostAsJsonAsync("/whatsapp/send-text", payload);$response = $client->post('/whatsapp/send-text', [
'headers' => ['X-API-Key' => $apiKey], 'json' => $payload
]);