Skip to main content

GET (/serviceconfigs//sessiontemplates//sessions)

Recupera documentos de modelo de sessão.
Importante:
Este método de URI requer um elemento de cabeçalho X-Xbl-Contract-Version: 104/105 ou posterior em todas as solicitações.

Comentários

Este método HTTP/REST recupera informações de modelo de sessão para os filtros fornecidos. Este método pode ser encapsulado por Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsAsync.
Observação:
Para o Multiplayer 2015, este método é chamado por Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync.
Observação:
Toda chamada a este método deve incluir uma palavra-chave, um filtro de ID de usuário XBOX ou ambos. Se o chamador não tiver as permissões corretas para os parâmetros private e reservations, o método retornará o código de erro 403 Forbidden, independentemente de essas sessões existirem ou não.

Parâmetros de URI

| Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | | scid| GUID| Identificador de configuração de serviço (SCID). Parte 1 da ID da sessão.| | keyword| string| Uma palavra-chave usada para filtrar os resultados apenas para as sessões identificadas com essa cadeia de caracteres.| | xuid| GUID| IDs de usuário XBOX dos usuários para os quais recuperar sessões. Os usuários devem estar ativos nas sessões. | | reservations| string| Valor que indica se a lista de sessões inclui aquelas que os usuários não aceitaram. Esse parâmetro só pode ser definido como true. Essa configuração exige que o chamador tenha acesso em nível de servidor à sessão ou que a declaração XUID do chamador corresponda ao filtro de ID de usuário XBOX. | | inactive| string| Valor que indica se a lista de sessões inclui aquelas que os usuários aceitaram, mas nas quais não estão jogando ativamente. Esse parâmetro só pode ser definido como true. | | private| string| Valor que indica se a lista de sessões inclui sessões privadas. Esse parâmetro só pode ser definido como true. Ele é válido somente ao consultar suas próprias sessões ou ao fazer consultas de servidor para servidor. Definir esse parâmetro como true exige que o chamador tenha acesso em nível de servidor à sessão ou que a declaração XUID do chamador corresponda ao filtro de ID de usuário XBOX. | | visibility| string| Um valor de enumeração que indica o status de visibilidade usado na filtragem dos resultados. Atualmente, esse parâmetro só pode ser definido como Open para incluir sessões abertas. Consulte MultiplayerSessionVisibility. | | version| string| Um inteiro positivo que indica a versão principal de sessão, ou inferior, das sessões a serem incluídas. O valor deve ser menor ou igual à versão do contrato da solicitação módulo 100. | | take| string| Um inteiro positivo que indica o número máximo de sessões a serem recuperadas.|

Códigos de status HTTP

O serviço retorna um código de status HTTP conforme aplicável ao MPSD.

Corpo da solicitação

Nenhum objeto é enviado no corpo desta solicitação.

Corpo da resposta

O retorno deste método é uma matriz JSON de referências de sessão, com alguns dados de sessão incluídos embutidos.

Confira também

Pai
/serviceconfigs//sessiontemplates//sessions
Last modified on October 6, 2026