Multiplayer Server - Request Party Service
Request a party session.
Allowed entity token types: title, game_server
POST https://titleId.playfabapi.com/Party/RequestPartyServiceRequest 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 | Required | Type | Description |
|---|---|---|---|
| NetworkConfiguration | True |
The network configuration for this request. |
|
| PreferredRegions | True |
The preferred regions to request a party session from. The party service will iterate through the regions in the specified order and allocate a party session from the first one that is available. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
|
| PartyId |
string |
A guid string party ID created track the party session over its life. |
|
| PlayFabId |
string |
A player entity Id on behalf of whom the request is being made. |
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 |
|
Azure |
|
|
Direct |
|
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Party |
|
|
Party |
|
|
Party |
|
|
Request |
Requests a party session from a particular set of builds if build alias params is provided, in any of the given preferred regions. |
|
Request |
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 |
AzureRegion
| Value | Description |
|---|---|
| AustraliaEast | |
| AustraliaSoutheast | |
| BrazilSouth | |
| CentralUs | |
| EastAsia | |
| EastUs | |
| EastUs2 | |
| JapanEast | |
| JapanWest | |
| NorthCentralUs | |
| NorthEurope | |
| SouthCentralUs | |
| SoutheastAsia | |
| WestEurope | |
| WestUs | |
| SouthAfricaNorth | |
| WestCentralUs | |
| KoreaCentral | |
| FranceCentral | |
| WestUs2 | |
| CentralIndia | |
| UaeNorth | |
| UkSouth | |
| SwedenCentral | |
| CanadaCentral | |
| MexicoCentral |
DirectPeerConnectivityOptions
| Value | Description |
|---|---|
| None | |
| SamePlatformType | |
| DifferentPlatformType | |
| AnyPlatformType | |
| SameEntityLoginProvider | |
| DifferentEntityLoginProvider | |
| AnyEntityLoginProvider | |
| AnyPlatformTypeAndEntityLoginProvider | |
| OnlyServers |
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 |
PartyInvitationConfiguration
| Name | Type | Description |
|---|---|---|
| EntityKeys |
The list of PlayFab EntityKeys that the invitation allows to authenticate into the network. If this list is empty, all users are allowed to authenticate using the invitation's identifier. This list may contain no more than 1024 items. |
|
| Identifier |
string |
The invite identifier for this party. If this value is specified, it must be no longer than 127 characters. |
| Revocability |
Controls which participants can revoke this invite. |
PartyInvitationRevocability
| Value | Description |
|---|---|
| Creator | |
| Anyone |
PartyNetworkConfiguration
| Name | Type | Description |
|---|---|---|
| DirectPeerConnectivityOptions |
Controls whether and how to support direct peer-to-peer connection attempts among devices in the network. |
|
| MaxDevices |
number |
The maximum number of devices allowed to connect to the network. Must be between 1 and 128, inclusive. |
| MaxDevicesPerUser |
number |
The maximum number of devices allowed per user. Must be greater than 0. |
| MaxEndpointsPerDevice |
number |
The maximum number of endpoints allowed per device. Must be between 0 and 32, inclusive. |
| MaxUsers |
number |
The maximum number of unique users allowed in the network. Must be greater than 0. |
| MaxUsersPerDevice |
number |
The maximum number of users allowed per device. Must be between 1 and 8, inclusive. |
| PartyInvitationConfiguration |
An optionally-specified configuration for the initial invitation for this party. If not provided, default configuration values will be used: a title-unique invitation identifier will be generated, the revocability will be Anyone, and the EntityID list will be empty. |
RequestPartyServiceRequest
Requests a party session from a particular set of builds if build alias params is provided, in any of the given preferred regions.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| NetworkConfiguration |
The network configuration for this request. |
|
| PartyId |
string |
A guid string party ID created track the party session over its life. |
| PlayFabId |
string |
A player entity Id on behalf of whom the request is being made. |
| PreferredRegions |
The preferred regions to request a party session from. The party service will iterate through the regions in the specified order and allocate a party session from the first one that is available. |
RequestPartyServiceResponse
| Name | Type | Description |
|---|---|---|
| InvitationId |
string |
The invitation identifier supplied in the PartyInvitationConfiguration, or the PlayFab-generated guid if none was supplied. |
| PartyId |
string |
The guid string party ID of the party session. |
| SerializedNetworkDescriptor |
string |
A base-64 encoded string containing the serialized network descriptor for this party. |
Error Codes
| Name | Code |
|---|---|
| PartyBadRequest | 1434 |
| PartyInternalServerError | 1439 |
| PartyNotFound | 1437 |
| PartyRequestsThrottledFromRateLimiter | 1504 |
| PartyTooManyRequests | 1441 |
| PartyUnauthorized | 1435 |
| PartyUnavailable | 1440 |