Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cawme.com.br/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/instances/:instanceId/configure Retorna um QR code codificado em Base64 que você escaneia com o WhatsApp para vincular um número de telefone a esta instância. Após escanear, o status da instância transita para CONFIGURED e eventualmente para ACTIVE.

Requisição

Cabeçalhos

CabeçalhoValor
AuthorizationBearer <token>

Parâmetros de caminho

ParâmetroTipoDescrição
instanceIdstringO ID da instância a configurar

Resposta 200

CampoTipoDescrição
instanceIdstringO ID da instância
qrCodeBase64stringImagem do QR code codificada em Base64
messagestringMensagem de status adicional
{
  "instanceId": "inst_abc123",
  "qrCodeBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "message": "Escaneie com o WhatsApp para vincular seu número"
}

Decodificando o QR code

Converta qrCodeBase64 em uma imagem e exiba para escaneamento:
const img = document.createElement("img");
img.src = `data:image/png;base64,${response.qrCodeBase64}`;
document.body.appendChild(img);

Erros

CódigoDescrição
401Token ausente ou inválido
404Instância não encontrada ou não pertence ao usuário

Exemplo

curl https://cawme.com/api/v1/instances/inst_abc123/configure \
  -H "Authorization: Bearer <token>"