Entrar em Grupo

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>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({identifier: '<string>'})
};

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

import requests

url = "https://api.example.com/api/group/join/:instance"

payload = { "identifier": "<string>" }
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

Por link

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"
  }'

await fetch(`https://ryzeapi.cloud/api/group/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "https://chat.whatsapp.com/ABC123XYZ"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "https://chat.whatsapp.com/ABC123XYZ"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "identifier": "https://chat.whatsapp.com/ABC123XYZ"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"
  }'

await fetch(`https://ryzeapi.cloud/api/group/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "ABC123XYZ"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "ABC123XYZ"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "identifier": "ABC123XYZ"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

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

HTTP	Mensagem
400	`Invalid invite link or code`
400	`Invite link has been revoked or expired`
403	`Not allowed to join this group`
404	`Group not found`

Envelope:

{
  "success": false,
  "error": { "message": "Invite link has been revoked or expired" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Entrar em Grupo

Descrição

Exemplos

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Por link

​Por código

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros