Notifications.get

From Facebook Developers Wiki

Contents 1 Description 2 Parameters 3 Example Return XML 4 Response 5 Error Codes

[edit] Description

Returns information on outstanding Facebook notifications for current session user.

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The application key associated with the calling application.
	session_key	string	The session key of the logged in user.
	call_id	float	The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function.
	sig	string	An MD5 hash of the current request and your secret key, as described in the authentication guide.
	v	string	This must be set to 1.0 to use this version of the API.
optional	format	string	Desired response format. Either XML (default) or JSON.
	callback	string	Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <notifications_get_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true"> <messages> <unread>1</unread> <most_recent>1170644932</most_recent> </messages> <pokes> <unread>0</unread> <most_recent>0</most_recent> </pokes> <shares> <unread>1</unread> <most_recent>1170657686</most_recent> </shares> <friend_requests list="true"> <uid>2231342839</uid> <uid>2231511925</uid> <uid>2239284527</uid> </friend_requests> <group_invites list="true"/> <event_invites list="true"/> </notifications_get_response>

[edit] Response

This method returns the same set of subelements, whether or not there are outstanding notifications in any area. Note that if the unread subelement value is 0 for any of the pokes or shares elements, the most_recent element is also 0. Otherwise, the most_recent element contains an identifier for the most recent notification of the enclosing type.

If you are building an application that notifies users of new messages/pokes/shares, we encourage you to use the following logic when deciding whether to show a notification:

if (unread > 0 && most_recent > old_most_recent) { display_notification(); } old_most_recent = most_recent;

Privacy Note: The subelement lists can contain user IDs of users not using the calling application.

[edit] Error Codes

Code	Description
1	An unknown error occurred. Please resubmit the request.
2	The service is not available at this time.
4	The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5	The request came from a remote address not allowed by this application.
101	The API key submitted is not associated with any known application.
102	The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103	The submitted call_id was not greater than the previous call_id for this session.
104	Incorrect signature.