Ver .md

groups.number_profile_get

Perfil de segurança de um número de Grupos, com recomendação e limites dos presets. Devolve o perfil (auto, maximum, moderate, light ou custom), os limites personalizados gravados, o estágio efetivo (Máxima = 0, Moderada = 2, Leve e Personalizada = 3, Automático pela idade), os dias desde a primeira conexão no Atomiks, a recomendação (menos de 3 dias: Máxima; menos de 14: Moderada; senão Leve — número antigo e usado no WhatsApp pode ir para Moderada ou Leve) e os limites por ação de cada preset (maior versão da tabela de limites).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/groups.number_profile_get (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_number_profile_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId groups.number_profile_get)

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

CLI:

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

MCP: ferramenta groups_number_profile_get 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"
      ]
    },
    "customLimits": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "object",
            "properties": {
              "perHour": {
                "type": "number"
              },
              "perDay": {
                "type": "number"
              },
              "minGapMs": {
                "type": "number"
              }
            },
            "required": [
              "perHour",
              "perDay",
              "minGapMs"
            ],
            "additionalProperties": false
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "effectiveStage": {
      "type": "number"
    },
    "ageDays": {
      "type": "number"
    },
    "recommended": {
      "type": "string",
      "enum": [
        "maximum",
        "moderate",
        "light"
      ]
    },
    "presets": {
      "type": "object",
      "properties": {
        "maximum": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "object",
            "properties": {
              "perHour": {
                "type": "number"
              },
              "perDay": {
                "type": "number"
              },
              "minGapMs": {
                "type": "number"
              }
            },
            "required": [
              "perHour",
              "perDay",
              "minGapMs"
            ],
            "additionalProperties": false
          }
        },
        "moderate": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "object",
            "properties": {
              "perHour": {
                "type": "number"
              },
              "perDay": {
                "type": "number"
              },
              "minGapMs": {
                "type": "number"
              }
            },
            "required": [
              "perHour",
              "perDay",
              "minGapMs"
            ],
            "additionalProperties": false
          }
        },
        "light": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "object",
            "properties": {
              "perHour": {
                "type": "number"
              },
              "perDay": {
                "type": "number"
              },
              "minGapMs": {
                "type": "number"
              }
            },
            "required": [
              "perHour",
              "perDay",
              "minGapMs"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "maximum",
        "moderate",
        "light"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "profile",
    "customLimits",
    "effectiveStage",
    "ageDays",
    "recommended",
    "presets"
  ],
  "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).

groups.number_profile_get · Atomiks API