Join Queue
POST /session/v1/session/{session_id}/queue
Add session to a matchmaking queue
Required Permissions:
- For any player (including themselves) any of:
session:*
,session:update:any
,session:update:self
Required Session Permissions: SessionPermissions.session_admin
Authorizations
Parameters
Path Parameters
Request Body required
A request body to enter into a matchmaking queue
object
ID of the queue to join
Additional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields)
object
Additional double arguments to add to the matchmaking ticket
object
Additional string arguments to add to the matchmaking ticket
object
Additional tags to add to the matchmaking ticket
Additional extensions to add to the matchmaking ticket. Value is a base64 string representation of the protobuf binary data. The data will be converted back to binary before being put on the ticket
object
List of map preferences in order from most desired, to least desired
Argument to artifcially add queue time to a ticket. Older tickets are considered for lower quaulity matches. This can be used to get faster matches at the expense of quality, or to restore a session’s place in queue after a failure
Responses
200
Successful Response
A response for successfully joining a matchmaking queue
object
ID for the newly created match making ticket
403
Forbidden
object
422
Validation Error