Lobby - Invite To Lobby
Send a notification to invite a player to a lobby.
POST https://titleId.playfabapi.com/Lobby/InviteToLobbyRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| InviteeEntity |
The entity invited to the lobby. |
|
| LobbyId |
string |
The id of the lobby. |
| MemberEntity |
The member entity sending the invite. Must be a member of the lobby. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Invite |
Request to invite a player to a lobby the caller is already a member of. Only a client can invite another player to a lobby. |
|
Lobby |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
InviteToLobbyRequest
Request to invite a player to a lobby the caller is already a member of. Only a client can invite another player to a lobby.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| InviteeEntity |
The entity invited to the lobby. |
|
| LobbyId |
string |
The id of the lobby. |
| MemberEntity |
The member entity sending the invite. Must be a member of the lobby. |
LobbyEmptyResult
Error Codes
| Name | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDoesNotExist | 13000 |
| LobbyPlayerNotPresent | 13006 |
| LobbyRateLimitExceeded | 13001 |