Matchmaking - Subscribe To Matchmaking Resource

Subscribe to match resource notifications.

POST https://titleId.playfabapi.com/Match/SubscribeToMatchmakingResource

Request Header

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

Name	Required	Type	Description
EntityKey	True	EntityKey	The entity performing the subscription. The entity must be authorized to use this connectionHandle.
PubSubConnectionHandle	True	string	Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection associated with this handle.
ResourceId	True	string	The name of the resource to subscribe to. It follows the format {queueName}\|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.
SubscriptionVersion	True	number	Version number for the subscription of this resource. Current supported version must be 1.
Type	True	string	Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket. Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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

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

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
SubscribeToMatchResourceRequest	Subscribe to match resource notifications. Match subscriptions have two types; MatchInvite and MatchTicketStatusChange
SubscribeToMatchResourceResult

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

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

Subscribe to match resource notifications. Match subscriptions have two types; MatchInvite and MatchTicketStatusChange

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. The entity must be authorized to use this connectionHandle.
PubSubConnectionHandle	string	Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection associated with this handle.
ResourceId	string	The name of the resource to subscribe to. It follows the format {queueName}\|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.
SubscriptionVersion	number	Version number for the subscription of this resource. Current supported version must be 1.
Type	string	Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket. Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.

Name	Type	Description
Topic	string	Matchmaking resource

Name	Code
MatchmakingAttributeInvalid	2046
MatchmakingBadRequest	2059
MatchmakingEntityInvalid	2001
MatchmakingTicketNotFound	2018
MatchmakingUnauthorized	2056
PubSubConnectionHandleInvalid	2503
PubSubConnectionNotFoundForEntity	2502
PubSubSubscriptionLimitExceeded	2504