Ver .md

channels.web_switch_provider

Atualizar a conexão de um número por QR (ler o QR de novo). Leva um número por QR já conectado para o servidor de WhatsApp atual sem perder as conversas: cria a sessão nova e devolve o QR code para ler no mesmo celular. Ao ler com o mesmo número, a conexão antiga é apagada e o canal segue com o mesmo id e as mesmas conversas; com outro número, a sessão nova é descartada e lastAttempt vem phone_mismatch (nova sessão só com restart: true). Chamada de novo durante a troca devolve um QR novo; cancel: true desiste da troca. Só pela interface.

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

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
to"evolution" | "waha"não
cancelbooleannão
restartbooleannão
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)$"
    },
    "to": {
      "type": "string",
      "enum": [
        "evolution",
        "waha"
      ]
    },
    "cancel": {
      "type": "boolean"
    },
    "restart": {
      "type": "boolean"
    }
  },
  "required": [
    "channelId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channels.web_switch_provider \
  -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": {
    "qr": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "base64": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "base64",
            "code"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "pairingCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastAttempt": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "phone_mismatch"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "qr",
    "pairingCode",
    "lastAttempt"
  ],
  "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).

channels.web_switch_provider · Atomiks API