Matchmaking - Get Matchmaking Ticket
Get a matchmaking ticket by ticket Id.
POST https://titleId.playfabapi.com/Match/GetMatchmakingTicketRequest 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 | ||
| 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
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Get |
The ticket includes the invited players, their attributes if they have joined, the ticket status, the match Id when applicable, etc. Only servers, the ticket creator and the invited players can get the ticket. |
|
Get |
|
|
Matchmaking |
A user in a matchmaking ticket. |
|
Matchmaking |
The matchmaking attributes for a user. |
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 |
GetMatchmakingTicketRequest
The ticket includes the invited players, their attributes if they have joined, the ticket status, the match Id when applicable, etc. Only servers, the ticket creator and the invited players 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. |
GetMatchmakingTicketResult
| 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. Please retry if CancellationReason is RetryRequired. |
| ChangeNumber |
number |
Change number used for differentiating older matchmaking status updates from newer ones. |
| Created |
string |
The server date and time at which ticket was created. |
| Creator |
The Creator's entity key. |
|
| GiveUpAfterSeconds |
number |
How long to attempt matching this ticket in seconds. |
| MatchId |
string |
The Id of a match. |
| Members |
A list of Users that have joined this ticket. |
|
| MembersToMatchWith |
A list of PlayFab Ids of Users to match with. |
|
| QueueName |
string |
The Id of a match queue. |
| Status |
string |
The current ticket status. Possible values are: WaitingForPlayers, WaitingForMatch, WaitingForServer, Canceled and Matched. |
| TicketId |
string |
The Id of the ticket to find a match for. |
MatchmakingPlayer
A user in a matchmaking ticket.
| Name | Type | Description |
|---|---|---|
| Attributes |
The user's attributes custom to the title. |
|
| Entity |
The entity key of the matchmaking user. |
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. |
Error Codes
| Name | Code |
|---|---|
| MatchmakingEntityInvalid | 2001 |
| MatchmakingQueueNotFound | 2016 |
| MatchmakingRateLimitExceeded | 2054 |
| MatchmakingRequestTypeMismatch | 2058 |
| MatchmakingTicketNotFound | 2018 |
| MatchmakingUnauthorized | 2056 |