Passer au contenu principal
POST
Get Match

Autorisations

X-EntityToken
string
header
requis

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corps

application/json

When matchmaking has successfully matched together a collection of tickets, it produces a 'match' with an Id. The match contains all of the players that were matched together, and their team assigments. Only servers and ticket members can get the match.

When matchmaking has successfully matched together a collection of tickets, it produces a 'match' with an Id. The match contains all of the players that were matched together, and their team assigments. Only servers and ticket members can get the match.

EscapeObject
boolean
requis

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

MatchId
string
requis

The Id of a match.

QueueName
string
requis

The name of the queue to join.

ReturnMemberAttributes
boolean
requis

Determines whether the matchmaking attributes for each user should be returned in the response for match request.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Réponse

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Exemple:
Dernière modification le 6 octobre 2026