Répertorier les campagnes et Canvas planifiés à venir
get
/messages/scheduled_broadcasts
Utilisez cet endpoint pour renvoyer une liste JSON des informations sur les campagnes planifiées et les Canvas saisis entre maintenant et un
end_time
spécifié dans la demande.
Les messages quotidiens et récurrents n’apparaîtront qu’une seule fois lors de leur occurrence suivante. Les résultats renvoyés dans cet endpoint comprennent les campagnes et les toiles créées et planifiées dans le tableau de bord Braze.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation messages.schedule_broadcasts
.
Limite de débit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
end_time |
Requis | Chaîne de caractères au format ISO-8601 | Date de fin de la plage pour récupérer les campagnes et Canvas planifiés. Ce traitement est effectué à minuit (UTC) par l’API. |
Exemple de demande
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'
Réponse
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"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!