Skip to content

실시간 활동 업데이트

post

/messages/live_activity/update

이 엔드포인트를 사용하여 iOS 앱에 표시되는 실시간 활동을 업데이트하고 종료할 수 있습니다. 이 엔드포인트에는 추가 설정이 필요합니다.

라이브 활동을 등록한 후 JSON 페이로드를 전달하여 Apple 푸시 알림 서비스(APN)를 업데이트할 수 있습니다. 자세한 내용은 푸시 알림 페이로드로 실시간 활동을 업데이트하는 방법에 대한 Apple 설명서를 참조하세요.

필수 구성 요소

이 엔드포인트를 사용하려면 다음을 완료해야 합니다:

  • messages.live_activity.update 권한을 사용하여 API 키를 생성합니다.
  • 브레이즈 스위프트 SDK를 사용하여 원격 또는 로컬로 라이브 활동을 등록하세요.

사용량 제한

API 속도 제한에 설명된 대로 이 엔드포인트에 시간당 250,000건의 기본 Braze 속도 제한을 적용합니다.

요청 본문

요청 매개변수

매개변수 필수 데이터 유형 설명
app_id 필수 문자열 API 키 페이지에서 검색한 앱 API 식별자입니다.
activity_id 필수 문자열 를 사용하여 라이브 활동을 등록할 때 launchActivity 를 사용하여 라이브 활동을 등록할 때 pushTokenTag 매개변수를 사용하여 활동의 푸시 토큰 이름을 사용자 지정 문자열로 지정합니다.

activity_id 을 이 사용자 지정 문자열로 설정하여 업데이트할 라이브 활동을 정의합니다.
content_state 필수 객체 라이브 활동을 만들 때 ContentState 매개변수를 정의합니다. 이 개체를 사용하여 ContentState에 대해 업데이트된 값을 전달합니다.

이 요청의 형식은 처음에 정의한 모양과 일치해야 합니다.
end_activity 선택 사항 부울 true, 이 요청은 라이브 활동을 종료합니다.
dismissal_date 선택 사항 날짜 시간
(ISO-8601 문자열)
이 매개변수는 사용자 UI에서 라이브 활동을 제거할 시간을 정의합니다. 이 시간이 과거이고 end_activitytrue인 경우, 라이브 활동이 즉시 삭제됩니다.

end_activityfalse 이거나 생략된 경우 이 매개변수는 라이브 활동만 업데이트합니다.
stale_date 선택 사항 날짜 시간
(ISO-8601 문자열)
이 매개변수는 라이브 활동 콘텐츠가 사용자 UI에서 오래된 것으로 표시되는 시점을 시스템에 알려줍니다.
notification 선택 사항 객체 객체를 포함하여 apple_push 객체를 포함하여 푸시 알림을 정의합니다. 이 푸시 알림의 동작은 사용자가 활성 상태인지 또는 사용자가 프록시 기기를 사용하고 있는지에 따라 달라집니다.
  • 다음과 같은 경우 notification 가 포함되어 있고 업데이트가 전달될 때 사용자가 iPhone에서 활성화되어 있으면 업데이트된 실시간 활동 UI가 아래로 슬라이드되어 푸시 알림처럼 표시됩니다.
  • 다음과 같은 경우 notification 가 포함되어 있고 사용자가 iPhone에서 활성화되어 있지 않으면 잠금 화면에 업데이트된 라이브 활동 UI가 표시되도록 화면이 켜집니다.
  • 그리고 notification alert 는 표준 푸시 알림으로 표시되지 않습니다. 또한 사용자에게 Apple Watch와 같은 프록시 디바이스가 있는 경우에는 alert 가 표시됩니다.

요청 예시

응답

이 엔드포인트에 대한 상태 코드 응답은 2014XX 두 가지입니다.

성공 응답의 예

요청 형식이 올바르게 지정되어 요청을 수신한 경우 201 상태 코드가 반환됩니다. 201 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.

오류 응답의 예

4XX 상태 코드 클래스는 클라이언트 오류를 나타냅니다. 발생할 수 있는 오류에 대한 자세한 내용은 API 오류 및 응답 문서를 참조하세요.

400 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.

이 페이지가 얼마나 도움이 되었나요?
New Stuff!