v2PainelCriar chave

Números

Uma instância é um número de WhatsApp conectado. O nome que você escolhe ao criar é o identificador usado em todas as rotas (:instance).

POSTCadastrar um número

/instance/create

Cria uma instância no seu workspace. Respeita o limite de canais do seu plano.

instanceNamestringObrigatório
Identificador permanente. Letras, números, ponto, hífen e sublinhado; até 40 caracteres.
qrcodebooleanOpcional
Quando true, já devolve o primeiro QR Code na resposta.
numberstringOpcional
Número com DDI para receber um código de pareamento em vez de QR.
curl -X POST https://api.connectdm.app/instance/create \
  -H "apikey: sk_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "instanceName": "loja",
  "qrcode": true
}'

GETVer todos os números

/instance/fetchInstances

Lista as instâncias do workspace da chave com o estado de conexão de cada uma. Também serve para testar a chave.

curl -X GET https://api.connectdm.app/instance/fetchInstances \
  -H "apikey: sk_live_SUA_CHAVE"

GETGerar QR ou código de pareamento

/instance/connect/:instance

Inicia a sessão e devolve o QR Code em base64. Com ?number= devolve um código de pareamento de 8 caracteres.

numberqueryOpcional
Número com DDI. Quando presente, a resposta traz pairingCode.
curl -X GET https://api.connectdm.app/instance/connect/loja \
  -H "apikey: sk_live_SUA_CHAVE"

GETQR em imagem

/instance/connect/:instance/image

O QR Code atual como imagem PNG, pronto para um <img>. Responde 204 se a instância já estiver conectada.

curl -X GET https://api.connectdm.app/instance/connect/loja/image \
  -H "apikey: sk_live_SUA_CHAVE"

GETStatus da sessão

/instance/connectionState/:instance

Estado atual: open, connecting, qr-code ou closed.

curl -X GET https://api.connectdm.app/instance/connectionState/loja \
  -H "apikey: sk_live_SUA_CHAVE"

DELETEEncerrar sessão

/instance/logout/:instance

Encerra a sessão do WhatsApp e mantém a instância. Para voltar, chame Conectar.

curl -X DELETE https://api.connectdm.app/instance/logout/loja \
  -H "apikey: sk_live_SUA_CHAVE"

DELETEExcluir número

/instance/delete/:instance

Remove a instância de vez, com a sessão. Conversas já recebidas continuam no inbox.

curl -X DELETE https://api.connectdm.app/instance/delete/loja \
  -H "apikey: sk_live_SUA_CHAVE"
© 2026 ConnectDM by Centralizer · Referência da API