BatchRequest (JSON)

An array of properties with which to filter presence information, such as users, devices, and titles.

BatchRequest

The BatchRequest object has the following specification.

Member	Type	Description
users	array of string	List XUIDs of users whose presence you want to learn, with a maximum of 1100 XUIDs at a time.
deviceTypes	array of string	List of device types used by the users you want to know about. If the array is left empty, it defaults to all possible device types (that is, none are filtered out).
titles	array of 32-bit unsigned integer	List of device types whose users you want to know about. If the array is left empty, it defaults to all possible titles (that is, none are filtered out).
level	string	Possible values: user - get user nodes device - get user and device nodes title - get basic title level information all - get rich presence information, media information, or both The default is “title”.
onlineOnly	Boolean value	If this property is true, the batch operation will filter out records for offline users (including cloaked ones). If it is not supplied, both online and offline users will be returned.

{
  users:
  [
    "1234567890",
    "4567890123",
    "7890123456"
  ]
}