Pular para o conteúdo principal
GET
/
api
/
community
/
listSubGroups
/
:instance
Listar subgrupos
curl --request GET \
  --url https://api.example.com/api/community/listSubGroups/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Lista os subgrupos de uma comunidade. O Grupo de Anúncios é identificado pelo flag isDefaultSubGroup: true. Diferente dos demais endpoints, esta rota exige JID em ?communityJid= (não aceita código / link).

​
Exemplos

​
Listar subgrupos

Consulta os subgrupos da comunidade 120363406289005073@g.us passando o JID completo (com sufixo @g.us) na query string. 
curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073@g.us" \
  -H "token: $Token_Instance"

​
Sem sufixo @g.us

Mesma consulta, mas passando apenas o ID numérico em communityJid. O serviço adiciona @g.us automaticamente antes de resolver a comunidade. 
curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

Retorna communityJid (já normalizado com sufixo @g.us) e o array subgroups com cada grupo vinculado em que o bot participa. Cada item traz jid, name e o flag isDefaultSubGroup que identifica o Grupo de Anúncios da comunidade. O message traz a contagem ("N subgroup(s) found") e o array vem vazio quando nenhum subgrupo é encontrado.
200 OK
{
  "success": true,
  "message": "2 subgroup(s) found",
  "communityJid": "120363406289005073@g.us",
  "subgroups": [
    {
      "jid": "120363406289005074@g.us",
      "name": "Anúncios",
      "isDefaultSubGroup": true
    },
    {
      "jid": "120363406289005075@g.us",
      "name": "Geral",
      "isDefaultSubGroup": false
    }
  ]
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Query

​
communityJid
string
obrigatório
JID @g.us da comunidade. Se omitir o sufixo, o serviço adiciona @g.us automaticamente.

​
Notas

  • A listagem só retorna subgrupos em que o bot está, se o bot participa apenas do parent mas não de um subgrupo X, X não aparece na lista.
  • A propagação de novas vinculações pode levar 1-3s, um GET logo após POST /link pode retornar a lista sem o grupo recém-vinculado temporariamente.
  • O Grupo de Anúncios sempre aparece com isDefaultSubGroup: true. Filtre no cliente se precisar excluir-lo da listagem.

​
Erros

HTTPMensagem
400communityJid query parameter is required
400invalid community JID: <reason>
400Instance is not connected to WhatsApp
500failed to get groups: <reason>
Envelope: 
{
  "success": false,
  "error": { "message": "communityJid query parameter is required" }
}

​
Próximo

Vincular grupos

Adicionar novos subgrupos.

Desvincular grupos

Remover subgrupos da comunidade.