> ## 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

> Enviar convite

# Enviar convite

Envia um convite para um usuário do XBOX Live.

Esta API permite que um cliente de jogo envie um convite para um usuário do XBOX Live para um título específico. O convite é enviado para todos os pontos de extremidade registrados, independentemente da plataforma.

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

<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. |
| 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)
* [SendInviteRequest](#sendinviterequest)
* [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="sendinviterequest" />

### SendInviteRequest

Se a plataforma não for definida na solicitação, o convite permitirá que o destinatário entre em qualquer plataforma na qual o jogo possa ser jogado. Caso contrário, incluirá apenas a plataforma listada.

**Observação:** a exceção é que, se Scarlett não estiver configurado como plataforma, os convites que especificam XboxOne também serão enviados para dispositivos Scarlett.

| 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) | |

<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

- [Requisitos XBOX testados na certificação para jogos de console XBOX](/pt-BR/publishing/certification/console-cert-tested-requirements.md)
- [XR-015 Gerenciamento das comunicações do jogador](/pt-BR/publishing/certification/xr/xr-015.md)
- [XR-064 Sessões de jogo com entrada permitida e jogo online](/pt-BR/publishing/certification/xr/xr-064.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)
- [Guia de BVT de PC da certificação](/pt-BR/publishing/game-publishing/concepts/certification/certification-pc-bvt-guide.md)