Obtener participantes de un grupo

Obtiene los participantes de un chat de grupo y, opcionalmente, filtra los resultados por nombre, número de teléfono, rol o estado de contacto.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

GET https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}/participants

Obtiene los participantes de un chat de grupo y, opcionalmente, filtra los resultados por nombre, número de teléfono, rol o estado de contacto.

Si el WhatsApp ID del chat de destino no corresponde a un grupo, la API devolverá un error 400 Bad Request.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y prueba la API en el probador en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`search`	query	string	No	Filtra participantes por nombre, número de teléfono o WhatsApp ID `maxLength: 100`
`phone`	query	array	No	Filtra participantes por número de teléfono. Se permiten varios valores separados por comas. `minimum: 1` · `maximum: 50`
`role`	query	array	No	Filtra participantes por rol: `admin`, `owner` o `participant`. Se permiten varios valores separados por comas. `minimum: 1` · `maximum: 3`
`contact`	query	boolean	No	Filtra solo los participantes que son contactos en la agenda de WhatsApp
`include`	query	array	No	Incluye la información de contacto del participante, si está disponible. `minimum: 1` · `maximum: 1`
`page`	query	number	No	Número de página de resultados (comienza en 0) `minimum: 0` · `maximum: 500` · `default: 0` · `format: integer`
`size`	query	number	No	Máximo de resultados por página `minimum: 1` · `maximum: 500` · `default: 100` · `format: integer`

Respuestas

Código	Descripción
`200`	Participantes del grupo
`400`	Datos de consulta o cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos necesarios
`404`	Recurso no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Get group participants
curl --request GET \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}/participants \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"size":100,"page":0}'


// Get group participants by phone number
curl --request GET \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}/participants \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"phone":"+1234567890,+1298765431"}'


// Search group participants by name
curl --request GET \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}/participants \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"search":"john"}'


// Filter group participants by role
curl --request GET \
  --url https://api.getincloud.ai/v1/chat/{deviceId}/chats/{chatWid}/participants \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"role":"owner,admin"}'

AnteriorObtener información de entrega del mensaje SiguientePublicar nuevo estado

¿Te sirvió esta página?