getNotificationsForContact

Web Services Methods › List/Query Methods › getNotificationsForContact

getNotificationsForContact

The following parameters apply to the getNotificationsForContact method:

Parameter	Type	Description
SID	Integer	Identifies the session retrieved from logging in.
contactHandle	String	Identifies the contact handle.
queryStatus	Integer	(Optional) Identifies the target of the notifications.

Description

Returns a list of notifications (‘lr’ objects) for a contact.

You can query on a specific status for the notifications with the queryStatus field, which is useful for returning, for example, only non-cleared messages. The possible queryStatus values are as follows:

-1—Fetch all notifications
0—Fetch non-cleared notifications (those with a status value of less than 7)
1—Fetch cleared notifications (those with a status value of 7, 8 or 9)

Returns

The following:

XML Element	Type	Description
<listHandle>	Integer	Identifies the list handle.
<listLength>	Integer	Identifies the length of the list generated.