LiveOps API

Manages live game operations and real-time events.

The LiveOps API is used to manage events that occur during gameplay, such as bonuses, promotions, or special events. The Game Provider can push updates to players in real time, enhancing the overall gaming experience.

post

Body

application/jsontext/jsonapplication/*+json

idstring · uuidOptional

gameIdstring · uuidOptional

clientKeystring | nullableOptional

descriptionstring | nullableOptional

activebooleanOptional

isRecurrentbooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring

500

Internal Server Error

text/plainapplication/jsontext/json

post

/api/liveops/dailybonus

HTTPcURLJavaScriptPython

POST /api/liveops/dailybonus HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "gameId": "123e4567-e89b-12d3-a456-426614174000",
  "clientKey": "text",
  "description": "text",
  "active": true,
  "isRecurrent": true,
  "createdAt": "2025-12-10T02:46:42.911Z",
  "updatedAt": "2025-12-10T02:46:42.911Z"
}

application/jsontext/jsonapplication/*+json

text

put

Body

application/jsontext/jsonapplication/*+json

idstring · uuidOptional

gameIdstring · uuidOptional

clientKeystring | nullableOptional

descriptionstring | nullableOptional

activebooleanOptional

isRecurrentbooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

put

/api/liveops/dailybonus

HTTPcURLJavaScriptPython

PUT /api/liveops/dailybonus HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "gameId": "123e4567-e89b-12d3-a456-426614174000",
  "clientKey": "text",
  "description": "text",
  "active": true,
  "isRecurrent": true,
  "createdAt": "2025-12-10T02:46:42.911Z",
  "updatedAt": "2025-12-10T02:46:42.911Z"
}

application/jsontext/jsonapplication/*+json

No content

get

Responses

200

OK

No content

500

Internal Server Error

get

/api/liveops/dailybonus

HTTPcURLJavaScriptPython

GET /api/liveops/dailybonus HTTP/1.1
Host: 
Accept: */*

No content

delete

Path parameters

dailyBonusIdstring · uuidRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

delete

/api/liveops/dailybonus/{dailyBonusId}

HTTPcURLJavaScriptPython

DELETE /api/liveops/dailybonus/{dailyBonusId} HTTP/1.1
Host: 
Accept: */*

No content

delete

Path parameters

dailyBonusIdstring · uuidRequired

playerIdstring · uuidRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

delete

/api/liveops/dailybonus/{dailyBonusId}/reset/{playerId}

HTTPcURLJavaScriptPython

DELETE /api/liveops/dailybonus/{dailyBonusId}/reset/{playerId} HTTP/1.1
Host: 
Accept: */*

No content

post

Path parameters

dailyBonusIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

dailyBonusRewardIdstring · uuidOptional

streakDayinteger · int32Optional

itemIdstring · uuidOptional

quantityinteger · int32Optional

highlightbooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responsestring

500

Internal Server Error

text/plainapplication/jsontext/json

post

/api/liveops/dailybonus/{dailyBonusId}/reward

HTTPcURLJavaScriptPython

POST /api/liveops/dailybonus/{dailyBonusId}/reward HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "dailyBonusRewardId": "123e4567-e89b-12d3-a456-426614174000",
  "streakDay": 1,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "highlight": true
}

application/jsontext/jsonapplication/*+json

text

get

Path parameters

dailyBonusIdstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

/api/liveops/dailybonus/{dailyBonusId}/rewards/list

HTTPcURLJavaScriptPython

GET /api/liveops/dailybonus/{dailyBonusId}/rewards/list HTTP/1.1
Host: 
Accept: */*

[
  {
    "dailyBonusRewardId": "123e4567-e89b-12d3-a456-426614174000",
    "streakDay": 1,
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 1,
    "highlight": true
  }
]

get

Path parameters

gameIdstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

get

/api/liveops/dailybonus/{gameId}/list

HTTPcURLJavaScriptPython

GET /api/liveops/dailybonus/{gameId}/list HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "gameId": "123e4567-e89b-12d3-a456-426614174000",
    "clientKey": "text",
    "description": "text",
    "active": true,
    "isRecurrent": true,
    "createdAt": "2025-12-10T02:46:42.911Z",
    "updatedAt": "2025-12-10T02:46:42.911Z"
  }
]

get

Path parameters

playerIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

dailyBonusIdstring · uuid | nullableOptional

clientKeystring | nullableOptional

packetTypeinteger · int32Read-onlyOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseany

500

Internal Server Error

text/plainapplication/jsontext/json

get

/api/liveops/dailybonus/collect/{playerId}

HTTPcURLJavaScriptPython

GET /api/liveops/dailybonus/collect/{playerId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "dailyBonusId": "123e4567-e89b-12d3-a456-426614174000",
  "clientKey": "text"
}

application/jsontext/jsonapplication/*+json

No content

put

Body

application/jsontext/jsonapplication/*+json

dailyBonusRewardIdstring · uuidOptional

streakDayinteger · int32Optional

itemIdstring · uuidOptional

quantityinteger · int32Optional

highlightbooleanOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

put

/api/liveops/dailybonus/reward

HTTPcURLJavaScriptPython

PUT /api/liveops/dailybonus/reward HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "dailyBonusRewardId": "123e4567-e89b-12d3-a456-426614174000",
  "streakDay": 1,
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "highlight": true
}

application/jsontext/jsonapplication/*+json

No content

delete

Path parameters

dailyBonusRewardIdstring · uuidRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

delete

/api/liveops/dailybonus/reward/{dailyBonusRewardId}

HTTPcURLJavaScriptPython

DELETE /api/liveops/dailybonus/reward/{dailyBonusRewardId} HTTP/1.1
Host: 
Accept: */*

