> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET (/users/{ownerId}/people)

> GET (/users/\{ownerId}/people)

# GET (/users/\{ownerId}/people)

取得呼叫端的連絡人集合。
這些 URI 的網域為 `social.xboxlive.com`。

* [備註](#ID4EV)
* [URI 參數](#ID4E5)
* [查詢字串參數](#ID4EJB)
* [授權](#ID4ERD)
* [必要的要求標頭](#ID4EZE)
* [選用的要求標頭](#ID4EYF)
* [要求本文](#ID4E5G)
* [HTTP 狀態碼](#ID4EJH)
* [必要的回應標頭](#ID4EBBAC)
* [回應本文](#ID4ENCAC)

## 備註

GET 作業不會修改任何資源，因此無論執行一次或多次，都會產生相同的結果。

## URI 參數

| 參數 | 類型 | 描述 |
| - | - | - |
| ownerId | string | 要存取其資源之使用者的識別碼。必須與已驗證的使用者相符。可能的值為 "me"、xuid(\{xuid}) 或 gt(\{gamertag})。 |

## 查詢字串參數

| 參數 | 類型 | 描述 |
| - | - | - |
| view | string | 傳回與檢視相關聯的人員。預設值為 "all"。可能的值為：**All** - 傳回使用者 People 清單上的所有人員。這是預設值。 **Favorite** - 傳回使用者 People 清單上具有 Favorite 屬性的所有人員。 **LegacyXboxLiveFriends** - 傳回使用者 People 清單上同時也是舊版 XBOX Live 好友的所有人員。 **注意：** 如果呼叫端使用者與擁有者使用者不同，則僅支援 **All** 值。 |
| startIndex | 32 位元不帶正負號的整數 | 傳回從指定索引開始的項目。 |
| maxItems | 32 位元不帶正負號的整數 | 從起始索引開始，要從集合中傳回的人員數目上限。如果未提供 **maxItems**，服務可能會提供預設值，並且可能傳回少於 **maxItems** 的人員 (即使尚未傳回最後一頁結果)。 |

## 授權

| 類型 | 必要 | 描述 | 遺漏時的回應 |
| - | - | - | - |
| XUID | 是 | 呼叫端擁有使用者的 XBOX 使用者識別碼 (XUID)。 | 401 Unauthorized |

## 必要的要求標頭

| 標頭 | 描述 |
| - | - |
| Authorization | 字串。XBOX LIVE 的授權資料。這通常是加密的 XSTS 權杖。範例值：**XBL3.0 x=\<userhash>;\<token>**。 |

## 選用的要求標頭

| 標頭 | 描述 |
| - | - |
| X-RequestedServiceVersion | 此要求應導向之 XBOX LIVE 服務的組建名稱/編號。只有在驗證標頭的有效性、驗證權杖中的宣告等之後，要求才會路由至該服務。預設值：1。 |
| Accept | 字串。呼叫端在回應中接受的 Content-Type。所有回應都是 **application/json**。 |

## 要求本文

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

## HTTP 狀態碼

服務會針對使用此方法對此資源發出的要求，傳回本節中的其中一個狀態碼。如需搭配 XBOX Live 服務使用的標準 HTTP 狀態碼完整清單，請參閱[標準 HTTP 狀態碼](https://docs.xbox.com/zh-TW/reference/live/rest/additional/httpstatuscodes.md)。

| 代碼 | 原因片語 | 描述 |
| - | - | - |
| 200 | OK | 成功。 |
| 400 | Bad Request | 查詢參數或使用者識別碼的格式不正確。 |
| 403 | Forbidden | 無法從授權標頭剖析 XUID 宣告。 |

## 必要的回應標頭

| 標頭 | 類型 | 描述 |
| - | - | - |
| Content-Length | 32 位元不帶正負號的整數 | 回應本文的長度 (以位元組為單位)。範例值：22。 |
| Content-Type | string | 回應本文的 MIME 類型。此值一律為 **application/json**。 |

## 回應本文

如果呼叫成功，服務會傳回呼叫端連絡人集合中的人員總數，以及包含呼叫端連絡人集合的陣列。請參閱 [PeopleList (JSON)](https://docs.xbox.com/zh-TW/reference/live/rest/json/json-peoplelist.md)。

### 回應範例

```json theme={null}
{
    "people": [
        {
            "xuid": "2603643534573573",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573572",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573577",
            "isFollowingCaller": false,
            "isFavorite": false
        },
    ],
    "totalCount": 3
}

```

## 另請參閱

##### 上層

[/users/\{ownerId}/people](https://docs.xbox.com/zh-TW/reference/live/rest/uri/people/uri-usersowneridpeople.md)


## Related topics

- [GET (/users/{ownerId}/people/avoid)](https://docs.xbox.com/zh-TW/reference/live/rest/uri/privacy/uri-privacyusersxuidpeopleavoidget.md)
- [GET (/users/{ownerId}/people/mute)](https://docs.xbox.com/zh-TW/reference/live/rest/uri/privacy/uri-privacyusersowneridpeoplemuteget.md)
- [GET (/users/{ownerId}/people/{targetid})](https://docs.xbox.com/zh-TW/reference/live/rest/uri/people/uri-usersowneridpeopletargetidget.md)
- [XblSocialGetSocialRelationshipsAsync](https://docs.xbox.com/zh-TW/reference/live/xsapi-c/social_c/functions/xblsocialgetsocialrelationshipsasync.md)
- [/users/{ownerId}/people](https://docs.xbox.com/zh-TW/reference/live/rest/uri/people/uri-usersowneridpeople.md)
