Solicitações Pendentes

GET

api

group

requests

:instance

Solicitações Pendentes

curl --request GET \
  --url https://api.example.com/api/group/requests/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

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

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Lista as solicitações pendentes de ingresso em um grupo que tem requireAdminApproval=true. Apenas admins do grupo podem visualizar essa fila. Para aceitar ou rejeitar, use POST /participants com action=approve ou action=reject.

Exemplos

Listar pedidos

Retorna a fila de solicitações pendentes do grupo 120363406289005073@g.us. Cada entrada traz o LID e (quando disponível) o telefone de quem pediu para entrar.

curl -X GET "https://ryzeapi.cloud/api/group/requests/$Instance_Name?identifier=120363406289005073@g.us" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/requests/${process.env.Instance_Name}?identifier=120363406289005073@g.us`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/requests/{os.environ['Instance_Name']}?identifier=120363406289005073@g.us",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/requests/"+os.Getenv("Instance_Name")+"?identifier=120363406289005073@g.us", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Resposta de sucesso

Retorna a fila de solicitações pendentes em requests[], com meta.total indicando o tamanho. Cada entrada traz o jid em formato LID (@lid, para preservar a privacidade de quem solicitou) e, quando disponível, o phoneNumber correspondente. Use esses identificadores em /participants com action=approve ou action=reject para resolver cada pedido.

200 OK

{
  "success": true,
  "message": "2 pending requests found",
  "groupJid": "120363406289005073@g.us",
  "requests": [
    {
      "jid": "199789077627112@lid",
      "phoneNumber": "5511999999999@s.whatsapp.net",
      "requestedAt": "2026-04-20T14:00:00Z"
    }
  ],
  "meta": { "total": 2 }
}

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Query

string

obrigatório

JID, código de convite ou link do grupo.

Notas

O jid retornado vem em formato LID (@lid) para preservar a privacidade de quem solicitou, em alguns casos phoneNumber pode vir null.
Para aprovar ou rejeitar em lote, encaminhe esses JIDs (ou os PNs) para /participants.

Erros

HTTP	Mensagem
400	`Identifier is required`
403	`Not authorized to view group requests (must be admin)`
404	`Group not found or you are not a member of this group`

Envelope:

{
  "success": false,
  "error": { "message": "Not authorized to view group requests (must be admin)" }
}

Aprovar / rejeitar

Use action=approve ou action=reject em /api/group/participants.

Atualizar grupo

Ative ou desative requireAdminApproval.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Solicitações Pendentes

Descrição

Exemplos

Listar pedidos

Resposta de sucesso

Parâmetros de rota

Headers

Query

Notas

Erros

Próximo

Aprovar / rejeitar

Atualizar grupo

​Descrição

​Exemplos

​Listar pedidos

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Query

​Notas

​Erros

​Próximo

Aprovar / rejeitar

Atualizar grupo

Descrição

Exemplos

Listar pedidos

Resposta de sucesso

Parâmetros de rota

Headers

Query

Notas

Erros

Próximo