No content

get

Path parameters

playerIdstring · uuidRequired

Query parameters

dailyBonusIdstring · uuidOptional

clientKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseany

500

Internal Server Error

text/plainapplication/jsontext/json

get

/api/liveops/dailybonus/status/{playerId}

HTTPcURLJavaScriptPython

GET /api/liveops/dailybonus/status/{playerId} HTTP/1.1
Host: 
Accept: */*

No content

post

Body

application/jsontext/jsonapplication/*+json

roomsstring · uuid[] | nullableOptional

startTimestring · date-timeOptional

streamEndpointstring | nullableOptional

channelIdstring | nullableOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

500

Internal Server Error

post

/api/liveops/live

HTTPcURLJavaScriptPython

POST /api/liveops/live HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "rooms": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "startTime": "2025-12-10T02:46:42.911Z",
  "streamEndpoint": "text",
  "channelId": "text"
}

application/jsontext/jsonapplication/*+json

No content

get

Path parameters

liveIdstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

500

Internal Server Error

get

/api/liveops/live/{liveId}

HTTPcURLJavaScriptPython

GET /api/liveops/live/{liveId} HTTP/1.1
Host: 
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "rooms": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "liveId": "123e4567-e89b-12d3-a456-426614174000",
      "roomId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "timeToStart": "text",
  "startTime": "2025-12-10T02:46:42.911Z",
  "streamEndpoint": "text",
  "isLive": true,
  "channelId": "text",
  "createdAt": "2025-12-10T02:46:42.911Z",
  "updatedAt": "2025-12-10T02:46:42.911Z"
}

delete

Path parameters

liveIdstring · uuidRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

500

Internal Server Error

delete

/api/liveops/live/{liveId}

HTTPcURLJavaScriptPython

DELETE /api/liveops/live/{liveId} HTTP/1.1
Host: 
Accept: */*

No content

put

Path parameters

liveIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

booleanOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

500

Internal Server Error

put

/api/liveops/live/{liveId}/state

HTTPcURLJavaScriptPython

PUT /api/liveops/live/{liveId}/state HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 4

true

application/jsontext/jsonapplication/*+json

No content

post

Body

application/jsontext/jsonapplication/*+json

playersIdsstring · uuid[] | nullableOptional

messagestring | nullableOptional

Responses

200

OK

No content

500

Internal Server Error

post

/api/liveops/live/add-item

HTTPcURLJavaScriptPython

POST /api/liveops/live/add-item HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "items": [
    {
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "clientKey": "text",
      "quantity": 1
    }
  ],
  "playersIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "message": "text"
}

application/jsontext/jsonapplication/*+json

No content

get

Responses

200

OK

No content

500

Internal Server Error

get

/api/liveops/live/list

HTTPcURLJavaScriptPython

GET /api/liveops/live/list HTTP/1.1
Host: 
Accept: */*

No content

post

Path parameters

playerIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

roomIdsstring · uuid[] | nullableOptional

liveScheduleQuantityPerRoominteger · int32 | nullableOptional

Responses

200

OK

No content

500

Internal Server Error

post

/api/liveops/live/player/{playerId}/list-live-schedule

HTTPcURLJavaScriptPython

POST /api/liveops/live/player/{playerId}/list-live-schedule HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "roomIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "liveScheduleQuantityPerRoom": 1
}

application/jsontext/jsonapplication/*+json

No content

post

Path parameters

playerIdstring · uuidRequired

Bodyobject[]

application/jsontext/jsonapplication/*+json

playerIdstring · uuidOptional

itemIdstring · uuidOptional

pointsinteger · int32Optional

rankingIdstring · uuidOptional

startedToProcessstring · date-timeOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

500

Internal Server Error

post

/api/liveops/rank/{playerId}/send-ranked-event

HTTPcURLJavaScriptPython

POST /api/liveops/rank/{playerId}/send-ranked-event HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 209

[
  {
    "playerId": "123e4567-e89b-12d3-a456-426614174000",
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "points": 1,
    "rankingId": "123e4567-e89b-12d3-a456-426614174000",
    "startedToProcess": "2025-12-10T02:46:42.911Z"
  }
]

application/jsontext/jsonapplication/*+json

No content

get

Path parameters

playerIdstring · uuidRequired

rankingIdstring · uuidRequired

Responses

200

OK

No content

500

Internal Server Error

get

/api/liveops/rank/request-player-ranking-position/{playerId}/{rankingId}

HTTPcURLJavaScriptPython

GET /api/liveops/rank/request-player-ranking-position/{playerId}/{rankingId} HTTP/1.1
Host: 
Accept: */*

No content

get

Path parameters

rankingIdstring · uuidRequired

Responses

200

OK

No content

500

Internal Server Error

get

/api/liveops/rank/request-ranking-missions/{rankingId}

HTTPcURLJavaScriptPython

GET /api/liveops/rank/request-ranking-missions/{rankingId} HTTP/1.1
Host: 
Accept: */*

No content

get

Path parameters

playerIdstring · uuidRequired

Query parameters

rankingIdstring · uuidOptional

Responses

200

OK

No content

500

Internal Server Error

get

/api/liveops/rank/request-rankings/{playerId}

HTTPcURLJavaScriptPython

GET /api/liveops/rank/request-rankings/{playerId} HTTP/1.1
Host: 
Accept: */*

No content