vértice
Produto Preços Painel
Instâncias

Pareamento por código

Solicita um código de pareamento por telefone para conectar sem câmera.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/pair" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"phoneNumber":"5511999999999"}'
POST /instances/{id}/pair
API key
Entenda

Conceituação

Solicita um código de pareamento por telefone para conectar sem câmera. O código é usado no WhatsApp em Aparelhos conectados.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

phoneNumber string obrigatório

Campo phoneNumber do corpo JSON.

Payload

Request Body

{
  "phoneNumber": "5511999999999"
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
409 Instância não conectada ou conflito de estado.