> ## 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)

<a id="ID4EV" />

## 備註

擷取由 Moniker 所指定、與宣告中使用者相關之群組中的使用者，並傳回這些使用者的 PresenceRecord。受隱私權或內容隔離限制的資料將不會傳回。

<a id="ID4E5" />

## URI 參數

| 參數 | 類型 | 描述 |
| - | - | - |
| moniker | string | 定義使用者群組的字串。目前唯一接受的 Moniker 是開頭為大寫 'P' 的 "People"。 |

<a id="ID4EJB" />

## 查詢字串參數

\| 參數| 類型| 描述|
\| --- | --- | --- | --- | --- | --- |
\| level| string| 傳回此查詢字串所指定的詳細程度。有效選項包括 "user"、"device"、"title" 和 "all"。層級 "user" 是不含 DeviceRecord 巢狀物件的 PresenceRecord 物件。層級 "device" 是不含 TitleRecord 巢狀物件的 PresenceRecord 和 DeviceRecord 物件。層級 "title" 是不含 ActivityRecord 巢狀物件的 PresenceRecord、DeviceRecord 和 TitleRecord 物件。層級 "all" 是整個記錄，包括所有巢狀物件。如果未提供此參數，服務預設為 title 層級 (亦即傳回此使用者直到遊戲詳細資料的目前狀態)。|

<a id="ID4EKC" />

## 授權

使用的授權宣告 | 宣告| 類型| 必要?| 範例值|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| <b>Xuid</b>| 64 位元帶正負號的整數| 是| 1234567890|

<a id="ID4EQD" />

## 隱私權設定對資源的影響

如果要求本身格式正確，服務一律會傳回 200 OK。不過，若未通過隱私權檢查，服務會從回應中篩選掉資訊。

隱私權設定對資源的影響 | 提出要求的使用者| 目標使用者的隱私權設定| 行為|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 我| -| 如所述。|
\| 朋友| 所有人| 如所述。|
\| 朋友| 僅限朋友| 如所述。|
\| 朋友| 已封鎖| 如所述 - 服務會篩選掉資料。|
\| 非朋友使用者| 所有人| 如所述。|
\| 非朋友使用者| 僅限朋友| 如所述 - 服務會篩選掉資料。|
\| 非朋友使用者| 已封鎖| 如所述 - 服務會篩選掉資料。|
\| 協力廠商網站| 所有人| 如所述 - 服務會篩選掉資料。|
\| 協力廠商網站| 僅限朋友| 如所述 - 服務會篩選掉資料。|
\| 協力廠商網站| 已封鎖| 如所述 - 服務會篩選掉資料。|

<a id="ID4EEH" />

## 必要的要求標頭

\| 標頭| 類型| 描述|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| Authorization| string| HTTP 驗證的驗證認證。範例值："XBL3.0 x=\<userhash>;\<token>"。|
\| x-xbl-contract-version| string| 此要求應導向之 XBOX LIVE 服務的組建名稱/編號。只有在驗證標頭的有效性、驗證權杖中的宣告等之後，要求才會路由至該服務。範例值：3、vnext。|
\| Accept| string| 可接受的 Content-Type。Presence 唯一支援的是 <b>application/json</b>，但仍必須在標頭中指定。|
\| Accept-Language| string| 回應中字串可接受的地區設定。範例值：en-US。|
\| Host| string| 伺服器的網域名稱。範例值：userpresence.xboxlive.com。|

<a id="ID4EMBAC" />

## 選用的要求標頭

\| 標頭| 類型| 描述|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| X-RequestedServiceVersion|  | 此要求應導向之 XBOX LIVE 服務的組建名稱/編號。只有在驗證標頭的有效性、驗證權杖中的宣告等之後，要求才會路由至該服務。預設值：1。|

<a id="ID4EMCAC" />

## 要求本文

此要求的本文中不會傳送任何物件。

<a id="ID4EXCAC" />

## HTTP 狀態碼

服務會針對使用此方法對此資源發出的要求，傳回本節中的其中一個狀態碼。如需搭配 XBOX Live 服務使用的標準 HTTP 狀態碼完整清單，請參閱[標準 HTTP 狀態碼](/zh-TW/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| 服務無法理解格式不正確的要求。通常是無效的參數。|

<a id="ID4E3GAC" />

## 必要的回應標頭

\| 標頭| 類型| 描述|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| x-xbl-contract-version| string| 此要求應導向之 XBOX LIVE 服務的組建名稱/編號。只有在驗證標頭的有效性、驗證權杖中的宣告等之後，要求才會路由至該服務。範例值：1、vnext。|
\| Content-Type| string| 要求本文的 MIME 類型。範例值：<b>application/json</b>。|
\| 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"。|

<a id="ID4EMJAC" />

## 選用的回應標頭

\| 標頭| 類型| 描述|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| Retry-After| string| 在 503 HTTP 錯誤時傳回。讓用戶端知道在重試呼叫之前要等待多久。範例值："120"。|
\| Content-Length| string| 回應本文的長度。範例值："527"。|
\| Content-Encoding| string| 回應的編碼類型。範例值："gzip"。|

<a id="ID4E5KAC" />

## 回應本文

此 API 會傳回 PresenceRecord 物件的陣列，要求中的每個 XUID 各對應一個物件。

<a id="ID4EGLAC" />

### 回應範例

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

<a id="ID4EQLAC" />

## 另請參閱

<a id="ID4ESLAC" />

##### 上層

[/users/me/groups/{moniker}](/zh-TW/reference/live/rest/uri/presence/uri-usersmegroupsmoniker)


## Related topics

- [XUserGetAgeGroup](/reference/system/xuser/functions/xusergetagegroup.md)
- [XblSocialManagerUserGroupGetUsersTrackedByGroup](/es/reference/live/xsapi-c/social_manager_c/functions/xblsocialmanagerusergroupgetuserstrackedbygroup.md)