Listar subgrupos

GET

api

community

listSubGroups

:instance

Listar subgrupos

curl --request GET \
  --url https://api.example.com/api/community/listSubGroups/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/community/listSubGroups/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch(`https://ryzeapi.cloud/api/community/listSubGroups/${process.env.Instance_Name}?communityJid=120363406289005073@g.us`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/community/listSubGroups/{os.environ['Instance_Name']}?communityJid=120363406289005073@g.us",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/community/listSubGroups/"+os.Getenv("Instance_Name")+"?communityJid=120363406289005073@g.us", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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"

await fetch(`https://ryzeapi.cloud/api/community/listSubGroups/${process.env.Instance_Name}?communityJid=120363406289005073`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/community/listSubGroups/{os.environ['Instance_Name']}?communityJid=120363406289005073",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/community/listSubGroups/"+os.Getenv("Instance_Name")+"?communityJid=120363406289005073", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Query

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

HTTP	Mensaje
400	`communityJid query parameter is required`
400	`invalid community JID: <reason>`
400	`Instance is not connected to WhatsApp`
500	`failed to get groups: <reason>`

Envoltorio:

{
  "success": false,
  "error": { "message": "communityJid query parameter is required" }
}

Vincular grupos

Agrega nuevos subgrupos.

Desvincular grupos

Elimina subgrupos de la comunidad.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Listar subgrupos

Descripción

Ejemplos

Listar subgrupos

Sin el sufijo @g.us

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores

Siguiente

Vincular grupos

Desvincular grupos

​Descripción

​Ejemplos

​Listar subgrupos

​Sin el sufijo @g.us

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Query

​Notas

​Errores

​Siguiente

Vincular grupos

Desvincular grupos

Descripción

Ejemplos

Listar subgrupos

Sin el sufijo @g.us

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores

Siguiente