Ver .md

inbox.group_participants

Participantes de um grupo do WhatsApp. Lista quem está no grupo da conversa (número por QR), com telefone quando o WhatsApp informa (quem aparece só por @lid vem sem), nome salvo no Atomiks ou o do WhatsApp, e papel (member, admin, superadmin). canManage = o número conectado é administrador do grupo (pode adicionar, remover, promover e rebaixar por inbox.group_participants_update).

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

Entrada

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

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.group_participants --json '{"conversationId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta inbox_group_participants com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "participants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "jid": {
            "type": "string"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "role": {
            "type": "string",
            "enum": [
              "member",
              "admin",
              "superadmin"
            ]
          },
          "me": {
            "type": "boolean"
          }
        },
        "required": [
          "jid",
          "phone",
          "name",
          "role",
          "me"
        ],
        "additionalProperties": false
      }
    },
    "canManage": {
      "type": "boolean"
    }
  },
  "required": [
    "participants",
    "canManage"
  ],
  "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).