GET (/serviceconfigs/{scid}/sessions)

项目
05/09/2023

检索指定的会话信息。

重要提示：
此方法现在需要每个请求都有一个 X-Xbl-Contract-Version 104/105 或更高版本的标头元素。

备注
URI 参数
HTTP 状态代码
请求正文
响应正文

备注

此 HTTP/REST 方法为提供的筛选器检索会话信息。此方法可由 Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsAsync 包装。

注意：
对于 2015 多人游戏，此方法可由 Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync 调用。

注意：
对此方法的每个调用都必须包括关键字和/或 Xbox 用户 ID 筛选器。如果调用方对 private 和 reservations 参数没有正确的权限，则该方法将返回“403 已禁止”的错误代码（无论是否确实存在任何此类会话）。

URI 参数

参数	类型	说明
scid	GUID	服务配置标识符 (SCID)。会话 ID 的第 1 部分。
keyword	字符串	一个关键字，用于将结果筛选为只显示用该字符串标识的会话。
xuid	GUID	要为其检索会话的用户的 Xbox 用户 ID。用户必须在会话中处于活动状态。
reservations	字符串	一个值，指示会话列表是否包含用户尚未接受的会话。此参数只能设置为 true。此设置要求调用方具有对会话的服务器级访问权限，或者需要调用方的 XUID 声明以匹配 Xbox 用户 ID 筛选器。
inactive	字符串	一个值，指示会话列表是否包含用户已接受但未积极参与的会话。此参数只能设置为 true。
private	字符串	一个值，指示会话列表是否包含专用会话。此参数只能设置为 true。仅在查询你自己的会话或进行服务器到服务器查询时才有效。将此参数设置为 true 要求调用方具有对会话的服务器级访问权限，或者需要调用方的 XUID 声明以匹配 Xbox 用户 ID 筛选器。
visibility	字符串	一个枚举值，指示筛选结果中使用的可见性状态。目前，此参数只能设置为“打开”以包含打开的会话。请参阅 MultiplayerSessionVisibility。
版本	字符串	一个正整数，指示要包括的主会话版本或更低版本的会话。该值必须小于或等于请求的协定版本 mod 100。
take	字符串	一个正整数，指示要检索的会话的最大数目。

HTTP 状态代码

该服务返回 HTTP 状态代码，因为它适用于 MPSD。

请求正文

对象不会在此请求的正文中发送。

响应正文

此方法返回的是一个会话引用的 JSON 阵列，其中内联包含了一些会话数据。

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

另请参阅

父级

/serviceconfigs/{scid}/sessions

通过