Ver .md

channels.evolution_qr

Estado e QR code de um número por QR. Consulta o estado da sessão do número (reinicia a que caiu). Se ainda não estiver conectada, devolve um QR code novo; ao conectar, o canal fica ready. Só pela interface.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/channels.evolution_qr (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_qr)

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "channelId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channels.evolution_qr \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"00000000-0000-0000-0000-000000000000"}'

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "connecting",
        "ready",
        "disconnected"
      ]
    },
    "qr": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "base64": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "base64",
            "code"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "status",
    "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).