> ## 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 (/users/me/groups/{moniker} )

> GET (/users/me/groups/{moniker} )

# GET (/users/me/groups/{moniker} )

获取我所在组的 PresenceRecord。
这些 URI 的域为 `userpresence.xboxlive.com`。

* [备注](#ID4EV)
* [URI 参数](#ID4E5)
* [查询字符串参数](#ID4EJB)
* [授权](#ID4EKC)
* [隐私设置对资源的影响](#ID4EQD)
* [必需的请求标头](#ID4EEH)
* [可选的请求标头](#ID4EMBAC)
* [请求正文](#ID4EMCAC)
* [HTTP 状态代码](#ID4EXCAC)
* [必需的响应标头](#ID4E3GAC)
* [可选的响应标头](#ID4EMJAC)
* [响应正文](#ID4E5KAC)

## 备注

检索由声明中与用户相关的代号所指定的组内的用户,并返回这些用户的 PresenceRecord。受隐私或内容隔离限制的数据将不会返回。

## URI 参数

| 参数 | 类型 | 说明 |
| - | - | - |
| moniker | string | 用于定义用户组的字符串。目前唯一接受的代号是首字母大写 'P' 的 "People"。 |

## 查询字符串参数

\| 参数 | 类型 | 说明 |
\| --- | --- | --- | --- | --- | --- |
\| level | string | 返回由此查询字符串指定的详细级别。有效选项包括 "user"、"device"、"title" 和 "all"。级别 "user" 是不含嵌套 DeviceRecord 对象的 PresenceRecord 对象。级别 "device" 是不含嵌套 TitleRecord 对象的 PresenceRecord 和 DeviceRecord 对象。级别 "title" 是不含嵌套 ActivityRecord 对象的 PresenceRecord、DeviceRecord 和 TitleRecord 对象。级别 "all" 是包含所有嵌套对象的完整记录。如果未提供此参数,服务默认为 title 级别(即返回此用户到标题详细信息级别的在线状态)。 |

## 授权

使用的授权声明 | 声明 | 类型 | 是否必需? | 示例值 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| **Xuid** | 64 位有符号整数 | 是 | 1234567890 |

## 隐私设置对资源的影响

如果请求本身格式正确,服务将始终返回 200 OK。但是,当隐私检查未通过时,服务将从响应中筛选出信息。

隐私设置对资源的影响 | 请求用户 | 目标用户的隐私设置 | 行为 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| me | - | 如上所述。 |
\| friend | everyone | 如上所述。 |
\| friend | friends only | 如上所述。 |
\| friend | blocked | 如上所述——服务将筛选掉数据。 |
\| non-friend user | everyone | 如上所述。 |
\| non-friend user | friends only | 如上所述——服务将筛选掉数据。 |
\| non-friend user | blocked | 如上所述——服务将筛选掉数据。 |
\| third-party site | everyone | 如上所述——服务将筛选掉数据。 |
\| third-party site | friends only | 如上所述——服务将筛选掉数据。 |
\| third-party site | blocked | 如上所述——服务将筛选掉数据。 |

## 必需的请求标头

\| 标头 | 类型 | 说明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| Authorization | string | HTTP 身份验证的身份验证凭据。示例值:"XBL3.0 x=\<userhash>;\<token>"。 |
\| x-xbl-contract-version | string | 此请求应指向的 XBOX LIVE 服务的生成名称/编号。仅在验证标头的有效性、身份验证令牌中的声明等的有效性之后,请求才会路由到该服务。示例值:3、vnext。 |
\| Accept | string | 可接受的 Content-Type。在线状态服务唯一支持的是 **application/json**,但仍必须在标头中指定。 |
\| Accept-Language | string | 响应中字符串的可接受区域设置。示例值:en-US。 |
\| Host | string | 服务器的域名。示例值:userpresence.xboxlive.com。 |

## 可选的请求标头

\| 标头 | 类型 | 说明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| X-RequestedServiceVersion |  | 此请求应指向的 XBOX LIVE 服务的生成名称/编号。仅在验证标头的有效性、身份验证令牌中的声明等的有效性之后,请求才会路由到该服务。默认值:1。 |

## 请求正文

此请求正文中未发送任何对象。

## HTTP 状态代码

服务针对使用此方法对此资源发出的请求,返回本节中的一个状态代码。有关 XBOX Live 服务使用的标准 HTTP 状态代码的完整列表,请参阅[标准 HTTP 状态代码](https://devdocs.xbox.com/zh-CN/reference/live/rest/additional/httpstatuscodes)。

\| 代码 | 原因短语 | 说明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200 | OK | 已成功检索会话。 |
\| 400 | Bad Request | 服务无法理解格式错误的请求。通常是参数无效。 |
\| 401 | Unauthorized | 请求需要用户身份验证。 |
\| 403 | Forbidden | 该用户或服务不允许该请求。 |
\| 404 | Not Found | 找不到指定的资源。 |
\| 405 | Method Not Allowed | 对不支持的内容类型使用了 HTTP 方法。 |
\| 406 | Not Acceptable | 不支持资源版本。 |
\| 500 | Request Timeout | 服务无法理解格式错误的请求。通常是参数无效。 |
\| 503 | Request Timeout | 服务无法理解格式错误的请求。通常是参数无效。 |

## 必需的响应标头

\| 标头 | 类型 | 说明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| x-xbl-contract-version | string | 此请求应指向的 XBOX LIVE 服务的生成名称/编号。仅在验证标头的有效性、身份验证令牌中的声明等的有效性之后,请求才会路由到该服务。示例值:1、vnext。 |
\| Content-Type | string | 请求正文的 MIME 类型。示例值:**application/json**。 |
\| Cache-Control | string | 用于指定缓存行为的礼貌请求。示例值:"no-cache"。 |
\| X-XblCorrelationId | string | 服务生成的值,用于关联服务器返回内容与客户端接收内容。示例值:"4106d0bc-1cb3-47bd-83fd-57d041c6febe"。 |
\| X-Content-Type-Option | string | 返回符合 SDL 的值。示例值:"nosniff"。 |
\| Date | string | 消息发送的日期/时间。示例值:"Tue, 17 Nov 2012 10:33:31 GMT"。 |

## 可选的响应标头

\| 标头 | 类型 | 说明 |
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| Retry-After | string | 在 503 HTTP 错误时返回。让客户端知道在重试调用之前应等待多长时间。示例值:"120"。 |
\| Content-Length | string | 响应正文的长度。示例值:"527"。 |
\| Content-Encoding | string | 响应的编码类型。示例值:"gzip"。 |

## 响应正文

此 API 返回一个 PresenceRecord 对象数组,数组中的每个对象对应请求中的一个 XUID。

### 示例响应

```cpp theme={null}
[
     {
         xuid:"0123456789",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341234",
                         name:"Contoso 5",
                         lastModified:"2012-09-17T07:15:23.4930000",
                         placement:"full",
                         state:"active",
                         activity:
                         {
                             richPresence:"Playing on Nirvana"
                         },
                     }
                 ]
             }
         ]
     },
     {
         xuid:"0123456780",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341235",
                         name:"Contoso 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:"Contoso Gamehelp",
                         state:"active",
                         timestamp:"2012-09-17T07:15:23.4930000",
                         activity:
                         {
                             richPresence:"Viewing help"
                         }
                     }
                 ]
             }
         ]
     }
 ]
         
```

## 另请参阅

##### 父主题

[/users/me/groups/{moniker}](https://devdocs.xbox.com/zh-CN/reference/live/rest/uri/presence/uri-usersmegroupsmoniker)


## Related topics

- [XUserGetAgeGroup](https://devdocs.xbox.com/reference/system/xuser/functions/xusergetagegroup.md)
- [XblSocialManagerUserGroupGetUsersTrackedByGroup](https://devdocs.xbox.com/zh-TW/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetuserstrackedbygroup.md)
