Pular para o conteúdo 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 ou TokenInstance em todas as rotas. Cada chamada valida a ownership da instância. Esta seção cobre todas as rotas /api/group/*, criação, listagem, detalhes, gerenciamento de participantes, atualização de metadados, reset de link de convite, entrada e saída. Para comunidades (grupos pais), veja Comunidades.

​
Endpoints

MétodoPathFunção
POST/api/group/create/:instanceCriar grupo
GET/api/group/list/:instanceListar grupos
GET/api/group/info/:instanceDetalhes de um grupo
PUT/api/group/update/:instanceAtualizar nome / descrição / foto / permissões
POST/api/group/participants/:instanceAdd / remove / promote / demote / approve / reject
POST/api/group/join/:instanceEntrar via código / link
POST/api/group/resetLink/:instanceRevogar e gerar novo invite link
GET/api/group/requests/:instanceListar solicitações pendentes
DELETE/api/group/leave/:instanceSair do grupo

​
Identifiers aceitos

A maioria dos endpoints aceita um campo identifier que pode ser:
FormaExemplo
JID do grupo120363406289005073@g.us
Código de conviteABC123XYZ
Link completohttps://chat.whatsapp.com/ABC123XYZ
Exceções:
  • POST /api/group/join aceita apenas código ou link (não aceita JID).
  • GET /api/community/listSubGroups exige JID em query ?communityJid=.

​
Estruturas de dados

​
GroupInfo

Resposta padrão das rotas de criação e atualização. 
{
  "name": "Time de Dev",
  "jid": "120363406289005073@g.us",
  "description": "Discussões técnicas",
  "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

Resposta de GET /info. Inclui campos extras além do GroupInfo: image, createdAt, metadata (autor da última alteração de nome / descrição), isEphemeral, isIncognito, isSuspended, isDefaultSubGroup.

​
GroupPermissions

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

​
Envelope de erro

Todas as rotas usam o envelope padrão da API: 
{
  "success": false,
  "error": { "message": "Identifier is required" }
}

​
Quadro de erros (resumo)

CategoriaMensagem
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
ValidaçãoIdentifier is required
ValidaçãoAt least one participant is required
ValidaçãoInvalid action. Must be one of: add, remove, promote, demote, approve, reject
Identifierfailed to resolve group from identifier (not a valid JID, code, or link)
Identifierinvalid group JID <jid>: <reason>
Identifiernot a group JID
EstadoInstance is not connected to WhatsApp
EstadoGroup not found or you are not a member of this group
ConviteInvite link has been revoked or expired
ConviteInvalid invite link or code
Throttlerate limit exceeded (429): wait before creating again

​
Próximo

Criar grupo

Cria um grupo novo com participantes iniciais.

Listar grupos

Retorna todos os grupos da instância.