# groups.number_status

Estado, QR e saúde de um número de Grupos. Consulta a sessão do número (reinicia a que caiu); ao conectar o canal vira `ready`. Se ainda não conectou, devolve QR e código de pareamento novos. Inclui o estado do governador: pausa, suspeita de banimento e estágio de aquecimento.

- Endpoint: `POST https://app.atomiks.com.br/api/v1/groups.number_status` (corpo JSON)
- Quem pode chamar: membro da conta
- Escopo da chave: `marketing:write`
- Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP: `groups_number_status`
- Ficha em JSON: `https://app.atomiks.com.br/api/v1/openapi.json` (operationId `groups.number_status`)

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `channelId` | string (uuid) | sim |  |

<details><summary>JSON Schema</summary>

```json
{
  "$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"
  ]
}
```

</details>

## Exemplo

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

CLI:

```bash
node cli/atomiks.mjs groups.number_status --json '{"channelId":"00000000-0000-0000-0000-000000000000"}'
```

MCP: ferramenta `groups_number_status` com a mesma entrada.

## Saída

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

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "connecting",
        "ready",
        "disconnected"
      ]
    },
    "phone": {
      "type": [
        "string",
        "null"
      ]
    },
    "qr": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "base64": {
              "type": [
                "string",
                "null"
              ]
            },
            "code": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "base64",
            "code"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "pairingCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "governor": {
      "type": "object",
      "properties": {
        "paused_until": {
          "type": [
            "string",
            "null"
          ]
        },
        "pause_reason": {
          "type": [
            "string",
            "null"
          ]
        },
        "suspected_ban_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "stage": {
          "type": "number"
        },
        "profile": {
          "type": "string",
          "enum": [
            "auto",
            "maximum",
            "moderate",
            "light",
            "custom"
          ]
        }
      },
      "required": [
        "paused_until",
        "pause_reason",
        "suspected_ban_at",
        "stage",
        "profile"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "status",
    "phone",
    "qr",
    "pairingCode",
    "governor"
  ],
  "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).