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. Esta sección cubre todas las rutas /api/group/*: creación, listado, detalles, gestión de participantes, actualización de metadatos, restablecimiento del enlace de invitación, unión y salida. Para comunidades (grupos padre), consulta Comunidades.

​
Endpoints

MétodoRutaFunción
POST/api/group/create/:instanceCrear grupo
GET/api/group/list/:instanceListar grupos
GET/api/group/info/:instanceDetalles del grupo
PUT/api/group/update/:instanceActualizar nombre / descripción / imagen / permisos
POST/api/group/participants/:instanceAgregar / eliminar / promover / degradar / aprobar / rechazar
POST/api/group/join/:instanceUnirse mediante código / enlace
POST/api/group/resetLink/:instanceRevocar y regenerar el enlace de invitación
GET/api/group/requests/:instanceListar solicitudes pendientes
DELETE/api/group/leave/:instanceSalir del grupo

​
Identificadores aceptados

La mayoría de los endpoints aceptan un campo identifier, que puede ser:
FormaEjemplo
JID del grupo120363406289005073@g.us
Código de invitaciónABC123XYZ
Enlace completohttps://chat.whatsapp.com/ABC123XYZ
Excepciones:
  • POST /api/group/join acepta solo un código o enlace (no JID).
  • GET /api/community/listSubGroups requiere un JID en la query ?communityJid=.

​
Estructuras de datos

​
GroupInfo

Respuesta estándar para las rutas de creación y actualización. 
{
  "name": "Dev Team",
  "jid": "120363406289005073@g.us",
  "description": "Technical discussions",
  "inviteCode": "ABC123XYZ",
  "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
  "createdBy": "5511999999999@s.whatsapp.net",
  "participantCount": 3,
  "participants": [
    { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
  ],
  "groupSettings": {
    "membersCanEditInfo": true,
    "membersCanSendMessages": true,
    "membersCanAddOthers": false,
    "requireAdminApproval": false
  },
  "isCommunity": false,
  "isParent": false,
  "linkedParentJid": null
}

​
GroupDetail

Respuesta de GET /info. Incluye campos adicionales más allá de GroupInfo: image, createdAt, metadata (autor del último cambio de nombre / descripción), isEphemeral, isIncognito, isSuspended, isDefaultSubGroup.

​
GroupPermissions

CampoTipoSignificado en WhatsApp
membersCanEditInfoboolInverso de IsLocked
membersCanSendMessagesboolInverso de IsAnnounce
membersCanAddOthersboolMemberAddMode == AllMember
requireAdminApprovalboolIsJoinApprovalRequired

​
Envoltorio de error

Todas las rutas usan el envoltorio estándar de la API: 
{
  "success": false,
  "error": { "message": "Identifier is required" }
}

​
Referencia de errores (resumen)

CategoríaMensaje
AuthNot authorized to view group requests (must be admin)
AuthNot authorized to perform this action (must be admin)
AuthNot authorized to update this group (must be admin)
AuthNot authorized to reset group invite link (must be admin)
AuthNot allowed to join this group
AuthNot allowed to leave this group
ValidaciónIdentifier is required
ValidaciónAt least one participant is required
ValidaciónInvalid action. Must be one of: add, remove, promote, demote, approve, reject
Identificadorfailed to resolve group from identifier (not a valid JID, code, or link)
Identificadorinvalid group JID <jid>: <reason>
Identificadornot a group JID
EstadoInstance is not connected to WhatsApp
EstadoGroup not found or you are not a member of this group
InvitaciónInvite link has been revoked or expired
InvitaciónInvalid invite link or code
Throttlerate limit exceeded (429): wait before creating again

​
Siguiente

Crear grupo

Crea un nuevo grupo con participantes iniciales.

Listar grupos

Devuelve todos los grupos de la instancia.