Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Participantes

Listar los participantes de un grupo

Usalo para listar los participantes de un grupo, filtrando por teléfono, si son administradores o si se los puede promover a administrador.

GET
/v1/groups/participants

Permiso requerido: communities:read (Leer)

Con API key: la respuesta siempre viene paginada. Tamaño de página: perPage (por defecto 25, máximo 100; un valor mayor, menor que 1 o no entero responde 422). Orden: orderBy acepta created_at, id, updated_at; dirección orderDirection: asc o desc. Otro valor responde 422.

Autorización

http
headerAuthorizationBearer <clave>

Tu API key de Funnelchat, enviada en cada llamada como Authorization: Bearer <id>|fc_live_....

Parámetros de consulta

groupUid*string
phone?string
isAdmin?string
Valor en"true""false""1""0"
eligibleForAdmin?string
Valor en"true""false""1""0"
orderBy?string
orderDirection?string
Valor en"asc""desc"
perPage?integer

Cuerpo de la respuesta

Paginated set of ParticipantResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/groups/participants?groupUid=string"
{  "data": [    {      "id": "string",      "phone": "string",      "action": "string",      "isAdmin": "string",      "created_at": "string"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}

Listar entradas y salidas de una campaña GET

Sirve para obtener el registro de entradas y salidas de toda una campaña, con fecha, grupo y país, filtrando por tipo de evento, fechas o grupos.

Listar entradas y salidas de un grupo GET

Sirve para ver quién entró y salió de un grupo puntual y cuándo, con país y filtros por fecha o tipo de evento.