groups.campaign_get

Ver uma campanha de grupos. Campanha com os números (canais) vinculados e a contagem de grupos: total, captando e lotados entre os que captam.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "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": [
    "id"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs groups.campaign_get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta groups_campaign_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": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "attention",
        "paused",
        "ended"
      ]
    },
    "timezone": {
      "type": "string"
    },
    "shortCode": {
      "type": "string"
    },
    "capacity": {
      "type": "number"
    },
    "rotationPolicy": {
      "type": "string",
      "enum": [
        "sequential",
        "weighted",
        "round_robin"
      ]
    },
    "cookieDays": {
      "type": "number"
    },
    "reservationMinutes": {
      "type": "number"
    },
    "fallbackUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "usage": {
            "default": "groups",
            "type": "string",
            "enum": [
              "groups",
              "both"
            ]
          }
        },
        "required": [
          "channelId",
          "name",
          "phone",
          "status",
          "usage"
        ],
        "additionalProperties": false
      }
    },
    "groups": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "capturing": {
          "type": "number"
        },
        "full": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "capturing",
        "full"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "timezone",
    "shortCode",
    "capacity",
    "rotationPolicy",
    "cookieDays",
    "reservationMinutes",
    "fallbackUrl",
    "createdAt",
    "numbers",
    "groups"
  ],
  "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).