싱글 푸시

연동 준비사항¶

싱글 푸시 API를 연동하려면 인증토큰(API KEY)을 발급받아야 합니다. 토큰을 이미 발급받았다면 추가할 권한만 요청합니다. HIVE Server API > 노티피케이션 > 푸시 v4 > 인증에서 인증토큰 발급과 요청 방법을 확인하세요.

환경별 접근 URL¶

기본 정보 및 요청 변수¶

공지 알림 동작 방식¶

공지 알림은 게임 앱 유저가 공지 알림을 수신 동의한 경우에만 발송됩니다. 공지 알림 발송 시간이 21:00~익일 08:00인 경우에는 '야간 알림 수신 동의'가 추가로 필요합니다.

공지 알림 동작 방식의 상세 내용은 아래와 같습니다.

• 유저가 공지 알림 수신에 동의하지 않으면 공지로 설정된 모든 메시지는 발송되지 않습니다.
• 유저가 공지 알림 수신에 동의한 경우에 한해, 야간 알림 수신 동의를 할 수 있습니다.

Identifier 구조¶

identifier 예제¶

[
  {
    "playerId":51234,
    "did":1234
  }
]

Message 구조¶

Option 정보¶

ActionPayload¶

ActionPayload는 싱글 푸시 API의 부가 기능인 푸시 액션 버튼을 사용 시 전달하는 데이터 포맷입니다.

푸시 액션 버튼은 SDK에서 사용할 수 있는 노티피케이션 기능 중 하나로 푸시 알림을 길게 누르면 표시되는 시스템 버튼입니다.

푸시 액션 버튼에 대한 상세한 내용은 아래 가이드를 참고세요.

• SDK 개발 가이드 > 푸시 액션 버튼

• Apple > 푸시 알림의 사용자 액션 설정 가이드

• Android > FCM 액션 버튼 가이드

ActionPayload 데이터 구조¶

싱글 푸시 API 요청 시, ActionPayload에 포함되는 데이터는 아래와 같습니다.

Action¶

Action은 ActionPayload를 구성하는 각각의 시스템 버튼과 관련된 데이터입니다. Action에 포함되는 본문 파라미터는 아래와 같습니다.

출력 결과 > 응답 파라미터 구조¶

응답 상태 코드¶

예제 코드¶

• 호출 ("enableLocale":false)

POST /push/send HTTP/1.1
Host: sandbox-notification.qpyou.cn
Content-Type: application/json
Authorization: Bearer {API KEY}
Content-Length: [자동 계산됨]

{
  "notice": false,
  "identifiers": [
    {
      "playerId": 200001358,
      "did": 300010915
    }
  ],
  "game": {
    "gameid": "com.com2us.hivesdk",
    "appids": [
      "com.com2us.hivesdk.normal.freefull.google.global.android.common",
      "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal"
    ]
  },
  "enableLocale": false,
  "payload": {
    "single": {
      "android": {
        "title": "android title",
        "message": "android message",
        "messageExpanded": "",
        "imageUrl": "",
        "ticker": "",
        "summaryText": ""
      },
      "ios": {
        "title": "ios title",
        "message": "ios message",
        "mediaUrl": ""
      }
    },
    "option": {
      "badge": "1",
      "overwrite": false,
      "collapseKey": "",
      "engagement": "",
      "groupKey": "",
      "android": {
        "icon": "",
        "sound": "",
        "priority": "normal"
      },
      "ios": {
        "sound": ""
      }
    }
  },
  "actionInfo": {
    "android": {
      "actions": [
        {
          "titles": {
            "default": "OK"
          },
          "actionType": "CURL",
          "action": "https://examplecurl.com"
        },
        {
          "titles": {
            "default": "Cancel"
          },
          "actionType": "CLOSE",
          "action": ""
        }
      ]
    },
    "ios": {
      "category": "CONFIRM_CATEGORY",
      "actions": [
        {
          "actionId": "CONFIRM_ID",
          "actionType": "CURL",
          "action": "https://examplecurl.com"
        },
        {
          "actionId": "CLOSE_ID",
          "actionType": "CLOSE",
          "action": ""
        }
      ]
    }
  }
}

• 호출 ("enableLocale":true)

  POST /push/send HTTP/1.1
  Host: sandbox-notification.qpyou.cn
  Content-Type: application/json
  Authorization: Bearer {API KEY}
  Content-Length: [자동 계산됨]
  
  {
    "notice": false,
     "identifiers": [
     {
         "playerId": 200001358,
         "did": 300010915
     }
    ],
    "game": {
      "gameid": "com.com2us.hivesdk",
      "appids": [
        "com.com2us.hivesdk.normal.freefull.google.global.android.common",
        "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal"
      ]
    },
    "enableLocale": true,
    "payload": {
      "defaultLanguage": "en",
      "locale": {
        "ko": {
          "android": {
            "title": "테스트_한국어 제목",
            "message": "테스트_한국어 메세지"
          },
          "ios": {
            "title": "테스트_한국어 제목",
            "message": "테스트_한국어 메세지"
          }
        },
        "en": {
          "android": {
            "title": "test_English title",
            "message": "test_English message"
          },
          "ios": {
            "title": "test_English title",
            "message": "test_English message"
          }
        }
      },
      "option": {
        "badge": 1,
        "overwrite": true,
        "collapseKey": "99",
        "groupKey": "",
        "android": {
          "icon": "GoogleIcon",
          "sound": "GoogleSound",
          "priority": "normal"
        },
        "ios": {
          "sound": "AppleSound"
        }
      }
    },
    "actionInfo": {
      "android": {
        "actions": [
          {
            "titles": {
              "default": "OK",
              "en": "OK",
              "ko": "확인"
            },
            "actionType": "CURL",
            "action": "https://examplecurl.com"
          },
          {
            "titles": {
              "default": "Cancel",
              "en": "Cancel",
              "ko": "취소"
            },
            "actionType": "CLOSE",
            "action": ""
          }
        ]
      },
      "ios": {
        "category": "CONFIRM_CATEGORY",
        "actions": [
          {
            "actionId": "CONFIRM_ID",
            "actionType": "CURL",
            "action": "https://examplecurl.com"
          },
          {
            "actionId": "CLOSE_ID",
            "actionType": "CLOSE",
            "action": ""
          }
        ]
      }
    }
  }
  

• 응답

  HTTP/1.1 200 OK
  Content-length: 0
  Content-Type: application/json
  UUID: 3bc6b414-e2df-40d6-8006-9d2308a6edf9