Conexões WhatsApp

CRUD completo para as conexões WhatsApp da conta.

Endpoints

Método	Rota	Descrição
GET	/api/v1/whatsapp-connections	Lista conexões
POST	/api/v1/whatsapp-connections	Cria uma conexão
GET	/api/v1/whatsapp-connections/{whatsapp_connection}	Exibe uma conexão
PUT/PATCH	/api/v1/whatsapp-connections/{whatsapp_connection}	Atualiza uma conexão
DELETE	/api/v1/whatsapp-connections/{whatsapp_connection}	Remove uma conexão

Filtros de listagem

search, is_active.

Campos

Campo	Tipo	Obrigatório	Descrição
name	string, max 255	Sim	Nome da conexão.
phone_number	string, max 30	Sim (na criação)	Número do WhatsApp.
description	string	Não	Observações livres.
is_active	boolean	Não	Padrão: conforme cadastro.
agent_id	integer	Não	ID de um agente ativo da conta, usado como fallback.
phone_number_id	string, max 255	Não	Phone Number ID da Meta Cloud API.
whatsapp_business_account_id	string, max 255	Não	ID da conta de negócios do WhatsApp.
access_token	string	Não	Token de acesso da aplicação. Somente escrita — nunca é retornado.
webhook_verify_token	string	Não	Token de verificação do webhook. Somente escrita — nunca é retornado.
proxy_url	string (URL)	Não	Se preenchida, eventos de chamada recebidos também são encaminhados para essa URL.
is_configured	boolean	Não	Marcação manual após validar o webhook na Meta.

Exemplo de resposta

{
  "id": 8,
  "name": "WhatsApp Comercial",
  "phone_number": "+5511999998888",
  "description": null,
  "is_active": true,
  "agent_id": 12,
  "phone_number_id": "123456789",
  "whatsapp_business_account_id": "987654321",
  "proxy_url": null,
  "is_configured": true,
  "created_at": "2026-08-01T12:00:00Z",
  "updated_at": "2026-08-01T12:00:00Z"
}

Note que access_token e webhook_verify_token não aparecem na resposta.

Exemplos com curl

Listar conexões

curl "$ROUXINOL_URL/api/v1/whatsapp-connections?is_active=true" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Criar uma conexão

curl -X POST "$ROUXINOL_URL/api/v1/whatsapp-connections" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "WhatsApp Comercial",
        "phone_number": "+5511999998888",
        "agent_id": 12
      }'

Exibir uma conexão

curl "$ROUXINOL_URL/api/v1/whatsapp-connections/8" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"

Atualizar uma conexão (ex: preencher os dados da Cloud API depois de criada)

curl -X PATCH "$ROUXINOL_URL/api/v1/whatsapp-connections/8" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "phone_number_id": "123456789",
        "whatsapp_business_account_id": "987654321",
        "access_token": "EAAG...",
        "webhook_verify_token": "meu-token-secreto"
      }'

Remover uma conexão

curl -X DELETE "$ROUXINOL_URL/api/v1/whatsapp-connections/8" \
  -H "Authorization: Bearer $ROUXINOL_TOKEN"