Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Participantes

Listar entradas y salidas de una campaña

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.

GET
/v1/campaigns/{campaign}/participant-events

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).

Autorización

http
headerAuthorizationBearer <clave>

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

Parámetros de la ruta

campaign*integer

The campaign ID

Parámetros de consulta

search?|
Largolength <= 50
event_type?|
Valor en"all""join""leave"null
page?|
Rango1 <= value
perPage?|
Rango1 <= value <= 100
start_date?|
Formatodate-time
end_date?|
Formatodate-time
timezone?|
Largolength <= 64
date_mode?|
Valor en"both""joins_only""leaves_only"null
selection_type?|
Valor en"all""none"null
groups_uids[]?array<>
participant_filter?|
Valor en"all""active"null

Cuerpo de la respuesta

Paginated set of ParticipantEventResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/campaigns/0/participant-events"
{  "data": [    {      "phone": "string",      "whatsapp_id": "string",      "event_type": "join",      "event_at": "string",      "group_id": 0,      "group_name": "string",      "country_code": "string",      "country_name": "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 los participantes con su grupo actual GET

Usalo para saber en qué grupo está cada participante de una campaña, cuándo entró o salió y si sigue activo. Ideal para sincronizar miembros con tu CRM.

Listar los participantes de un grupo GET

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