> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar convite do servidor

> Enviar convite do servidor

# Enviar convite do servidor

Envia um convite para um usuário do XBOX com a cadeia de conexão fornecida.

Esta API permite que um servidor de jogo envie um convite para um usuário do XBOX Live. O corpo da solicitação contém uma cadeia de conexão que é usada pelo convidado para entrar no servidor. A cadeia de conexão pode conter o IP do servidor de jogo ou um ponteiro para uma sessão na qual o usuário está. O convite é enviado para todos os pontos de extremidade registrados, independentemente da plataforma.

```http theme={null}
POST /titles/{titleId}/invites/server
```

<a id="uri-parameters" />

## Parâmetros de URI

| Parâmetro | Em | Obrigatório | Tipo | Descrição |
| - | - | - | - | - |
| titleId | path | TRUE | integer | O titleId do jogo para o qual a solicitação está sendo enviada. |

<a id="request-header" />

## Cabeçalho da solicitação

| Nome | Obrigatório | Tipo | Descrição |
| - | - | - | - |
| Authorization | TRUE | integer | O chamador deve fornecer um XToken no formato de autorização XBL 3.0. Por exemplo, Authorization: XBL3.0 x=2553948354698;>token criptografado\<) |
| Content-Type | TRUE | string | ContentType deve ser definido como application/json |

<a id="request-body" />

## Corpo da solicitação

| Nome | Obrigatório | Tipo | Descrição |
| - | - | - | - |
| invitedUsers | TRUE | string\[] | O XUID dos usuários para os quais o convite está sendo enviado. O XUID é representado como um inteiro de base 10. O máximo é de 16 XUIDs. |
| sender | TRUE | string | A ID do usuário em nome de quem o convite está sendo enviado. |
| connectionString | | string | A cadeia de conexão é o que é passado para o jogo quando o convite chega ao usuário. A cadeia de conexão geralmente contém informações como o IP do servidor para permitir que o usuário convidado entre. Se o campo da cadeia de conexão for deixado vazio, o título será invocado com uma cadeia de conexão vazia. O comprimento da cadeia de conexão é limitado a 512 caracteres. |
| platform | | [Platform](#platform) | |

<a id="responses" />

## Respostas

| Nome | Tipo | Descrição |
| - | - | - |
| 204 No Content | | |
| O convite foi enviado com êxito. | | |
| 400 Bad Request | [ErrorResponse](#errorresponse) | Ocorreu um erro ao processar a solicitação. Possíveis códigos de erro: "RequestValidationError: falha na validação da solicitação.", " AuthorizationError: o chamador não tem permissão para acessar o recurso. Excesso de solicitações." |
| Outros códigos de status | [ThrottledEntity](#throttledentity) | Excesso de solicitações. Cabeçalhos Retry-After: integer |

<a id="definitions" />

## Definições

* [ErrorResponse](#errorresponse)
* [Platform](#platform)
* [SendServerInviteRequest](#sendserverinviterequest)
* [ThrottledEntity](#throttledentity)

<a id="errorresponse" />

### ErrorResponse

| Nome | Tipo | Descrição |
| - | - | - |
| debugMessage | string | Versão legível da mensagem de erro que pode ser usada para depuração. |
| errorCode | string | Enumeração do código de erro. |

<a id="platform" />

### Platform

| Nome | Tipo | Descrição |
| - | - | - |
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string | |
| Scarlett | string | |
| Win32 | string | |
| WindowsOneCore | string | |
| XboxOne | string | |

<a id="sendserverinviterequest" />

### SendServerInviteRequest

| Nome | Tipo | Descrição |
| - | - | - |
| connectionString | string | A cadeia de conexão é o que é passado para o jogo quando o convite chega ao usuário. A cadeia de conexão geralmente contém informações como o IP do servidor para permitir que o usuário convidado entre. Se o campo da cadeia de conexão for deixado vazio, o título será invocado com uma cadeia de conexão vazia. O comprimento da cadeia de conexão é limitado a 512 caracteres. |
| invitedUsers | string\[] | O XUID dos usuários para os quais o convite está sendo enviado. O XUID é representado como um inteiro de base 10. O máximo é de 16 XUIDs. |
| platform | [Platform](#platform) | |
| sender | string | A ID do usuário em nome de quem o convite está sendo enviado. |

<a id="throttleentity" />

### ThrottledEntity

| Nome | Tipo | Descrição |
| - | - | - |
| currentRequests | string | Número atual de solicitações - simultaneidade ou taxa. |
| debugMessage | string | Versão legível da mensagem de limitação que pode ser usada para depuração. |
| limitType | string | O tipo de limite, ou seja, simultaneidade ou taxa. |
| maxRequests | string | Máximo de solicitações permitidas - simultaneidade ou taxa. |
| periodInSeconds | string | O período em segundos que se aplica quando os limites de taxa ou simultaneidade são excedidos. |
| version | string | Versão atual do contrato de limitação. |


## Related topics

- [XR-015 Gerenciamento das comunicações do jogador](/pt-BR/publishing/certification/xr/xr-015.md)
- [Notas de versão do SDK C++ do PlayFab Multiplayer](/pt-BR/services/playfab/multiplayer/lobby/lobby-matchmaking-sdks/lobby-and-matchmaking-release-notes.md)
- [Requisitos XBOX testados na certificação para jogos de console XBOX](/pt-BR/publishing/certification/console-cert-tested-requirements.md)
- [XR-064 Sessões de jogo com entrada permitida e jogo online](/pt-BR/publishing/certification/xr/xr-064.md)
- [Requisitos do XBOX para jogos do XBOX](/pt-BR/publishing/certification/xbox-requirements.md)