Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Campañas

Ver una campaña

Sirve para ver la configuración completa de una campaña: sus grupos, administradores, link de redirección, distribución del tráfico, píxel y grupos desconectados o con error.

GET
/v1/campaigns/{campaign}

Permiso requerido: communities:read (Leer)

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

Cuerpo de la respuesta

CampaignResource

application/json
  1. response
id*string
uuid*string
name*string
slug*string
photo*string|
description*string|
pixel*string
admins*string
group_admins*string
disconnected_groups*string
connection_error_groups*string
deviceId*string
userId*string
type*string
groups*string
is_active*string
redirect_url*string
traffic_distribution_type*string|null
fill_groups_enabled*string
group_numbering_position*string|null
anti_bot_verification_enabled*string
custom_domain*string
captcha_enabled*string
virtual_queue_enabled*boolean
virtual_queue_rate_per_minute*integer
group_name_variations*string
moderation*
members_can_send_messages*string
clicks_limit*string
participants_limit*string
backup_groups_count*string|
admins_per_group*string
input_tag*string
output_tag*string
send_always_same_group*string
total_participants*string
total_clicks*string
total_in*string
total_out*string
total_in_counter*integer

Additive fields backed by the maintained conversion counters (SUM over groups.total_joins/total_leaves), populated by the group sync (Inc.1) and the amortized groups:backfill-conversion-counters command (Inc.2) — no longer backfilled on read. These coexist with the calculated total_in/ total_out above during the rollout; a later, separate change will drop the calculated fields once the counters are fully populated. (int) casts the SUM's possible NULL (all-NULL groups) to 0 for a consistent number type. Scoped by groups.user_id = campaign.user_id — same defensive scoping already applied to groups/total_clicks in CampaignsResource (listing).

total_out_counter*integer
auto_create_groups*boolean
group_creation_suspended*string|boolean
suspended_creator_phones*string|array<string>
group_creation_has_available_creator*string|boolean
api_policy?

api-group-campaigns change, design D8: ONLY for the Grupo API type — spec api-group-campaign-policy § "Campaña de otro tipo no tiene política API" ("la respuesta no incluye política de grupos API, y el consumidor tolera su ausencia"). $this->when() omits the key entirely for the other three types, rather than emitting it as null.

curl -X GET "https://example.com/v1/campaigns/0"
{  "id": "string",  "uuid": "string",  "name": "string",  "slug": "string",  "photo": "string",  "description": "string",  "pixel": "string",  "admins": "string",  "group_admins": "string",  "disconnected_groups": "string",  "connection_error_groups": "string",  "deviceId": "string",  "userId": "string",  "type": "string",  "groups": "string",  "is_active": "string",  "redirect_url": "string",  "traffic_distribution_type": "string",  "fill_groups_enabled": "string",  "group_numbering_position": "string",  "anti_bot_verification_enabled": "string",  "custom_domain": "string",  "captcha_enabled": "string",  "virtual_queue_enabled": true,  "virtual_queue_rate_per_minute": 0,  "group_name_variations": "string",  "moderation": {    "type": "string",    "insults_and_profanity": "string",    "negative_comments": "string",    "repetitive_spam": "string",    "external_links": "string",    "promotions_and_sales": "string",    "off_topic": "string"  },  "members_can_send_messages": "string",  "clicks_limit": "string",  "participants_limit": "string",  "backup_groups_count": "string",  "admins_per_group": "string",  "input_tag": "string",  "output_tag": "string",  "send_always_same_group": "string",  "total_participants": "string",  "total_clicks": "string",  "total_in": "string",  "total_out": "string",  "total_in_counter": 0,  "total_out_counter": 0,  "auto_create_groups": true,  "group_creation_suspended": "string",  "suspended_creator_phones": "string",  "group_creation_has_available_creator": "string",  "api_policy": {    "property1": null,    "property2": null  }}

Listar campañas GET

Usalo para listar las campañas de grupos de WhatsApp de tu cuenta, con búsqueda por nombre, y obtener sus IDs para consultar grupos, participantes o estadísticas.

Ver las condicionales de una campaña GET

Usalo para conocer las reglas condicionales de una campaña: qué condiciones evalúa y a qué URL o grupo redirige cuando se cumplen.