Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Mensajes programados

Ver el resultado por grupo de un envío

Sirve para ver el resultado del envío en cada grupo: estado, error, lecturas, reproducciones, reacciones y clics, opcionalmente para una ocurrencia puntual de un envío recurrente.

GET
/v1/scheduled-messages/{scheduledMessage}/group-messages

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 group_message_template.id, group_message_template.status, groups.name, group_message_template.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

scheduledMessage*string

The scheduled message ID

Formatouuid

Parámetros de consulta

name?string
orderBy?string
Valor en"group_message_template.id""group_message_template.status""groups.name""group_message_template.created_at"
orderByMethod?string
Valor en"asc""desc"
perPage?integer
Rango1 <= value <= 100
status?integer
edit_status?ScheduledMessageEditStatusEnum

Outcome of the latest edit of the sent text (edit-sent), kept apart from status, which stays the delivery state.

1 Confirmed delivered, inside the window: the provider accepted the edit.
2 Confirmed delivered, but 15 minutes had already passed since it was sent to that group.
3 Cloud API device, a channel, or a provider that cannot edit.
4 The provider returned an error, or the message never reached the group.
Valor en1234
run?string

Optional occurrence filter (D3): local calendar date (Y-m-d) of a run, resolved into a UTC window by ScheduledMessageRunService. Additive — omitting it preserves the exact previous behaviour (MAX(id) globally).

Formatodate

Cuerpo de la respuesta

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/scheduled-messages/497f6eca-6276-4993-bfeb-53cbbbba6f08/group-messages"
{  "data": [    {      "template_id": "string",      "group_id": "string",      "group_name": "string",      "campaign_name": "string",      "audience": "string",      "schedule_message_status": "string",      "error_info": null,      "totaL_readed": null,      "total_played": null,      "reactions_count": null,      "clicks": "string",      "sent_by": [        "string"      ],      "attempts": 0,      "last_attempt_at": "string",      "edit_status": "string",      "edit_reason": "string"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": "string",    "per_page": 0,    "to": 0,    "total": "string"  }}

Listar los grupos destino de un envío GET

Usalo para saber a qué grupos va dirigido un envío programado, filtrando por nombre o estado.

Ver las tasas de lectura y reproducción de un envío GET

Usalo para medir el alcance de un envío: audiencia total, cuántos lo leyeron y cuántos reprodujeron el contenido, en total o por ocurrencia.