Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Iniciar atividade ao vivo

post

/messages/live_activity/start

Use esse endpoint para iniciar remotamente Live Activities exibidas no seu app para iOS. Esse endpoint requer configuração adicional.

Depois de criar uma Live Activity, faça uma solicitação POST para direcionar um segmento, um público conectado ou usuários específicos. Identifique usuários específicos por ID de usuário externo, alias de usuário ou ambos. Para saber mais sobre as Live Activities da Apple, consulte Como iniciar e atualizar Live Activities com notificações por push do ActivityKit.

Se content-available não estiver definido, a prioridade padrão do serviço de Notificações por Push da Apple (APN) é 10. Se content-available estiver definido, essa prioridade é 5. Para saber mais, consulte objeto de push da Apple.

Importante

Depois de uma solicitação /messages/live_activity/start bem-sucedida, aguarde pelo menos 5 minutos antes de enviar a primeira solicitação /messages/live_activity/update para o mesmo activity_id. Essa postergação dá à Braze e ao APN tempo para registrar a nova Live Activity e o mapeamento do token dela. Se você enviar a primeira atualização cedo demais, ela pode não ser aplicada à atividade.

Dica

Para encerrar uma Live Activity, use o endpoint /messages/live_activity/update com end_activity definido como true.

Como configurar o encerramento automático

Para configurar o encerramento automático após o início de uma Live Activity, agende no seu backend uma solicitação posterior para o endpoint de atualização.

Envie uma solicitação /messages/live_activity/start com um activity_id que você possa reutilizar depois.
Armazene esse activity_id e o horário de encerramento desejado no agendador do seu backend.
No horário de encerramento desejado, envie uma solicitação /messages/live_activity/update com end_activity definido como true.
Configure o comportamento de encerramento na mesma solicitação de atualização. Para mais detalhes, consulte o endpoint /messages/live_activity/update.
Verifique os eventos de envio e resultado no Registro de atividades de envio de mensagem.

See me in Postman

Endpoint reference

This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/pt-br/assets/api/openapi/messaging_live_activity_start.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.

New Stuff!