Provides access to the Steam Lobby methods.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

For more info on how to use the Steamworks Web API please see the Web API Overview.

CreateLobby

Name	Type	Required	Description
key	string	✔	Steamworks Web API user authentication key.
appid	uint32	✔	The ID of the application associated with the lobby.
max_members	int32	✔	Maximum number of members for this lobby.
lobby_type	int32	✔	ELobbyType - The type and visibility of this lobby.
lobby_name	string		Unique lobby name if lobby_type = 4. Find lobby with this name if it exists.
input_json	string		Json data. Required for data that cannot be posted parameters, but can also be used for the other parameters
steamid_invited_members	array of uint64	✔	Array of steamIDs to add slots for. Must be specified in the input_json parameter.
lobby_metadata	message		Optional lobby data. Must be specified in the input_json parameter.

Structure of the lobby_metadata property:

Name	Type	Required	Description
key_name	string		Key name
key_value	string		Key value

When using the CreateLobby WebAPI, you'll probably want to set lobby_type to 4 (k_ELobbyTypePrivateUnique). This lobby type is a private, unique lobby that does not get deleted when emptied, and only one will exist per unique appid/lobby_name. A private unique lobby can only be created by this WebAPI call. But you can also use CreateLobby to generate the more traditional and ephemeral lobbies when no lobby_name is used.

Steamid_invited_members will be a json array of all the steamIDs that should be currently allowed into the lobby. You can update the list of members by calling CreateLobby with the same lobby_name and new complete set of steamIDs. Any steamIDs that were previously in the lobby and not included in the new call will be removed from the lobby.

Lobby_metadata is completely optional, but can be used to send general lobby data that needs to be communicated to users in the client.

Example Params:

Response:

• response
  
  • success - True if the method was successful.
    
  • appid - AppID that the lobby was created for.
    
  • steamid_lobby - The lobby ID.
    

RemoveUserFromLobby

Name	Type	Required	Description
key	string	✔	Steamworks Web API user authentication key.
appid	uint32	✔	The ID of the application associated with the lobby.
steamid_to_remove	uint64	✔	SteamID of the user to remove. If the user is not online when called, this will remove their reserved slot in the lobby.
steamid_lobby	uint64	✔	Lobby ID
input_json	string		Json data. Required for data that cannot be posted parameters, but can also be used for the other parameters

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetLobbyData

Name	Type	Required	Description
key	string	✔	Steamworks Web API user authentication key.
appid	uint32	✔	The ID of the application associated with the lobby.
steamid_lobby	uint64	✔	Lobby ID.

GetLobbyData will return any lobby data and member list for the lobby ID.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

Example Response: