Liste as próximas campanhas e telas programadas
get
/messages/scheduled_broadcasts
Use esse ponto de extremidade para retornar uma lista JSON de informações sobre campanhas agendadas e canvas de entrada entre agora e um
end_time
designado especificado na solicitação.
As mensagens diárias e recorrentes aparecerão apenas uma vez em sua próxima ocorrência. Os resultados retornados nesse endpoint incluem campanhas e Canvas criados e programados no dashboard do Braze.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão messages.schedule_broadcasts
.
Limite de taxa
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
end_time |
Obrigatória | String no formato ISO-8601 | Data de ponta a ponta do intervalo para recuperar as próximas campanhas e telas programadas. Isso é tratado como meia-noite no horário UTC pela API. |
Exemplo de solicitação
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'
Resposta
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!