Lobby - Subscribe To Lobby Resource

Service:

Multiplayer

API Version:

241108

Subscribe to lobby resource notifications.

POST https://titleId.playfabapi.com/Lobby/SubscribeToLobbyResource

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
EntityKey	True	EntityKey	The entity performing the subscription.
PubSubConnectionHandle	True	string	Opaque string, given to a client upon creating a connection with PubSub.
ResourceId	True	string	The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite subscriptions this should always be "@me".
SubscriptionVersion	True	number	Version number for the subscription of this resource.
Type	True	SubscriptionType	Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a member of a lobby to receive lobby invites.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	SubscribeToLobbyResourceResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
SubscribeToLobbyResourceRequest	Request to subscribe to lobby resource notifications.
SubscribeToLobbyResourceResult
SubscriptionType

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

SubscribeToLobbyResourceRequest

Request to subscribe to lobby resource notifications.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EntityKey	EntityKey	The entity performing the subscription.
PubSubConnectionHandle	string	Opaque string, given to a client upon creating a connection with PubSub.
ResourceId	string	The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite subscriptions this should always be "@me".
SubscriptionVersion	number	Version number for the subscription of this resource.
Type	SubscriptionType	Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a member of a lobby to receive lobby invites.

SubscribeToLobbyResourceResult

Name	Type	Description
Topic	string	Topic will be returned in all notifications that are the result of this subscription.

SubscriptionType

Name	Type	Description
LobbyChange	string
LobbyInvite	string

Error Codes

Name	Code
LobbyBadRequest	13007
LobbyDoesNotExist	13000
LobbyRateLimitExceeded	13001
PubSubConnectionHandleInvalid	2503
PubSubConnectionNotFoundForEntity	2502
PubSubSubscriptionLimitExceeded	2504