Game Notice

This guide explains how to use the game notice inquiry API.

Before calling the API, you must register the notices to be displayed in the game from the Hive Console.

Overview¶

The game notice inquiry API is called directly from the game via server-to-server communication and supports two types of interfaces depending on the query method.

• Get all notices: Retrieves all notices for a specific game (game_index) at once.
• Get paginated notices: Retrieves notices for a specific game (game_index) in pages (pagination).

The Authorization request header must include an authentication token (Hive authentication key). The response includes basic notice information, language-specific details, game server ID list, and country code list.

A notice is returned in the response only if all of the following conditions are met:

• status = 1: Active status
• start_time <= current time: Current time is after the display start time
• end_time >= current time: Current time is before the display end time

Common response specification¶

Describes the common response examples and response codes that apply to all game notice inquiry API calls.

Success response example¶

{
  "result_code": 0,
  "result_msg": "Success",
  "data": { ... }
}

Error response example¶

{
  "result_code": 1100,
  "result_msg": "Unknown error"
}

Response codes¶

Get all notices¶

Returns the complete list of notices for a specific game (game_index).

Request information¶

Request data¶

Request headers¶

Request header example¶

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30

Path parameters¶

Request body¶

None (GET request)

Request example¶

curl -X GET "https://sandbox-social-api.qpyou.cn/games/313/notices" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"

Response data¶

Response body¶

Response example¶

{
  "result_code": 0,
  "result_msg": "Success",
  "data": {
    "list": [
      {
        "notice_id": 123,
        "status": 1,
        "type": "N",
        "view_count": 500,
        "registrant": "admin",
        "top_placed": 1,
        "start_time": "2026-03-01 00:00:00",
        "end_time": "2026-03-31 23:59:59",
        "company_index": 1,
        "game_index": 313,
        "country_expose_type": "W",
        "details": {
          "ko": {
            "game_name": "테스트게임",
            "title": "공지사항 제목",
            "content": "공지사항 내용",
            "crop_image": "https://example.com/img/123_kor.png"
          },
          "en": {
            "game_name": "TestGame",
            "title": "Notice Title",
            "content": "Notice Content",
            "crop_image": "https://example.com/img/123_eng.png"
          }
        },
        "game_servers": ["server1", "server2"],
        "country_codes": ["KR", "US"]
      }
    ]
  }
}

Get paginated notices¶

Returns the notice list for a specific game (game_index) in pages.

The Get all notices endpoint switches to paginated mode when either page or per_page is included as a query parameter.

Request information¶

Request data¶

Request headers¶

Request header example¶

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30

Path parameters¶

Query parameters¶

Request body¶

None (GET request)

Request example¶

curl -X GET "https://sandbox-social-api.qpyou.cn/games/313/notices?page=1&per_page=20" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"

Response data¶

Response body¶

Response example¶

{
  "result_code": 0,
  "result_msg": "Success",
  "data": {
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total_count": 50,
      "total_pages": 3
    },
    "list": [
      {
        "notice_id": 123,
        "status": 1,
        "type": "N",
        "view_count": 500,
        "registrant": "admin",
        "top_placed": 1,
        "start_time": "2026-03-01 00:00:00",
        "end_time": "2026-03-31 23:59:59",
        "company_index": 1,
        "game_index": 313,
        "country_expose_type": "W",
        "details": {
          "ko": {
            "game_name": "테스트게임",
            "title": "공지사항 제목",
            "content": "공지사항 내용",
            "crop_image": "https://example.com/img/123_kor.png"
          },
          "en": {
            "game_name": "TestGame",
            "title": "Notice Title",
            "content": "Notice Content",
            "crop_image": "https://example.com/img/123_eng.png"
          }
        },
        "game_servers": ["server1", "server2"],
        "country_codes": ["KR", "US"]
      }
    ]
  }
}

Response data details¶

Basic notice information¶

type codes¶

country_expose_type codes¶

details¶

details is an object keyed by language code. Only languages registered for the notice are included; returns an empty object ({}) if no details exist.

Supported language codes¶

game_servers¶

• List of game server IDs. Returns an empty array ([]) if no data is available.
• Example: ["server1", "server2", "server3"]

country_codes¶

• List of country codes. Returns an empty array ([]) if no data is available.
• Example: ["KR", "US", "JP"]
• Reference: ISO 3166 standard