Skip to content

Liste der anstehenden geplanten Campaigns und Canvases

get

/messages/scheduled_broadcasts

Verwenden Sie diesen Endpunkt, um eine JSON-Liste mit Informationen über geplante Campaigns und Eingangs-Canvases zwischen jetzt und einer in der Anfrage angegebenen end_time zurückzugeben.

Tägliche, wiederkehrende Nachrichten erscheinen nur einmal mit ihrem nächsten Vorkommen. Die über diesen Endpunkt zurückgegebenen Ergebnisse umfassen Campaigns und Canvases, die im Braze-Dashboard erstellt und geplant wurden.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung messages.schedule_broadcasts.

Rate-Limits

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
end_time Erforderlich String im ISO-8601-Format Enddatum des Bereichs zum Abrufen der anstehenden geplanten Campaigns und Canvases. Dies wird von der API als Mitternacht in UTC-Zeit behandelt.

Beispielanfrage

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'

Antwort

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!