Saltar al contenido principal

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 en cada ruta. Cada llamada valida la propiedad de la instancia. Las comunidades son “grupos padre” de WhatsApp que agrupan otros grupos como subgrupos. Esta sección cubre las rutas /api/community/* para crear, vincular, desvincular y listar subgrupos. Para grupos regulares, consulta Grupos.

​
Endpoints

MétodoRutaFunción
POST/api/community/create/:instanceCrear comunidad
POST/api/community/link/:instanceVincular grupos a la comunidad
POST/api/community/unlink/:instanceDesvincular grupos
GET/api/community/listSubGroups/:instanceListar subgrupos

​
Cómo funciona

Una comunidad de WhatsApp se compone de:
  • Grupo padre (la comunidad en sí), donde administras todo
  • Grupo de Anuncios, creado automáticamente. Solo los administradores publican, pero todos los miembros de los subgrupos reciben los mensajes
  • Subgrupos, grupos regulares vinculados a la comunidad
Cada grupo pertenece a como máximo una comunidad a la vez. Para mover un grupo de una comunidad a otra, desvincula primero y luego vincula al destino.

​
Identificadores

  • La mayoría de las rutas esperan JIDs @g.us en communityJid y groupJid.
  • GET /listSubGroups requiere ?communityJid= en el query string.

​
Estructuras de respuesta

​
Respuesta de /create

{
  "success": true,
  "message": "Community created successfully",
  "linkedGroups": ["120363406289005074@g.us"],
  "failedGroups": [],
  "imageError": null,
  "group": {
    "name": "Alpha Community",
    "jid": "120363406289005073@g.us",
    "isCommunity": true,
    "isParent": true,
    "linkedParentJid": null
  }
}

{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": ["120363406289005074@g.us", "120363406289005075@g.us"],
  "failed": []
}
En el endpoint /unlink, el campo se llama linked pero contiene los JIDs desvinculados con éxito (DTO compartido). Usa el message ("Unlinked N of M ...") para desambiguar.

​
Respuesta de /listSubGroups

{
  "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 }
  ]
}
isDefaultSubGroup=true indica el Grupo de Anuncios predeterminado de la comunidad.

​
Envoltorio de error

{
  "success": false,
  "error": { "message": "community jid is required" }
}

​
Siguiente

Crear comunidad

Crea el grupo padre y vincula subgrupos iniciales.

Listar subgrupos

Devuelve los grupos vinculados.