Documentation

CreateServerBackfillTicket

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.

Attention, this is a flagged API

Beta
This API is under development; Please let us know if you find any bugs or inconsistencies. Also note, that minor changes may occur before this API leaves beta.

Please let us know if you find any issues or inconsistencies.

Request Details

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

CreateServerBackfillTicketRequest
Request Properties
GiveUpAfterSeconds (required) int32

How long to attempt matching this ticket in seconds.

Members (required) List<MatchmakingPlayerWithTeamAssignment>

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

QueueName (required) String

The Id of a match queue.

ServerDetails ServerDetails

The details of the server the members are connected to.

POST https://{{TitleID}}.playfabapi.com/Match/CreateServerBackfillTicket
    Content-Type: application/json
{
  "Members": [],
  "GiveUpAfterSeconds": 100,
  "ServerDetails": {
    "IPV4Address": "10.250.24.54",
    "Ports": [
      {
        "Name": "PortName",
        "Num": 1243,
        "Protocol": "TCP"
      }
    ],
    "Region": "WestUS"
  },
  "QueueName": "custom123"
}
        

Response Details

CreateServerBackfillTicketResult
Result Properties
TicketId (required) String

The Id of the ticket to find a match for.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c"
  }
}

Authentication

EntityToken

Possible 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