Pular para o conteúdo principal
POST
/
api
/
group
/
join
/
:instance
Entrar em 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: parcial (chamadas repetidas em grupo aberto retornam o mesmo groupJid)

​
Descrição

Entra em um grupo a partir de um código (ABC123XYZ) ou link completo (https://chat.whatsapp.com/ABC123XYZ). Se o grupo tiver requireAdminApproval=true, a entrada fica pendente e retorna requiresApproval: true.
Diferente das outras rotas, /join não aceita JID como identifier, apenas código ou link.

​
Exemplos

Entra no grupo passando o link completo (https://chat.whatsapp.com/ABC123XYZ) em identifier. O serviço extrai o código automaticamente e tenta o ingresso. 
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

Entra no grupo passando apenas o código bruto (ABC123XYZ) em identifier, útil quando você já extraiu o código do link em outro fluxo. 
curl -X POST "https://ryzeapi.cloud/api/group/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "ABC123XYZ"
  }'

​
Resposta de sucesso

O groupJid identifica o grupo que a instância passou a integrar (ou tentou integrar). Quando requiresApproval: true, a entrada ainda não foi efetivada, está aguardando aprovação manual de um admin, confira a fila pendente em /requests. Quando false, a instância já é membro e pode enviar/receber mensagens.
200 OK
{
  "success": true,
  "message": "Successfully joined the group",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": false
}
200 OK (com aprovação manual)
{
  "success": true,
  "message": "Join request sent successfully. Waiting for admin approval.",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": true
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
identifier
string
obrigatório
Código de convite (ABC123XYZ) ou link completo (https://chat.whatsapp.com/ABC123XYZ).

​
Notas

  • requiresApproval: true significa que você ainda não entrou, sua entrada está na fila listada por /requests até que um admin aprove.
  • Quando o link foi revogado por um admin (via /resetLink), o código antigo deixa de funcionar imediatamente.
  • Para pré-visualizar o grupo sem entrar, use GET /info com o link como identifier.

​
Erros

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