Saltar al contenido 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Lista los subgrupos de una comunidad. El Grupo de Anuncios se identifica por la bandera isDefaultSubGroup: true. A diferencia de los otros endpoints, esta ruta requiere un JID en ?communityJid= (no acepta código / enlace).

​
Ejemplos

​
Listar subgrupos

Consulta los subgrupos de la comunidad 120363406289005073@g.us pasando el JID completo (con el sufijo @g.us) en el query string. 
curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073@g.us" \
  -H "token: $Token_Instance"

​
Sin el sufijo @g.us

Misma consulta, pero pasando solo el ID numérico en communityJid. El servicio agrega automáticamente @g.us antes de resolver la comunidad. 
curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073" \
  -H "token: $Token_Instance"

​
Respuesta exitosa

Devuelve communityJid (ya normalizado con el sufijo @g.us) y el array subgroups con cada grupo vinculado en el que el bot participa. Cada elemento lleva jid, name y la bandera isDefaultSubGroup que identifica el Grupo de Anuncios de la comunidad. El message lleva el conteo ("N subgroup(s) found") y el array viene vacío cuando no se encuentra ningún subgrupo.
200 OK
{
  "success": true,
  "message": "2 subgroup(s) found",
  "communityJid": "120363406289005073@g.us",
  "subgroups": [
    {
      "jid": "120363406289005074@g.us",
      "name": "Announcements",
      "isDefaultSubGroup": true
    },
    {
      "jid": "120363406289005075@g.us",
      "name": "General",
      "isDefaultSubGroup": false
    }
  ]
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Query

​
communityJid
string
requerido
JID @g.us de la comunidad. Si omites el sufijo, el servicio agrega automáticamente @g.us.

​
Notas

  • El listado solo devuelve los subgrupos en los que está el bot, si el bot está solo en el padre pero no en el subgrupo X, X no aparece en la lista.
  • La propagación de nuevas vinculaciones puede demorar 1-3s, un GET justo después de POST /link puede devolver temporalmente la lista sin el grupo recién vinculado.
  • El Grupo de Anuncios siempre aparece con isDefaultSubGroup: true. Filtra del lado del cliente si necesitas excluirlo del listado.

​
Errores

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

​
Siguiente

Vincular grupos

Agrega nuevos subgrupos.

Desvincular grupos

Elimina subgrupos de la comunidad.