Matchmaking - Join Matchmaking Ticket

Service:

Multiplayer

API Version:

241122

Join a matchmaking ticket.

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

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
Member	True	MatchmakingPlayer	The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith.
QueueName	True	string	The name of the queue to join.
TicketId	True	string	The Id of the ticket to find a match for.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	JoinMatchmakingTicketResult
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.
JoinMatchmakingTicketRequest	Add the player to a matchmaking ticket and specify all of its matchmaking attributes. Players can join a ticket if and only if their EntityKeys are already listed in the ticket's Members list. The matchmaking service automatically starts matching the ticket against other matchmaking tickets once all players have joined the ticket. It is not possible to join a ticket once it has started matching.
JoinMatchmakingTicketResult
MatchmakingPlayer	A user in a matchmaking ticket.
MatchmakingPlayerAttributes	The matchmaking attributes for a user.

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

JoinMatchmakingTicketRequest

Add the player to a matchmaking ticket and specify all of its matchmaking attributes. Players can join a ticket if and only if their EntityKeys are already listed in the ticket's Members list. The matchmaking service automatically starts matching the ticket against other matchmaking tickets once all players have joined the ticket. It is not possible to join a ticket once it has started matching.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Member	MatchmakingPlayer	The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith.
QueueName	string	The name of the queue to join.
TicketId	string	The Id of the ticket to find a match for.

JoinMatchmakingTicketResult

MatchmakingPlayer

A user in a matchmaking ticket.

Name	Type	Description
Attributes	MatchmakingPlayerAttributes	The user's attributes custom to the title.
Entity	EntityKey	The entity key of the matchmaking user.

MatchmakingPlayerAttributes

The matchmaking attributes for a user.

Name	Type	Description
DataObject	object	A data object representing a user's attributes.
EscapedDataObject	string	An escaped data object representing a user's attributes.

Error Codes

Name	Code
MatchmakingAlreadyJoinedTicket	2028
MatchmakingAttributeInvalid	2046
MatchmakingEntityInvalid	2001
MatchmakingMemberProfileInvalid	2032
MatchmakingPlayerAttributesInvalid	2002
MatchmakingPlayerAttributesTooLarge	2043
MatchmakingQueueNotFound	2016
MatchmakingRateLimitExceeded	2054
MatchmakingTicketAlreadyCompleted	2029
MatchmakingTicketMembershipLimitExceeded	2055
MatchmakingTicketNotFound	2018
MatchmakingUnauthorized	2056