发送邀请
向 Xbox Live 用户发送邀请。
此 API 允许游戏客户端向 Xbox Live 用户发送针对具体游戏的邀请。 无论是哪个平台，邀请都会发送到所有已注册的终结点。
POST /titles/{titleId}/invites
URI 参数
| 参数 |
In |
必需 |
类型 |
说明 |
| titleId |
路径 |
TRUE |
integer |
要为其发送请求的游戏的 titleId。 |
| 名称 |
必需 |
类型 |
说明 |
| 授权 |
TRUE |
integer |
调用方必须提供采用 XBL 3.0 授权格式的 XToken。 例如，授权: XBL3.0 x=2553948354698;>加密令牌<) |
| Content-Type |
TRUE |
字符串 |
ContentType 必须设置为 application/json |
请求正文
| 名称 |
必需 |
类型 |
说明 |
| invitedUsers |
TRUE |
string[] |
要向其发送邀请的用户的 XUID。 XUID 表示为基 10 整数。 最大值为 16 个 XUID。 |
| connectionString |
|
字符串 |
连接字符串是在邀请到达用户时传递给游戏的内容。 连接字符串通常包含服务器 IP 等信息，以使联接用户能够进行连接。 如果连接字符串字段留空，则使用空连接字符串调用游戏。 连接字符串的长度限制为 512 个字符。 |
| platform |
|
平台 |
|
响应
| 名称 |
类型 |
说明 |
| 204 无内容 |
|
|
| 成功发出邀请。 |
|
|
| 400 错误请求 |
ErrorResponse |
处理请求时出错... 可能的错误代码："RequestValidationError： 请求验证失败。"，AuthorizationError： 不允许调用方访问资源。 请求过多。" |
| 其他状态代码 |
ThrottledEntity |
请求过多。 标头重试-之后：整数 |
定义
ErrorResponse
| 名称 |
类型 |
说明 |
| debugMessage |
字符串 |
可用于调试的错误消息的人工可读版本。 |
| errorCode |
字符串 |
错误代码枚举。 |
| 名称 |
类型 |
说明 |
| Android |
字符串 |
|
| IOS |
字符串 |
|
| Nintendo |
字符串 |
|
| PlayStation |
字符串 |
|
| Scarlett |
字符串 |
|
| Win32 |
字符串 |
|
| WindowsOneCore |
字符串 |
|
| XboxOne |
字符串 |
|
SendInviteRequest
如果未在请求中设置平台，则邀请将允许收件人加入游戏可以玩的任何平台。 否则，它将仅包括列出的平台。
注意：此情况的例外情况是，如果 Scarlett 未配置为平台，则指定 XboxOne 的邀请也将发送到 Scarlett 设备。
| 名称 |
类型 |
说明 |
| connectionString |
字符串 |
连接字符串是在邀请到达用户时传递给游戏的内容。 连接字符串通常包含服务器 IP 等信息，以使联接用户能够进行连接。 如果连接字符串字段留空，则使用空连接字符串调用游戏。 连接字符串的长度限制为 512 个字符。 |
| invitedUsers |
string[] |
要向其发送邀请的用户的 XUID。 XUID 表示为基 10 整数。 最大值为 16 个 XUID。 |
| platform |
平台 |
|
ThrottledEntity
| 名称 |
类型 |
说明 |
| currentRequests |
字符串 |
当前请求数 - 并发或速率。 |
| debugMessage |
字符串 |
可用于调试的限制消息的人工可读版本。 |
| LimitType |
字符串 |
限制类型，即并发或速率。 |
| maxRequests |
字符串 |
允许的最大请求数 - 并发或速率。 |
| periodInSeconds |
字符串 |
超出速率或并发限制时适用的时段（以秒为单位）。 |
| 版本 |
字符串 |
当前限制协定版本。 |