Saltar al contenido principal
POST
/
api
/
group
/
join
/
:instance
Unirse al grupo
curl --request POST \
  --url https://api.example.com/api/group/join/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "identifier": "<string>"
}
'

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 TokenInstanceRate-limit: Global (100/min) • Idempotente: parcial (las llamadas repetidas en un grupo abierto devuelven el mismo groupJid)

Descripción

Une al cliente a un grupo a partir de un código de invitación (ABC123XYZ) o de un enlace completo (https://chat.whatsapp.com/ABC123XYZ). Si el grupo tiene requireAdminApproval=true, la unión queda en cola y devuelve requiresApproval: true.
A diferencia de las otras rutas, /join no acepta un JID como identifier, solo un código o enlace.

Ejemplos

Por enlace

Se une al grupo pasando el enlace completo (https://chat.whatsapp.com/ABC123XYZ) en identifier. El servicio extrae el código automáticamente e intenta la unión.
curl -X POST "https://ryzeapi.cloud/api/group/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "https://chat.whatsapp.com/ABC123XYZ"
  }'

Por código

Se une al grupo pasando solo el código bruto (ABC123XYZ) en identifier. Útil cuando ya extrajiste el código del enlace en otro flujo.
curl -X POST "https://ryzeapi.cloud/api/group/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "ABC123XYZ"
  }'

Respuesta exitosa

El groupJid identifica el grupo al que la instancia se unió (o intentó unirse). Cuando requiresApproval: true, la unión aún no se efectivizó, está esperando aprobación manual de un administrador; revisa la cola de pendientes con /requests. Cuando es false, la instancia ya es miembro y puede enviar/recibir mensajes.
200 OK
{
  "success": true,
  "message": "Successfully joined the group",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": false
}
200 OK (con aprobación manual)
{
  "success": true,
  "message": "Join request sent successfully. Waiting for admin approval.",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": true
}

Parámetros de ruta

instance
string
requerido
Nombre de la instancia.

Cabeceras

token
string
requerido
TokenAccount o TokenInstance.
Content-Type
string
requerido
application/json

Cuerpo de la solicitud

identifier
string
requerido
Código de invitación (ABC123XYZ) o enlace completo (https://chat.whatsapp.com/ABC123XYZ).

Notas

  • requiresApproval: true significa que aún no te uniste, tu solicitud está en la cola listada por /requests hasta que un administrador la apruebe.
  • Cuando el enlace ha sido revocado por un administrador (mediante /resetLink), el código antiguo deja de funcionar inmediatamente.
  • Para previsualizar el grupo sin unirte, usa GET /info con el enlace como identifier.

Errores

HTTPMensaje
400Invalid invite link or code
400Invite link has been revoked or expired
403Not allowed to join this group
404Group not found
Envoltorio:
{
  "success": false,
  "error": { "message": "Invite link has been revoked or expired" }
}