Skip to content

Listar próximas Campaigns y Canvas programados

get

/messages/scheduled_broadcasts

Usa este punto de conexión para devolver una lista JSON de información sobre Campaigns programadas y Canvas de entrada entre ahora y un end_time designado especificado en la solicitud.

Los mensajes diarios y recurrentes solo aparecerán una vez con su siguiente ocurrencia. Los resultados devueltos en este punto de conexión incluyen Campaigns y Canvas creados y programados en el panel de Braze.

See me in Postman

Requisitos previos

Para usar este punto de conexión, necesitarás una clave de API con el permiso messages.schedule_broadcasts.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto de conexión, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
end_time Obligatorio Cadena en formato ISO-8601 Fecha de fin del intervalo para recuperar las próximas Campaigns y Canvas programados. La API lo considera medianoche en hora UTC.

Ejemplo de solicitud

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2018-09-01T00:00:00-04:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12

{
  "scheduled_broadcasts": [
    {
      "name": (string) the name of the scheduled broadcast,
      "id": (stings) the Canvas or campaign identifier,
      "type": (string) the broadcast type either Canvas or Campaign,
      "tags": (array) an array of tag names formatted as strings,
      "next_send_time": (string) The next send time formatted in ISO 8601, may also include time zone if not local/intelligent delivery,
      "schedule_type": (string) The schedule type, either local_time_zones, intelligent_delivery or the name of your company's time zone
    }
  ]
}
New Stuff!