Skip to main content
POST
Consultar detalles y miembros de un grupo

Autorizaciones

token
string
header
requerido

Cuerpo

application/json
groupjid
string
requerido

Identificador único del grupo (JID)

Ejemplo:

"120363153742561022@g.us"

Opcional/avanzado: solicita la invitación, disponible solo para un administrador con permiso confirmado.

Ejemplo:

true

getRequestsParticipants
boolean
predeterminado:false

Opcional/avanzado: solicita las solicitudes de ingreso, disponibles solo para un administrador con permiso confirmado.

Ejemplo:

false

force
boolean
predeterminado:false

Avanzado: solicita una actualización remota. El uso normal solo requiere groupjid.

Ejemplo:

false

Respuesta

Información del grupo obtenida con éxito

Representa un grupo/conversación colectiva

JID
string<jid>

Identificador único del grupo

Ejemplo:

"jid8@g.us"

OwnerJID
string<jid>

JID del propietario del grupo

Ejemplo:

"1232@s.whatsapp.net"

OwnerPN
string<jid>

Número/LID del propietario (cuando esté disponible)

Name
string

Nombre del grupo

Ejemplo:

"Grupo de Soporte"

NameSetAt
string<date-time>

Fecha del último cambio del nombre

NameSetBy
string<jid>

JID del usuario que definió el nombre

NameSetByPN
string<jid>

LID/PN de quien definió el nombre

Topic
string

Descripción del grupo

TopicID
string

ID interno de la descripción

TopicSetAt
string<date-time>

Fecha del último cambio de la descripción

TopicSetBy
string<jid>

JID de quien modificó la descripción

TopicSetByPN
string<jid>

LID/PN de quien modificó la descripción

TopicDeleted
boolean

Indica si la descripción fue eliminada

IsLocked
boolean

Indica si solo los administradores pueden editar la información del grupo

  • true = solo los admins pueden editar
  • false = todos pueden editar
Ejemplo:

true

IsAnnounce
boolean

Indica si solo los administradores pueden enviar mensajes

AnnounceVersionID
string

Versión de la configuración de anuncios

IsEphemeral
boolean

Indica si los mensajes son temporales

DisappearingTimer
integer

Tiempo en segundos para la desaparición de mensajes

Rango requerido: x >= 0
IsIncognito
boolean

Indica si el grupo es incógnito

IsParent
boolean

Indica si es un grupo principal (comunidad)

IsJoinApprovalRequired
boolean

Indica si se requiere aprobación para nuevos miembros

LinkedParentJID
string<jid>

JID de la comunidad vinculada

IsDefaultSubGroup
boolean

Indica si es un subgrupo predeterminado de la comunidad

DefaultMembershipApprovalMode
string

Modo predeterminado de aprobación de miembros (cuando es comunidad)

GroupCreated
string<date-time>

Fecha de creación del grupo

CreatorCountryCode
string

Código de país del creador

ParticipantVersionID
string

Versión de la lista de participantes

Participants
object[] | null

Lista de participantes. Es null cuando se omite por noParticipants y puede estar vacía cuando participant_profiles está presente.

MemberAddMode
enum<string>

Modo de incorporación de nuevos miembros

Opciones disponibles:
,
admin_add,
all_member_add
AddressingMode
enum<string>

Direccionamiento preferido del grupo

Opciones disponibles:
,
pn,
lid
OwnerCanSendMessage
boolean

Verifica si es posible enviar mensajes

OwnerIsAdmin
boolean

Indica privilegio de administrador confirmado. Puede estar ausente cuando es falso; los datos parciales no otorgan privilegio de administrador.

DefaultSubGroupId
string

Si el grupo actual es una comunidad, este campo mostrará el ID del subgrupo de avisos

Enlace de invitación, expuesto solo para administradores con permiso confirmado. Puede estar ausente; no asuma que toda lectura consulta WhatsApp.

request_participants
string

Solicitudes de ingreso conocidas, separadas por coma. Expuesto solo para administradores cuando se solicita.

image_url
string

URL de la imagen completa ya persistida; la API no consulta WhatsApp durante el listado

image_preview_url
string

URL de la vista previa ya persistida

picture_id
string

Identificador de la imagen completa en WhatsApp

picture_preview_id
string

Identificador de la vista previa en WhatsApp

picture_empty_at
string<date-time>

Última confirmación de que el grupo no tenía imagen

image_checked_at
string<date-time>

Última consulta de la imagen completa

image_preview_checked_at
string<date-time>

Última consulta de la vista previa

parent_community
object

Resumen de la comunidad principal de un subgrupo

participant_profiles
object[]

Perfiles adicionales de los participantes, cuando estén disponibles. Los campos ausentes no deben inferirse.

ParticipantCount
integer

Cantidad conocida de participantes. Puede diferir del tamaño de la lista cuando los datos son parciales o se omitieron de la respuesta.

Rango requerido: x >= 0
request_participants_lid
string

LIDs de las solicitudes de ingreso conocidas, separados por coma; solo para administrador cuando se solicita.