Skip to main content

GET (/serviceconfigs//sessions)

Recupera as informações da sessão especificada.
Importante:
Agora, este método 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 as informações 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:
Cada chamada a este método deve incluir uma palavra-chave, um filtro de ID de usuário do XBOX ou ambos. Se o chamador não tiver as permissões corretas para os parâmetros private e reservations, o método retornará um código de erro 403 Forbidden, independentemente de essas sessões realmente 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 do XBOX dos usuários para os quais as sessões serão recuperadas. 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. Este parâmetro só pode ser definido como true. Essa configuração exige que o chamador tenha acesso no nível do servidor à sessão ou que a declaração de XUID do chamador corresponda ao filtro de ID de usuário do 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. Este parâmetro só pode ser definido como true.| | private| string| Valor que indica se a lista de sessões inclui sessões privadas. Este parâmetro só pode ser definido como true. Ele só é válido ao consultar suas próprias sessões ou ao consultar de servidor para servidor. Definir este parâmetro como true exige que o chamador tenha acesso no nível do servidor à sessão ou que a declaração de XUID do chamador corresponda ao filtro de ID de usuário do XBOX. | | visibility| string| Um valor de enumeração que indica o status de visibilidade usado na filtragem dos resultados. Atualmente, este 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 da 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//sessions
Last modified on October 6, 2026