Matchmaking - Create Server Matchmaking Ticket

Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other matchmaking tickets.

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

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.

QueueName True
  • string

The Id of a match queue.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

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

CreateMatchmakingTicketResult
CreateServerMatchmakingTicketRequest

The server specifies all the members and their attributes.

EntityKey

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

MatchmakingPlayer

A user in a matchmaking ticket.

MatchmakingPlayerAttributes

The matchmaking attributes for a user.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

CreateMatchmakingTicketResult

Name Type Description
TicketId
  • string

The Id of the ticket to find a match for.

CreateServerMatchmakingTicketRequest

The server specifies all the members and their attributes.

Name Type Description
GiveUpAfterSeconds
  • number

How long to attempt matching this ticket in seconds.

Members

The users who will be part of this ticket.

QueueName
  • string

The Id of a match queue.

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://api.playfab.com/docs/tutorials/entities/entitytypes

TypeString
  • string

Alternate name for Type.

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
MatchmakingAttributeInvalid 2046
MatchmakingEntityInvalid 2001
MatchmakingMemberProfileInvalid 2032
MatchmakingNumberOfPlayersInTicketTooLarge 2044
MatchmakingPlayerAttributesInvalid 2002
MatchmakingPlayerAttributesTooLarge 2043
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingTicketMembershipLimitExceeded 2055
MatchmakingUnauthorized 2056