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

# GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions)

> GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions)

# GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/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](#ID4ET)
* [Parâmetros de URI](#ID4EKB)
* [Códigos de status HTTP](#ID4EXB)
* [Corpo da solicitação](#ID4EAC)
* [Corpo da resposta](#ID4EKC)

<a id="ID4ET" />

## 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 <b>Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync</b>.

> **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 <i>private</i> e <i>reservations</i>, o método retornará o código de erro 403 Forbidden, independentemente de essas sessões existirem ou não.

<a id="ID4EKB" />

## 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 <b>MultiplayerSessionVisibility</b>. |
\| 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.|

<a id="ID4EXB" />

## Códigos de status HTTP

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

<a id="ID4EAC" />

## Corpo da solicitação

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

<a id="ID4EKC" />

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

```cpp theme={null}
{
    "results": [ {
            "xuid": "9876",    // If the session was found from a xuid, that xuid.
            "startTime": "2009-06-15T13:45:30.0900000Z",
            "sessionRef": {
                "scid": "foo",
                "templateName": "bar",
                "name": "session-seven"
            },
            "accepted": 4,    // Approximate number of non-reserved members.



            "status": "active",    // or "reserved" or "inactive". This is the state of the user in the session, not the session itself. Only present if the session was found using a xuid.
            "visibility": "open",    // or "private", "visible", or "full"
            "joinRestriction": "local",    // or "followed". Only present if 'visibility' is "open" or "full" and the session has a join restriction.
            "myTurn": true,    // Not present is the same as 'false'. Only present if the session was found using a xuid.
            "keywords": [ "one", "two" ]
        }
    ]
}

```

<a id="ID4EUC" />

## Confira também

<a id="ID4EWC" />

##### Pai

[/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions](/pt-BR/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenamesessions)


## Related topics

- [XblMultiplayerSessionReferenceUri](/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionreferenceuri.md)
- [Multiplayer Session Directory overview](/services/xbox-services/multiplayer/mpsd/live-mpsd-overview.md)