Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Grupos

Listar grupos

Usalo para listar los grupos de tu cuenta con filtros por tipo, estado, número o sin campaña asignada, por ejemplo para sincronizarlos con tu sistema.

GET
/v1/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 created_at, id, name, 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 consulta

name?string
orderBy?string
orderByMethod?string
type?string
Valor en"1""2""3""4"
perPage?integer
status?string
Valor en"0""1""2""3""4""5""6""7""8"
deviceId?integer
noCampaign?boolean

Cuerpo de la respuesta

Paginated set of GroupResource

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

Grupos

Un grupo es un grupo de WhatsApp que administra uno de tus números, con o sin campaña asignada; acá también aparecen los canales y los grupos de anuncios de una comunidad.

Listar los grupos que administra un número GET

Sirve para ver los grupos que administra un número según lo que informa el proveedor de WhatsApp, por ejemplo para encontrar grupos que todavía no sumaste a una campaña.