Matchmaking - Get Server Backfill Ticket

Get a matchmaking backfill ticket by ticket Id.

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

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.

QueueName True

string

The name of the queue to find a match for.

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

GetServerBackfillTicketResult

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.

GetServerBackfillTicketRequest

The ticket includes the players, their attributes, their teams, the ticket status, the match Id and the server details when applicable, etc. Only servers can get the ticket.

GetServerBackfillTicketResult
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

GetServerBackfillTicketRequest

The ticket includes the players, their attributes, their teams, the ticket status, the match Id and the server details when applicable, etc. Only servers can get the ticket.

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.

QueueName

string

The name of the queue to find a match for.

TicketId

string

The Id of the ticket to find a match for.

GetServerBackfillTicketResult

Name Type Description
CancellationReasonString

string

The reason why the current ticket was canceled. This field is only set if the ticket is in canceled state.

Created

string

The server date and time at which ticket was created.

GiveUpAfterSeconds

number

How long to attempt matching this ticket in seconds.

MatchId

string

The Id of a match.

Members

MatchmakingPlayerWithTeamAssignment[]

A list of Users that are part of this ticket, along with their team assignments.

QueueName

string

The Id of a match queue.

ServerDetails

ServerDetails

The details of the server the members are connected to.

Status

string

The current ticket status. Possible values are: WaitingForMatch, Canceled and Matched.

TicketId

string

The Id of the ticket to find a match for.

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
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingRequestTypeMismatch 2058
MatchmakingTicketNotFound 2018
MatchmakingUnauthorized 2056