Ver .md

groups.access_check

Conferir se o número participa e é admin dos grupos. Enfileira um job por número que confere, em cada grupo vivo da campanha, se o número participa, se é admin e se o link de convite vale. Grupos sem número vão para o primeiro número vinculado. Recusa se já há uma conferência em andamento. jobId é o primeiro job; jobIds traz todos.

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

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "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": [
    "campaignId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.access_check \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001"}'

CLI:

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

MCP: ferramenta groups_access_check com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "jobId": {
      "type": [
        "string",
        "null"
      ]
    },
    "jobIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "total": {
      "type": "number"
    }
  },
  "required": [
    "jobId",
    "jobIds",
    "total"
  ],
  "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).