Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Participantes

Listar los participantes de una campaña

Sirve para listar los participantes de una campaña, con búsqueda por teléfono y si son administradores.

GET
/v1/campaigns/{campaign}/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 updated_at, id, created_at; dirección orderByMethod: 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 la ruta

campaign*integer

The campaign ID

Parámetros de consulta

phone?string|null
orderBy?string|null
orderByMethod?|
Valor en"asc""desc"null
perPage?|
Rango1 <= value

Cuerpo de la respuesta

Paginated set of ParticipantResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/campaigns/0/participants"
{  "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  }}

Participantes

Un participante es una persona que está o estuvo en un grupo de una campaña, identificada por teléfono (phone), con su grupo actual, fechas de entrada y salida (joined_at, left_at), estado y si es administrador.

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.