<<

NAME

WP8 - Push notifications for Windows Phone 8.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/WP8.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/WP8.json

DESCRIPTION

This module allows you to receive push notifications to Windows Phone apps. This module is meant for use by our mobile applications only.

METHODS

Meta

Returns the JSON or WSDL specification of the WP8 API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

• format (string) - optional

  The specification format you want to use. If omitted, defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.

  Allowed values are: json, wsdl.

Returns

• encoded_meta (string)

  The specification of the module.

• format (string)

  The specification format used.

  Allowed values are: json, wsdl.

Authorization

This method can be called by read-only users.

ReadNotification

Returns the full content of a JSON notification (format is the same as in Parse notifications). It will probably be extended with more details in the future.

Arguments

• id (unsigned integer)

  The notification ID, from the push message's payload.

Returns

• encoded_notification (string)

  JSON-encoded notification's content.

Authorization

This method can be called by read-only users.

RegisterDevice

Registers a mobile device. It will now receive the push notifications until unregistered or registered again with new URL. Note that the push notification's payload will only include an ID of a new notification (as the notification_id attribute). The notification's actual content can be fetched with the ReadNotification method.

Arguments

• installation_id (string)

  The installation ID. It has to be unique for the mobile device.

  This value must match the /^[A-Za-z0-9_\-]{32,}$/ regular expression.

• notification_url (string)

  The notification URL obtained from the Microsoft Push Notification Service.

Returns

Nothing.

Authorization

This method can be called by read-only users.

UnregisterDevice

Unregisters a device. No further notifications will be sent to it.

Arguments

• installation_id (string)

  The device installation ID.

  This value must match the /^[A-Za-z0-9_\-]{32,}$/ regular expression.

Returns

Nothing.

Authorization

This method can be called by read-only users.

<<