单推

先决条件¶

要与单推送 API 同步，请确保发出授权令牌（API 密钥）。如果您已经拥有密钥，请请求额外的权限。请参考 Hive 服务器 API > 通知 > 推送 v4 > 身份验证 以查看如何请求和发出授权令牌。

按环境访问 URL¶

基本信息和请求参数¶

通知警报工作流程¶

通知警报仅发送给已同意接收的游戏应用用户。如果通知警报在 21:00~08:00 之间发送，则需要额外的夜间警报同意。

通知警报工作流的详细信息如下：

• 如果用户不同意接收通知提醒，则所有设置为通知的消息将不会发送。
• 只有同意接收通知提醒的用户才能同意夜间提醒。

标识符结构¶

标识符示例¶

    [
        {
            "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: [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": false,
        "payload": {
            "single": {
                "android": {
                    "title": "安卓标题",
                    "message": "安卓消息",
                    "messageExpanded": "",
                    "imageUrl": "",
                    "ticker": "",
                    "summaryText": ""
                },
                "ios": {
                    "title": "iOS标题",
                    "message": "iOS消息",
                    "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": "确认类别",
                "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": "确定",
                          "en": "OK",
                          "ko": "확인"
                      },
                      "actionType": "CURL",
                      "action": "https://examplecurl.com"
                  },
                  {
                      "titles": {
                          "default": "取消",
                          "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