Matchmaking - Create Server Backfill Ticket

Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with other backfill tickets.

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

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

How long to attempt matching this ticket in seconds.

Members True

The users who will be part of this ticket, along with their team assignments.

QueueName True
  • string

The Id of a match queue.

CustomTags
  • object

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

ServerDetails

The details of the server the members are connected to.

Responses

Name Type Description
200 OK
400 Bad Request

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

ApiErrorWrapper

The basic wrapper around every failed API response

CreateServerBackfillTicketRequest

The server specifies all the members, their teams and their attributes, and the server details if applicable.

CreateServerBackfillTicketResult
EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

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

CreateServerBackfillTicketRequest

The server specifies all the members, their teams and their attributes, and the server details if applicable.

Name Type Description
CustomTags
  • object

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

GiveUpAfterSeconds
  • number

How long to attempt matching this ticket in seconds.

Members

The users who will be part of this ticket, along with their team assignments.

QueueName
  • string

The Id of a match queue.

ServerDetails

The details of the server the members are connected to.

CreateServerBackfillTicketResult

Name Type Description
TicketId
  • string

The Id of the ticket to find a match for.

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

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

The ports the multiplayer server uses.

Region
  • string

The server's region.

Error Codes

Name Code
MatchmakingAttributeInvalid 2046
MatchmakingBadRequest 2059
MatchmakingEntityInvalid 2001
MatchmakingMemberProfileInvalid 2032
MatchmakingNumberOfPlayersInTicketTooLarge 2044
MatchmakingPlayerAttributesInvalid 2002
MatchmakingPlayerAttributesTooLarge 2043
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingTicketMembershipLimitExceeded 2055
MatchmakingUnauthorized 2056