Skip to content
RallyHere Docs

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

session_id
required
string
>= 1 characters <= 128 characters

Request Body required

A request body to enter into a matchmaking queue

object
queue_id
required

ID of the queue to join

string
>= 1 characters <= 128 characters
additional_join_params

Additional fields put on the matchmaking ticket for open match to search with (see https://openmatch.dev/site/docs/reference/api/#searchfields)

object
double_args

Additional double arguments to add to the matchmaking ticket

object
key
additional properties
number
string_args

Additional string arguments to add to the matchmaking ticket

object
key
additional properties
string
>= 1 characters <= 4096 characters
tags

Additional tags to add to the matchmaking ticket

Array<string>
default:
extensions

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
key
additional properties
string
>= 1 characters <= 4096 characters
map_preferences

List of map preferences in order from most desired, to least desired

Array<string>
default:
passed_queue_time_seconds

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

integer

Responses

200

Successful Response

A response for successfully joining a matchmaking queue

object
ticket_id
required

ID for the newly created match making ticket

string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string