Matchmaking - Get Match

Get a match.

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

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.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

EntityToken

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

Type: apiKey
In: header

Definitions

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
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

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
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
MatchId
  • string

The Id of a match.

Members

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

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

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

Entity

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

The protocol for the port.

ProtocolType

Name Type Description
TCP
  • string
UDP
  • string

ServerDetails

Name Type Description
IPV4Address
  • string

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

Ports

The ports the multiplayer server uses.

Region
  • string

The server's region.

Error Codes

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