单次推送

先決條件¶

要與單一推送 API 同步，請確保發出授權令牌（API KEY）。如果您已經擁有該密鑰，請要求額外的權限。請參考 Hive 伺服器 API > 通知 > 推送 v4 > 認證 以檢查如何請求和發出授權令牌。

依環境訪問 URL¶

基本信息和请求参数¶

識別符結構¶

標識範例¶

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

訊息結構¶

選項資訊¶

ActionPayload¶

ActionPayload 是在使用推送操作按钮时传递的数据格式，这是单一推送 API 的一个附加功能。

推送操作按鈕是一個在SDK中可用的通知功能，當長按推送通知時顯示為系統按鈕。

有關推送操作按鈕的更多詳細資訊，請參閱以下指南。

• SDK 開發指南 > 推送動作按鈕
• Apple > 設定推播通知用戶動作的指南
• Android > FCM 動作按鈕指南

ActionPayload 數據結構¶

當請求單一推送 API 時，ActionPayload 中包含的數據如下。

行動¶

操作是 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": "確定"
                        },
                        "actionType": "CURL",
                        "action": "https://examplecurl.com"
                    },
                    {
                        "titles": {
                            "default": "取消"
                        },
                        "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: [auto calculated]
  
  {
      "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