groups.number_connect

Conectar um número dedicado a Grupos (QR ou código de pareamento). Cria o número de Grupos: sessão no servidor do WhatsApp por QR com o webhook do Atomiks e canal whatsapp_web com usage = groups, em connecting. Devolve o QR code e, se pairingPhone (só dígitos com DDI, 12 a 13) vier, também o código de pareamento para digitar no celular. Use um chip exclusivo: o número de atendimento nunca entra em Grupos. Só pela interface.

• Endpoint: POST https://app.atomiks.com.br/api/v1/groups.number_connect (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: marketing: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 groups.number_connect)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "pairingPhone": {
      "type": "string",
      "pattern": "^\\d{12,13}$"
    }
  },
  "required": [
    "name"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.number_connect \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Lançamento","pairingPhone":"5511999990000"}'

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
    },
    "pairingCode": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "channelId",
    "qr",
    "pairingCode"
  ],
  "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).