Lobby error messages#

The Lobby service returns errors in the "problem details" format (RFC 7807) including some additional fields that are consistent with most other UGS services.

Example:

{
  "title": "Bad Request",
  "status": 400,
  "code": 16000,
  "detail": "request failed validation",
  "details": [
    {
      "errorType": "validation",
      "message": "count in body should be less than or equal to 100"
    }
    {
      "errorType": "validation",
      "message": "skip in body should be greater than or equal to 0"
    }
  ],
  "type": "http://unity3d/lobby/errors/validation-error"
}

Error Status#

Error Details#

Error codes#

The code property of an error response from the Lobby service can be used to programmatically identify the type of problem that has occurred. These are used by the SDK to automatically resolve certain issues (e.g. refreshing an expired token, retrying a request that failed due to a transient error, etc.) and they are exposed to the developer in the exceptions thrown by the SDK so that the client can react appropriately.

Common error codes will be in the range 0-999. These are usually seen when there is an issue with some component in between the client and the lobby service (such as network connectivity, an authentication failure, or rate limit). In cases where these aren't handled transparently, they will usually indicate more serious errors with the service and should generally be more rare.

Lobby specific error codes will be in the range 16000-16999. These are used to identify specific error cases in the lobby service. Many of these are common and will occur during normal operation of the service and should be handled by the game developer to provide a smooth user experience. For example, when performing a Join action you may see the error LobbyNotFound (16001), which could just mean that the lobby you tried to join was deleted since the query results were returned and the game client should handle this gracefully.

It may seem like there is some overlap between certain common and lobby specific error codes (NotFound being the most obvious example), but they should not be handled the same way. The common NotFound error code likely indicates a functional problem with the SDK or API client (such as an incorrectly configured request URL). You should examine the error details for more information about the specific problem to identify how to resolve it.