Matchmaking - Create Matchmaking Ticket
Create a matchmaking ticket as a client.
POST https://titleId.playfabapi.com/Match/CreateMatchmakingTicket
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-EntityToken | True |
|
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
Creator | True |
The User who created this ticket. |
|
GiveUpAfterSeconds | True |
|
How long to attempt matching this ticket in seconds. |
QueueName | True |
|
The Id of a match queue. |
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
MembersToMatchWith |
A list of Entity Keys of other users to match with. |
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
Api |
The basic wrapper around every failed API response |
Create |
The client specifies the creator's attributes and optionally a list of other users to match with. |
Create |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
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 |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
CreateMatchmakingTicketRequest
The client specifies the creator's attributes and optionally a list of other users to match with.
Name | Type | Description |
---|---|---|
Creator |
The User who created this ticket. |
|
CustomTags |
|
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
GiveUpAfterSeconds |
|
How long to attempt matching this ticket in seconds. |
MembersToMatchWith |
A list of Entity Keys of other users to match with. |
|
QueueName |
|
The Id of a match queue. |
CreateMatchmakingTicketResult
Name | Type | Description |
---|---|---|
TicketId |
|
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 |
|
Unique ID of the entity. |
Type |
|
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
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 |
|
A data object representing a user's attributes. |
EscapedDataObject |
|
An escaped data object representing a user's attributes. |
Error Codes
Name | Code |
---|---|
MatchmakingAttributeInvalid | 2046 |
MatchmakingBadRequest | 2059 |
MatchmakingEntityInvalid | 2001 |
MatchmakingNumberOfPlayersInTicketTooLarge | 2044 |
MatchmakingPlayerAttributesInvalid | 2002 |
MatchmakingPlayerAttributesTooLarge | 2043 |
MatchmakingQueueNotFound | 2016 |
MatchmakingRateLimitExceeded | 2054 |
MatchmakingTicketMembershipLimitExceeded | 2055 |
MatchmakingUnauthorized | 2056 |