Referencia (endpoints)Envíos programados

Ver tus envíos programados

Úsalo para listar tus envíos programados a grupos con su estado, fecha, recurrencia y campañas, filtrando por carpeta o por los que necesitan reconectar un número.

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

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

Con true, solo los envíos pendientes o en curso que tienen grupos sin un número conectado que pueda enviar. Acepta true, false, 1 o 0.

Valor en"true""false""1""0"
folder_id?|

Id opaco: un texto que empieza con fdr_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^fdr_[A-Za-z0-9]{23}$
unclassified?string
Valor en"true""false""1""0"

Cuerpo de la respuesta

Paginated set of ScheduledMessageIndexResource

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/v1/scheduled-messages"
{  "data": [    {      "id": "smg_Ap5avHiKWWEBpqsQuJLOBCt",      "uuid": "string",      "name": "string",      "send_at": "string",      "status": "string",      "is_draft": "string",      "blocked_by_plan_limit": true,      "type": "string",      "folder_id": "fdr_AcPR1j7N9cs1PrbzZmC0ZiK",      "campaign_ids": [        "cmp_A6RMvAOjr0mHuLr08RpcwWu"      ],      "excluded_group_ids": [        "grp_AK2GMGeWAAdd8fZbtOVvE3Z"      ],      "can_be_edited": "string",      "recurrence": {        "enabled": true,        "frequency": "string",        "interval": "string",        "week_days": "string",        "end_type": "string",        "end_date": "string",        "occurrences": "string",        "current_occurrence": "string",        "only_new_groups": "string",        "only_full_groups": "string"      }    }  ],  "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  }}

Esto es lo que se copia para tu IA

Cargando…