iOS 실시간 현황 API

Apple 문서:

실시간 현황에 대하여

ActivityKit 푸시 알림으로 실시간 현황 업데이트 및 종료하기

startLiveActivity

이 메서드를 사용하여 iOS 실시간 현황을 생성합니다.

POST https://api.pushwoosh.com/json/1.3/startLiveActivity

iOS 실시간 현황을 생성할 수 있습니다.

요청 본문

매개변수	유형	필수/선택	설명
application	String	필수	Pushwoosh 애플리케이션 코드
auth	String	필수	Pushwoosh Control Panel의 API 액세스 토큰.
notifications	Array	필수	메시지 매개변수의 JSON 배열입니다. 자세한 내용은 아래의 Notifications 표를 참조하세요.

Notifications

notifications 배열에 사용되는 매개변수:

매개변수	유형	필수/선택	설명
content	String	필수	실시간 현황을 지원하지 않는 iOS 16.1 미만 버전의 기기를 위한 대체 콘텐츠입니다. iOS 16.1 이상(실시간 현황 지원)에서는 `live_activity` 필드에서 콘텐츠를 가져옵니다.
title	String	선택	알림 메시지의 제목입니다.
live_activity	Object	필수	iOS에서 실시간 현황을 생성하기 위한 실시간 현황 데이터입니다.
content-state	Object	필수	실시간 현황 알림의 콘텐츠입니다.
attributes-type	String	필수	실시간 현황에서 사용되는 속성의 유형입니다.
attributes	Object	필수	실시간 현황의 속성입니다.
live_activity_id	String	필수	사용자가 생성한 실시간 현황의 고유 ID입니다.

응답

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

요청 예시

{
  "request": {
    "application": "XXXXX-XXXXX",        // 필수. Pushwoosh 애플리케이션 코드
    "auth": "yxoPUlwqm…………pIyEX4H",      // 필수. Pushwoosh Control Panel의 API 액세스 토큰
    "notifications": [{
      "live_activity": {                 // 필수. iOS에서 실시간 현황을 생성하기 위한 실시간 현황 데이터
        "content-state": {
          "emoji": ":wink:"
        },
        "attributes-type": "LiveActivityAttributes",
        "attributes": {
          "name": "Apple"
        }
      },
      "live_activity_id": "unique UUID"  // 선택. 실시간 현황의 고유 식별자.
    }]
  }
}

참고:

Pushwoosh iOS SDK를 사용하여 실시간 현황을 사용하는 방법에 대해 자세히 알아보려면 이 문서를 읽어보세요.

updateLiveActivity

이 메서드를 사용하여 iOS 실시간 현황을 관리합니다.

POST https://api.pushwoosh.com/json/1.3/updateLiveActivity

iOS 실시간 현황을 생성하고 관리할 수 있습니다.

요청 본문

매개변수	유형	필수/선택	설명
auth	String	필수	Pushwoosh Control Panel의 API 액세스 토큰.
application	String	필수	Pushwoosh 애플리케이션 코드
notifications	Array	필수	메시지 매개변수의 JSON 배열입니다. 자세한 내용은 아래의 Notifications 표를 참조하세요.

Notifications

notifications 배열에 사용되는 매개변수:

매개변수	유형	필수/선택	설명
live_activity	Object	필수	iOS에서 실시간 현황을 업데이트하기 위한 실시간 현황 데이터입니다.
event	String	필수	이벤트 유형을 지정합니다. 실시간 현황을 업데이트하려면 `"update"`를 사용하고, 종료하려면 `"end"`를 사용합니다.
content-state	Object	필수	콘텐츠를 업데이트하기 위해 실시간 현황에 데이터를 전달하는 데 사용되는 키-값 쌍이 있는 객체입니다.
dismissal-date	Integer	선택	실시간 현황이 종료되어야 하는 시간(초)입니다.
live_activity_id	String	필수	업데이트되는 실시간 현황의 고유 식별자입니다.
relevance-score	Integer	선택	어떤 실시간 현황이 다른 것보다 우선순위가 높은지 iOS 시스템에 알립니다. 1부터 무한대까지의 값을 허용합니다(100까지의 값을 권장합니다).
stale-date	Integer	선택	실시간 현황이 오래되거나 만료되는 날짜를 나타내는 시간(초)입니다.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "C3F8-C3863ED4-334AD4F1"
    ]
  }
}

요청 예시

{
  "request": {
    "application": "XXXXX-XXXXX",        // 필수. Pushwoosh 애플리케이션 코드
    "auth": "yxoPUlwqm…………pIyEX4H",      // 필수. Pushwoosh Control Panel의 API 액세스 토큰
    "notifications": [{
      "live_activity": {                 // 필수. iOS에서 실시간 현황을 업데이트하기 위한 실시간 현황 데이터
        "event": "update",               // 필수. 실시간 현황을 업데이트하려면 "update"를 사용하거나
                                         //           실시간 현황을 종료하려면 "end"를 사용
        "content-state": {               // 필수. 데이터를 전달하는 데 사용되는 키-값 쌍이 있는 객체
          "courierName": "NUMBER: 15",   //           콘텐츠 업데이트를 위해 실시간 현황으로
          "deliveryStatus": "Done"
        },
        "dismissal-date": 12345678,      // 선택. 실시간 현황 종료 시간(초)
        "relevance-score": 50,           // 선택. 실시간 현황의 우선순위(1~100 권장)
        "stale-date": 23456789           // 선택. 실시간 현황이 오래되는 시간(초)
      },
      "live_activity_id": "unique UUID"  // 선택. 실시간 현황의 고유 식별자.
    }]
  }
}

Pushwoosh iOS SDK를 사용하여 실시간 현황을 사용하는 방법에 대해 자세히 알아보려면 이 문서를 읽어보세요.