1. Instances
Way API
  • Raiz
    • Customers
      • Criar conta de cliente
      • Ver meus dados
      • Atualizar meus dados
    • Instances
      • Listar instâncias
        GET
      • Criar instância
        POST
      • Atualizar nome da instância
        PATCH
      • Remover instância
        DELETE
      • Listar chats da instância
        GET
      • Conectar instância
        POST
      • Desconectar instância
        POST
      • Consultar detalhes de grupo
        GET
      • Consultar status da instância
        GET
    • Messages
      • Enviar mensagem com imagem
      • Enviar mensagem com preview de link
      • Listar mensagens pendentes da fila de envio
      • Limpar mensagens pendentes da fila de envio
      • Enviar mensagem de texto
    • Webhooks
      • Criar ou atualizar webhook
      • Desativar webhook
  • Esquemas
    • AcceptedMessageResponse
    • AudioMessageReceivedContent
    • AudioMessageReceivedWebhookPayload
    • Chat
    • ClearPendingMessagesResponse
    • ConnectInstanceRequest
    • ConnectInstanceResponse
    • ContactMessageReceivedContent
    • ContactMessageReceivedItem
    • ContactMessageReceivedWebhookPayload
    • CreateCustomerRequest
    • CreateCustomerResponse
    • CreateInstanceRequest
    • CreateInstanceResponse
    • CustomerOutput
    • DeleteInstanceResponse
    • DisconnectInstanceResponse
    • DocumentMessageReceivedContent
    • DocumentMessageReceivedWebhookPayload
    • ErrorResponse
    • GetGroupDetailsResponse
    • GetInstanceStatusResponse
    • GifMessageReceivedContent
    • GifMessageReceivedWebhookPayload
    • GroupDetails
    • GroupParticipantUpdateItem
    • GroupParticipantsUpdateMessageReceivedContent
    • GroupParticipantsUpdateMessageReceivedWebhookPayload
    • ImageMessageReceivedContent
    • ImageMessageReceivedWebhookPayload
    • InboundWebhookPayload
    • InboundWebhookPayloadBase
    • IncomingMediaPayload
    • InstanceOutput
    • InstanceWebhookOutput
    • InviteLink
    • JsonContentTypeHeader
    • ListChatsResponse
    • ListInstancesResponse
    • ListPendingMessagesResponse
    • LocationMessageReceivedContent
    • LocationMessageReceivedWebhookPayload
    • MessageFailedWebhookError
    • MessageFailedWebhookPayload
    • MessageReceiptDetails
    • MessageReceiptUpdateMessageReceivedContent
    • MessageReceiptUpdateMessageReceivedWebhookPayload
    • MessageSentWebhookPayload
    • PendingMessageOutput
    • PinMessageInChatMessageReceivedContent
    • PinMessageInChatMessageReceivedWebhookPayload
    • PinMessageReferencedMessage
    • PtvMessageReceivedContent
    • PtvMessageReceivedWebhookPayload
    • ReactionMessageReceivedContent
    • ReactionMessageReceivedWebhookPayload
    • ReactionReferencedMessage
    • ReceiptReferencedMessage
    • SendImageRequest
    • SendLinkRequest
    • SendTextRequest
    • StickerMessageReceivedContent
    • StickerMessageReceivedWebhookPayload
    • TextMessageReceivedContent
    • TextMessageReceivedWebhookPayload
    • UnknownMessageReceivedContent
    • UnknownMessageReceivedWebhookPayload
    • UpdateCustomerRequest
    • UpdateInstanceNameRequest
    • UpdateInstanceNameResponse
    • UpsertWebhookRequest
    • VideoMessageReceivedContent
    • VideoMessageReceivedWebhookPayload
    • WebhookOutput
    • WebhookPayload
  1. Instances

Consultar detalhes de grupo

Amb. de Desenv.
http://localhost:3000
Amb. de Desenv.
http://localhost:3000
GET
/instances/{instanceId}/groups/{groupChatId}
Retorna os detalhes de um grupo visível para a instância autenticada.
Observações:
a instância precisa estar conectada
o grupo precisa pertencer à instância consultada
o inviteLink pode retornar error: true quando o runtime nao conseguir gerar o codigo de convite

Requisição

Authorization
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK
application/json
The request has succeeded.
Bodyapplication/json

🟠400Requisição Inválida
🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
🟠422Erro de Parâmetro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://localhost:3000/instances//groups/' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Detalhes de grupo
{
    "chatId": "120363123456789@g.us",
    "name": "Grupo Comercial",
    "participants": [
        "5511999999999@s.whatsapp.net"
    ],
    "admins": [
        "5511999999999@s.whatsapp.net"
    ],
    "superAdmins": [
        "5511888888888@s.whatsapp.net"
    ],
    "inviteLink": {
        "error": false,
        "message": null,
        "link": "https://chat.whatsapp.com/abc123"
    }
}
Modificado em 2026-06-12 15:08:32
Página anterior
Desconectar instância
Próxima página
Consultar status da instância
Built with