groups.whatsapp_groups

Listar os grupos que o número já tem no WhatsApp. Consulta a Evolution API (passa pelo governador, ação fetch_group) e devolve os grupos do número com description (nula quando não há), marcando os que já estão na campanha (alreadyInCampaign). Só admin: gasta o orçamento do número e alimenta a importação. O número precisa estar vinculado à campanha e o usuário precisa poder usá-lo. Se o governador negar, responde limit_reached com a espera.

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

Entrada

{
  "$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)$"
    },
    "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": [
    "campaignId",
    "channelId"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta groups_whatsapp_groups com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "jid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "size": {
            "type": "number"
          },
          "announce": {
            "type": "boolean"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "alreadyInCampaign": {
            "type": "boolean"
          }
        },
        "required": [
          "jid",
          "name",
          "size",
          "announce",
          "description",
          "alreadyInCampaign"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "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).