> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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 plantilla de sesión.

> **Importante:**\
> Este método de URI requiere un elemento de encabezado X-Xbl-Contract-Version: 104/105 o posterior en cada solicitud.

* [Comentarios](#ID4ET)
* [Parámetros de URI](#ID4EKB)
* [Códigos de estado HTTP](#ID4EXB)
* [Cuerpo de la solicitud](#ID4EAC)
* [Cuerpo de la respuesta](#ID4EKC)

## Comentarios

Este método HTTP/REST recupera información de plantilla de sesión para los filtros proporcionados. Este método se puede encapsular mediante **Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsAsync**.

> **Nota:**\
> Para 2015 Multiplayer, este método se llama mediante **Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync**.

> **Nota:**\
> Cada llamada a este método debe incluir una palabra clave, un filtro de id. de usuario de XBOX, o ambos. Si el autor de la llamada no tiene los permisos correctos para los parámetros *private* y *reservations*, el método devuelve un código de error 403 Prohibido, independientemente de que dichas sesiones existan realmente o no.

## Parámetros de URI

\| Parámetro| Tipo| Descripción|
\| --- | --- | --- | --- | --- | --- |
\| scid| GUID| Identificador de configuración de servicio (SCID). Parte 1 del id. de sesión.|
\| keyword| string| Palabra clave que se usa para filtrar los resultados solo a las sesiones identificadas con esa cadena.|
\| xuid| GUID| Id. de usuario de XBOX de los usuarios para los que se recuperan las sesiones. Los usuarios deben estar activos en las sesiones. |
\| reservations| string| Valor que indica si la lista de sesiones incluye las que los usuarios no han aceptado. Este parámetro solo se puede establecer en true. Esta configuración requiere que el autor de la llamada tenga acceso de nivel de servidor a la sesión, o que la notificación XUID del autor de la llamada coincida con el filtro de id. de usuario de XBOX. |
\| inactive| string| Valor que indica si la lista de sesiones incluye las que los usuarios han aceptado pero en las que no están jugando activamente. Este parámetro solo se puede establecer en true. |
\| private| string| Valor que indica si la lista de sesiones incluye sesiones privadas. Este parámetro solo se puede establecer en true. Solo es válido al consultar sus propias sesiones o al realizar consultas de servidor a servidor. Establecer este parámetro en true requiere que el autor de la llamada tenga acceso de nivel de servidor a la sesión, o que la notificación XUID del autor de la llamada coincida con el filtro de id. de usuario de XBOX. |
\| visibility| string| Valor de enumeración que indica el estado de visibilidad que se usa para filtrar los resultados. Actualmente, este parámetro solo se puede establecer en Open para incluir sesiones abiertas. Consulte **MultiplayerSessionVisibility**. |
\| version| string| Entero positivo que indica la versión de sesión principal, o una inferior, de las sesiones que se van a incluir. El valor debe ser menor o igual que la versión de contrato de la solicitud módulo 100. |
\| take| string| Entero positivo que indica el número máximo de sesiones que se van a recuperar.|

## Códigos de estado HTTP

El servicio devuelve un código de estado HTTP según se aplica a MPSD.

## Cuerpo de la solicitud

No se envía ningún objeto en el cuerpo de esta solicitud.

## Cuerpo de la respuesta

El valor devuelto de este método es una matriz JSON de referencias de sesión, con algunos datos de sesión incluidos en línea.

```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" ]
        }
    ]
}

```

## Consulte también

##### Elemento primario

[/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenamesessions.md)


## Related topics

- [GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName})](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenameget.md)
- [GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName})](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenamesessionssessionnameget.md)
- [/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenamesessions.md)
- [/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatename.md)
- [/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName}](https://docs.xbox.com/es/reference/live/rest/uri/sessiondirectory/uri-serviceconfigsscidsessiontemplatessessiontemplatenamesessionssessionname.md)
