Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Operaciones de campaña

Listar los grupos de una campaña

Usalo para listar los grupos de una campaña con su estado, origen y conexión del administrador, por ejemplo para detectar grupos llenos o desconectados.

GET
/v1/campaigns/{campaign}/groups

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 id, name, created_at, updated_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

name?string
orderBy?string
orderByMethod?string
perPage?integer
deviceId?integer
status?integer
origin?integer
Valor en"0""1"
adminConnection?integer
Valor en"1""2""3"
adminPhone?string

Cuerpo de la respuesta

Paginated set of GroupResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/campaigns/0/groups"
{  "data": [    {      "id": "string",      "admins_numbers": "string",      "admins": [        {          "phone": "string",          "lid": "string",          "isConnected": true,          "displayPhone": "string",          "accessDenied": true        }      ],      "admins_count": "string",      "owner": "string",      "owner_display_phone": "string",      "owner_connected": true,      "clicks": "string",      "communityUid": "string",      "newsletterUid": "string",      "description": "string",      "deviceId": "string",      "image": "string",      "isFull": "string",      "isApi": true,      "link": "string",      "campaign_link": "string",      "campaign_custom_domain": "string",      "name": "string",      "order": "string",      "participants_numbers": "string",      "participants_count": "string",      "status": "string",      "uid": "string",      "updatedAt": "string",      "createdAt": "string",      "scheduled_message_count": "string",      "type": "string",      "manual_import": true,      "origin": 1,      "lastSyncAt": "string",      "property1": null,      "property2": null    }  ],  "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 grupos que se pueden sumar a una campaña GET

Sirve para ver qué grupos, grupos de anuncios o canales de tu cuenta se pueden sumar a una campaña, filtrando por número o por nombre.

Listar los pipelines de una campaña GET

Sirve para seguir las operaciones masivas sobre los grupos de una campaña (cambios de nombre, foto, descripción, administradores o participantes), filtrando por estado o tipo de acción.