Comment on page
Notifications 👑
The Notifications API can be used to list the player's notifications and also to update its status once read.
Type | Description | Endpoint |
GET | /integrations/notifications/{playerUnqiueId} | |
PUT | /integrations/notifications |
This endpoint is only available for our GURU customers only. 👑
https://api.gameball.co/api/v3.0/integrations/notifications/{playerUnqiueId}/
This API is used to to retrieve a specific player's list of notifications in Gameball.
mobile or email should replace the playerUniqueId in case (only if) your account supports channel merging.Attribute | Type | Required | Description |
APIKey | string | Yes | Client API key |
Attribute | Type | Required | Description |
playerUniqueId | string | Yes | Unique identifier for the player at Gameball |
Attribute | Type | Required | Description |
isRead | boolean | No | Read status filter. This could be used in case you need to filter notifications based on their read status. |
lang | string | No | Language filter. This could be used to specify the language needed to display the notification in.
Note: The language provided should be as per configured languages in your account. Example: "en", "fr". |
page | integer | No | Result page number. Starts from 1. Default is 1 |
limit | integer | No | Result page size. Default is 50 notifications and Max is 200 |
Returns an array of notification objects described as follows:
Attribute | Type | Description |
notifications | array | |
count | integer | returned currently displayed notifications list count |
total | integer | total number of notifications available matching the applied filters Example: "count": 50"total": 200 |
Attribute | Type | Description |
notificationId | string | Unique Identifier for a notification |
title | string | Notification Title |
body | string | Notification Body |
isRead | boolean | Indicates whether the notification is read or not. |
createdAt | string | Notification's creation date, as an ISO8601 timestamp. Example: "2019-09-21T16:53:28.190Z" |
lang | string | The language in which the notification is displayed.
In case the lang is not provided in the request, defaultlang is returned.Note: The language provided should be as per configured languages in your account. Example: "en", "fr". |
icon | string | Notification's icon URL. |
{
"notifications": [
{
"notificationId" : "123",
"title": "New level!",
"body": "Keep it up! You are now on Bronze ",
"isRead": true,
"createdAt": "2021-05-12T00:08:09.646174",
"lang": "en",
"icon": "https://cdn.gameball.co/uploads/client776/ad8b2587-959f-48fd-ab58-a643323652begb-icon-level-13.png"
},
{
"notificationId" : "124",
"title": "Congratulations! ",
"body": "Welcome earned. Enjoy your rewards and keep earning more!",
"isRead": true,
"createdAt": "2021-05-12T00:08:09.623367",
"lang": "en",
"icon": "https://cdn.gameball.co/uploads/client776/bcc5d9be-3861-415f-bdf9-34b4064a1320Group 2144.png"
}
],
"count": 50,
"total": 200
}
cURL
Ruby
PHP
Python
.NET
curl -X GET -H 'apiKey: 807b041b7d35425988e354e1f6bce186' -v -i
'https://api.gameball.co/api/v3.0/integrations/notifications/player123?lang=en'
# Example 1
Gameball::Notifications.get_notifications("player123")
# Example 2
Gameball::Notifications.get_notifications("player123",{
page: 2,
limit: 10
})
$response = $gameball->notification
->getPlayerNotifications("player123",false, null, 2, 10);
notifications = gameball.get_notifications("player123")
var response = Gameball.GetPlayerNotifications("player123");
https://api.gameball.co/api/v3.0/integrations/notifications
The API call is used to mark the player's notification(s) as read in Gameball.
Attribute | Type | Required | Description |
APIKey | string | Yes | Client API key |
Attribute | Type | Required | Description |
notificationIds | array | Yes | An array of IDs of the notifications to be marked as read. Example: ["12334", "14533", "55343"] |
{
"notificationIds" : ["123", "3441", "3245"]
}
cURL
Ruby
PHP
Python
.NET
curl -X PUT -H 'apiKey: 807b041b7d35425988e354e1f6bce186' -d '{
"notificationIds" : ["123", "3441", "3245"]
}' -v -i 'https://api.gameball.co/api/v3.0/integrations/notifications'
Gameball::Notifications.mark_notifications({notificationIds: ["123", "3441", "3245"]})
$response = $gameball->notification
->markPlayerNotificationsAsRead(["123", "3441", "3245"]);
notifications = gameball.mark_notifications(["123", "3441", "3245"])
var response = Gameball.MarkNotifications(new string[]{"123", "3441", "3245"});
Last modified 1yr ago