POST (/users/{ownerId}/people/xuids)

项目
05/10/2023

按 XUID 获取调用方人员集合中的人员。这些 URI 的域是 social.xboxlive.com。

备注
URI 参数
授权
必需请求标头
可选请求标头
请求正文
HTTP 状态代码
必需响应标头
响应正文

备注

POST 操作不会修改任何资源，因此，如果执行一次或多次，这将产生相同结果。

URI 参数

参数	类型	说明
ownerId	字符串	正在访问其资源的用户的标识符。必须与经过身份验证的用户匹配。可能的值为“me”、xuid({xuid}) 或 gt({gamertag})。

授权

类型	必需	说明	缺少时的响应
XUID	是	调用方具有用户的 Xbox 用户 ID (XUID)。	401 未授权

必需请求标头

标头	说明
授权	字符串。 Xbox LIVE 的授权数据。这通常是加密的 XSTS 令牌。示例值：XBL3.0 x=<userhash>;<token>。
Content-Length	32 位无符号整数。请求正文的长度（以字节为单位）。示例值：22。
Content-Type	字符串。请求正文的 MIME 类型。必须为 application/json。

可选请求标头

标头	说明
X-RequestedServiceVersion	此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。在验证标头的有效性、身份验证令牌中的声明等信息之后，请求将仅路由到该服务。默认值：1。
Accept	字符串。调用方在响应中接受的 Content-Type。所有响应均为 application/json。

请求正文

必需成员

成员	说明
XuidList	标识要从调用方人员集合返回的人员的 XUID 的数组。请参阅 XuidList (JSON)。

可选成员

此请求没有可选成员。

禁止成员

在请求中禁止所有其他成员。

示例请求

{
    "xuids": [
        "2533274790395904", 
        "2533274792986770", 
        "2533274794866999"
    ]
}

HTTP 状态代码

服务返回此部分中的状态代码之一，以响应使用此方法对此资源发出的请求。对于用于 Xbox Live 服务的标准 HTTP 状态代码的完整列表，请参阅标准 HTTP 状态代码。

代码	原因短语	说明
200	OK	当方法是“get”时成功。
204	无内容	当方法为“add”或“remove”时成功。
400	无效的请求	方法参数缺失或格式错误，或用户 ID 格式错误。
403	已禁止	XUID 声明无法从授权标头分析。

必需响应标头

标头	类型	说明
Content-Length	32 位无符号整数	响应正文的长度（以字节为单位）。示例值：22。
Content-Type	字符串	响应正文的 MIME 类型。将始终是 application/json。

响应正文

响应正文仅在请求方法为“get”时发送。 “add”或“remove”没有响应正文。

如果“get”方法调用成功，服务将在调用方的人员集合中返回人员的总数，以及包含调用方人员集合的数组。不会为“add”和“remove”方法返回响应。请参阅 PeopleList (JSON)。

示例响应

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

另请参阅

父级

/users/{ownerId}/people/xuids

通过