GET (/users/xuid({xuid})/groups/{moniker}/broadcasting )
检索 URI 中出现的与 XUID 相关的组名字对象指定的广播用户的状态记录。
这些 URI 的域是 userpresence.xboxlive.com。
访问 URI 中出现的与 XUID 相关的组名字对象指定的广播用户的状态记录。
URI 参数
| 参数 |
类型 |
说明 |
| xuid |
字符串 |
与组中的 XUID 相关的用户的 Xbox 用户 ID (XUID)。 |
| 名字对象 |
字符串 |
定义用户组的字符串。 目前唯一接受的名字对象是“People”，“P”大写。 |
查询字符串参数
| 参数 |
类型 |
说明 |
| level |
字符串 |
返回此查询字符串指定的详细信息级别。 有效选项包括“user”、“device”、“title”和“all”。“user”级别是不带 DeviceRecord 嵌套对象的 PresenceRecord 对象。 “device”级别是不带 TitleRecord 嵌套对象的 PresenceRecord 和 DeviceRecord 对象。 “title”级别是不带 ActivityRecord 嵌套对象的 PresenceRecord、DeviceRecord 和 TitleRecord 对象。 “all”级别是整个记录，包括所有嵌套对象。如果不提供此参数，服务将默认为游戏级别（即，返回此用户的状态直到游戏详细信息）。 |
授权
| 已使用授权声明 |
声明 |
类型 |
必填？ |
示例值 |
|
Xuid |
64 位有符号整数 |
是 |
1234567890 |
|
隐私设置对资源的影响
如果请求本身格式正确，服务将始终返回 200 OK。 但是，在未通过隐私检查时，它将从响应中筛选掉信息。
| 隐私设置对资源的影响 |
请求用户 |
目标用户的隐私设置 |
行为 |
| 我 |
- |
如文中所述。 |
|
| 好友 |
所有人 |
如文中所述。 |
|
| 好友 |
仅好友 |
如文中所述。 |
|
| 好友 |
已阻止 |
如文中所述 - 服务将筛选掉数据。 |
|
| 非好友用户 |
所有人 |
如文中所述。 |
|
| 非好友用户 |
仅好友 |
如文中所述 - 服务将筛选掉数据。 |
|
| 非好友用户 |
已阻止 |
如文中所述 - 服务将筛选掉数据。 |
|
| 第三方站点 |
所有人 |
如文中所述 - 服务将筛选掉数据。 |
|
| 第三方站点 |
仅好友 |
如文中所述 - 服务将筛选掉数据。 |
|
| 第三方站点 |
已阻止 |
如文中所述 - 服务将筛选掉数据。 |
|
| 标头 |
类型 |
说明 |
| 授权 |
字符串 |
HTTP 身份验证的身份验证凭据。 示例值：“XBL3.0 x=<userhash>;<token>”。 |
| x-xbl-contract-version |
字符串 |
此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。 在验证标头的有效性、身份验证令牌中的声明等信息之后，请求将仅路由到该服务。 示例值：3，vnext。 |
| Accept |
字符串 |
可接受的 Content-Type。 仅一个“状态”支持是 application/json，但还必须在标头中进行指定。 |
| Accept-Language |
字符串 |
响应中字符串的可接受区域设置。 示例值：en-US。 |
| 主机 |
字符串 |
服务器域名。 示例值：userpresence.xboxlive.com。 |
| 标头 |
类型 |
说明 |
| X-RequestedServiceVersion |
|
此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。 在验证标头的有效性、身份验证令牌中的声明等信息之后，请求将仅路由到该服务。 默认值：1。 |
请求正文
对象不会在此请求的正文中发送。
HTTP 状态代码
服务返回此部分中的状态代码之一，以响应使用此方法对此资源发出的请求。 对于用于 Xbox Live 服务的标准 HTTP 状态代码的完整列表，请参阅标准 HTTP 状态代码。
| 代码 |
原因短语 |
说明 |
| 200 |
OK |
会话成功检索。 |
| 400 |
无效请求 |
服务无法理解格式错误的请求。 通常是无效参数。 |
| 401 |
未授权 |
请求需要用户身份验证。 |
| 403 |
已禁止 |
用户或服务不允许此请求。 |
| 404 |
未找到 |
找不到指定资源。 |
| 405 |
不允许的方法 |
HTTP 方法不在受支持的内容类型中使用。 |
| 406 |
不可接受 |
不支持资源版本。 |
| 500 |
请求超时 |
服务无法理解格式错误的请求。 通常是无效参数。 |
| 503 |
请求超时 |
服务无法理解格式错误的请求。 通常是无效参数。 |
| 标头 |
类型 |
说明 |
| x-xbl-contract-version |
字符串 |
此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。 在验证标头的有效性、身份验证令牌中的声明等信息之后，请求将仅路由到该服务。 示例值：1，vnext。 |
| Content-Type |
字符串 |
请求正文的 mime 类型。 示例值：application/json。 |
| Cache-Control |
字符串 |
指定缓存行为的礼貌请求。 示例值：“no-cache”。 |
| X-XblCorrelationId |
字符串 |
用于将服务器返回的内容与客户端收到的内容相关联的服务生成的值。 示例值：“4106d0bc-1cb3-47bd-83fd-57d041c6febe”。 |
| X-Content-Type-Option |
字符串 |
返回 SDL 兼容的值。 示例值：“nosniff”。 |
| 日期 |
字符串 |
消息发送的日期/时间。 示例值：“Tue, 17 Nov 2012 10:33:31 GMT”。 |
| 标头 |
类型 |
说明 |
| 重试间隔 |
字符串 |
在 503 HTTP 错误中返回。 让客户端知道在重新尝试调用前等待的时长。 示例值：“120”。 |
| Content-Length |
字符串 |
响应正文的长度。 示例值：“527”。 |
| 内容编码 |
字符串 |
响应的编码类型。 示例值：“gzip”。 |
响应正文
此 API 检索 URI 中出现的与 XUID 相关的组名字对象指定的广播用户的状态记录。
示例响应
[
{
xuid:"0123456789",
state:"online",
devices:
[
{
type:"D",
titles:
[
{
id:"12341234",
name:"Halo 5",
lastModified:"2012-09-17T07:15:23.4930000",
placement:"full",
state:"active",
activity:
{
richPresence:"Playing on Valhalla",
broadcast:
{
"id":"broadcast id from broadcasting service",
"session":"3f2504e0-4f89-11d3-9a0c-0305e82c3301",
"provider":"Twitch",
"started":"2014-01-15T15:15:23.493Z",
"viewers":42
}
},
}
]
}
]
},
{
xuid:"0123456780",
state:"online",
devices:
[
{
type:"D",
titles:
[
{
id:"12341235",
name:"Halo Waypoint",
lastModified:"2012-09-17T07:15:23.4930000",
placement;"full",
state:"active",
activity:
{
richPresence:"Viewing stats"
},
}
]
}
]
},
{
xuid:"0123456781",
state:"online",
devices:
[
{
type:"Win8",
titles:
[
{
id:"23452345",
name:"Halo Gamehelp",
state:"active",
timestamp:"2012-09-17T07:15:23.4930000",
activity:
{
richPresence:"Viewing warthog help"
}
}
]
}
]
}
]
另请参阅
父级
/users/xuid({xuid})/groups/{moniker}