Matchmaking - Get Match

Get a match.

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

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
EscapeObject True

boolean

Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON object.

MatchId True

string

The Id of a match.

QueueName True

string

The name of the queue to join.

ReturnMemberAttributes True

boolean

Determines whether the matchmaking attributes for each user should be returned in the response for match request.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

GetMatchResult

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.

GetMatchRequest

When matchmaking has successfully matched together a collection of tickets, it produces a 'match' with an Id. The match contains all of the players that were matched together, and their team assigments. Only servers and ticket members can get the match.

GetMatchResult
MatchmakingPlayerAttributes

The matchmaking attributes for a user.

MatchmakingPlayerWithTeamAssignment

A player in a created matchmaking match with a team assignment.

Port
ProtocolType
ServerDetails

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

GetMatchRequest

When matchmaking has successfully matched together a collection of tickets, it produces a 'match' with an Id. The match contains all of the players that were matched together, and their team assigments. Only servers and ticket members can get the match.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

EscapeObject

boolean

Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON object.

MatchId

string

The Id of a match.

QueueName

string

The name of the queue to join.

ReturnMemberAttributes

boolean

Determines whether the matchmaking attributes for each user should be returned in the response for match request.

GetMatchResult

Name Type Description
ArrangementString

string

A string that is used by players that are matched together to join an arranged lobby.

MatchId

string

The Id of a match.

Members

MatchmakingPlayerWithTeamAssignment[]

A list of Users that are matched together, along with their team assignments.

RegionPreferences

string[]

A list of regions that the match could be played in sorted by preference. This value is only set if the queue has a region selection rule.

ServerDetails

ServerDetails

The details of the server that the match has been allocated to.

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.

MatchmakingPlayerWithTeamAssignment

A player in a created matchmaking match with a team assignment.

Name Type Description
Attributes

MatchmakingPlayerAttributes

The user's attributes custom to the title. These attributes will be null unless the request has ReturnMemberAttributes flag set to true.

Entity

EntityKey

The entity key of the matchmaking user.

TeamId

string

The Id of the team the User is assigned to.

Port

Name Type Description
Name

string

The name for the port.

Num

number

The number for the port.

Protocol

ProtocolType

The protocol for the port.

ProtocolType

Name Type Description
TCP

string

UDP

string

ServerDetails

Name Type Description
Fqdn

string

The fully qualified domain name of the virtual machine that is hosting this multiplayer server.

IPV4Address

string

The IPv4 address of the virtual machine that is hosting this multiplayer server.

Ports

Port[]

The ports the multiplayer server uses.

Region

string

The server's region.

ServerId

string

The string server ID of the multiplayer server generated by PlayFab.

Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingMatchNotFound 2017
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingUnauthorized 2056