Documentation

AndroidDevicePushNotificationRegistration

Registers the Android device to receive push notifications

Request Details

More information can be found on configuring your game for the Google Cloud Messaging service in the Google developer documentation, here: http://developer.android.com/google/gcm/client.html. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://api.playfab.com/docs/pushCrashCourse/.

AndroidDevicePushNotificationRegistrationRequest
Request Properties
ConfirmationMessage String

Message to display when confirming push notification.

DeviceToken (required) String

Registration ID provided by the Google Cloud Messaging service when the title registered to receive push notifications (see the GCM documentation, here: http://developer.android.com/google/gcm/client.html).

SendPushNotificationConfirmation Boolean

If true, send a test push message immediately after sucessful registration. Defaults to false.

POST https://{{TitleID}}.playfabapi.com/Client/AndroidDevicePushNotificationRegistration
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "DeviceToken": "59872d98fa632brn8hg3770",
  "SendPushNotificationConfirmation": true,
  "ConfirmationMessage": "Welcome to PlayFab!"
}
        

Response Details

AndroidDevicePushNotificationRegistrationResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SessionTicket

Possible Error Codes

Name Code
NoPushNotificationARNForTitle 1083