Referencia (endpoints)Envíos programados

Ver cómo salió un envío en cada grupo

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: Grupos y campañas → Ver

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 clave de API de Funnelchat, en la cabecera Authorization: Bearer de cada llamada.

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

Filtra por el resultado de la última edición del texto ya enviado. Es distinto de status, que es el estado de la entrega.

1 El mensaje se había entregado y la edición se aplicó dentro del plazo.
2 El mensaje se había entregado, pero ya habían pasado 15 minutos desde el envío a ese grupo.
3 El mensaje salió con un número oficial, a un canal o con un número que no permite editar.
4 WhatsApp devolvió un error, o el mensaje nunca llegó al grupo.
Valor en1234
run?string

Fecha (AAAA-MM-DD, en la zona horaria de la cuenta) de una ocurrencia del envío: devuelve el resultado de cada grupo en esa ocurrencia. Sin este parámetro, devuelve el último resultado de cada grupo.

Formatodate

Cuerpo de la respuesta

Resultado del envío en cada grupo, paginado.

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": "snd_Aa722thR6FCue9NVxngPN1w",      "group_id": "grp_AK2GMGeWAAdd8fZbtOVvE3Z",      "group_name": "string",      "campaign_name": "string",      "audience": "string",      "schedule_message_status": "string",      "error_info": "string",      "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"  }}

Esto es lo que se copia para tu IA

Cargando…