Ver .md

channels.evolution_connect

Conectar um número por QR code. Cria a sessão do número no servidor do WhatsApp por QR com o webhook do Atomiks, registra o canal whatsapp_web em connecting e devolve o QR code para escanear no celular. Só pela interface.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/channels.evolution_connect (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: channels:write
  • Grava dados: sim
  • Pela chave de API: não (só pela interface)
  • Ferramenta MCP: não
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channels.evolution_connect)

Entrada

CampoTipoObrigatórioNota
namestringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  },
  "required": [
    "name"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channels.evolution_connect \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Atendimento"}'

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string"
    },
    "qr": {
      "type": "object",
      "properties": {
        "base64": {
          "type": [
            "string",
            "null"
          ]
        },
        "code": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "base64",
        "code"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "channelId",
    "qr"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).