/serviceconfigs/{scid}/sessions

支持执行 GET 操作以检索一组会话文档。

sessiondirectory.xboxlive.com

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 字符串 一个正整数,指示要检索的会话的最大数目。

有效方法

GET (/serviceconfigs/{scid}/sessions)

  检索指定的会话信息。

另请参阅

父级

会话目录 URI