Documentation

GetServerBackfillTicket

Get a matchmaking backfill ticket by ticket Id.

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

GetServerBackfillTicketRequest
Request Properties
EscapeObject (required) Boolean

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

QueueName (required) String

The name of the queue to find a match for.

TicketId (required) String

The Id of the ticket to find a match for.

POST https://{{TitleID}}.playfabapi.com/Match/GetServerBackfillTicket
    Content-Type: application/json
{
  "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
  "QueueName": "custom123",
  "EscapeObject": false
}
        

Response Details

GetServerBackfillTicketResult
Result Properties
CancellationReason (proposed) CancellationReason

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

CancellationReasonString String

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

Created (required) DateTime

The server date and time at which ticket was created.

GiveUpAfterSeconds (required) int32

How long to attempt matching this ticket in seconds.

MatchId String

The Id of a match.

Members (required) List<MatchmakingPlayerWithTeamAssignment>

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

QueueName (required) String

The Id of a match queue.

ServerDetails (required) ServerDetails

The details of the server the members are connected to.

Status (required) String

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

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",
    "QueueName": "custom123",
    "MatchId": "4e0c5fd7-80e9-4744-b0ce-061a7f067ff5",
    "Created": "2016-08-23T12:33:14Z",
    "Status": "Matched",
    "GiveUpAfterSeconds": 100,
    "Members": [],
    "ServerDetails": {
      "IPV4Address": "10.250.24.54",
      "Ports": [
        {
          "Name": "PortName",
          "Num": 1243,
          "Protocol": "TCP"
        }
      ],
      "Region": "WestUS"
    }
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingRequestTypeMismatch 2058
MatchmakingTicketNotFound 2018
MatchmakingUnauthorized 2056