Ver .md

groups.governor_status

Saúde e limites de um número de Grupos. Perfil de segurança, estágio efetivo, pausa, suspeita de banimento e uso por ação na última hora e no último dia, com os tetos vigentes (maior versão da tabela de limites).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/groups.governor_status (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: marketing:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: groups_governor_status
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId groups.governor_status)

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/groups.governor_status \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"00000000-0000-4000-8000-000000000001"}'

CLI:

node cli/atomiks.mjs groups.governor_status --json '{"channelId":"00000000-0000-4000-8000-000000000001"}'

MCP: ferramenta groups_governor_status com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "profile": {
      "type": "string",
      "enum": [
        "auto",
        "maximum",
        "moderate",
        "light",
        "custom"
      ]
    },
    "stage": {
      "type": "number"
    },
    "version": {
      "type": [
        "number",
        "null"
      ]
    },
    "pausedUntil": {
      "type": [
        "string",
        "null"
      ]
    },
    "pauseReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "suspectedBanAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "usage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string"
          },
          "hour": {
            "type": "number"
          },
          "day": {
            "type": "number"
          },
          "perHour": {
            "type": [
              "number",
              "null"
            ]
          },
          "perDay": {
            "type": [
              "number",
              "null"
            ]
          }
        },
        "required": [
          "action",
          "hour",
          "day",
          "perHour",
          "perDay"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "profile",
    "stage",
    "version",
    "pausedUntil",
    "pauseReason",
    "suspectedBanAt",
    "usage"
  ],
  "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).