Skip to main content

​
Overview

Gets the account’s roster.

​
HTTP request

POST /Agent/Xmpp/GetRoster

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"offset":Optional(Int(0 <= POffset <= 2147483647)),
	"maxCount":Optional(Int(0 < PMaxCount <= 2147483647))
}

​
Input parameters

ParameterDescription
POffsetOffset into the roster where response begins.
PMaxCountMaximum number of roster items to return.

​
Response (JSON)

{
	"RosterItems":
	{
		"bareJid": Required(Str(PBareJid)),
		"pendingSubscription": Required(Bool(PPendingSubscription)),
		"status": Required(Str(PStatus)),
		"name": Required(Str(PName)),
		"Groups": Optional(Str(PGroups)[])
	}?[]
}

​
Response parameters

ParameterDescription
PBareJidBare JID of roster item.
PPendingSubscriptionIf the account has a pending subscription request to the remote entity.
PStatusStatus of roster item.
PNameName given to the roster item.
PGroupsNames of groups to which the roster item is assigned.

​
Notes

This endpoint uses the request schema notation described in Pattern matching.