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

# 傳送邀請

> 傳送邀請

# 傳送邀請

傳送邀請給 XBOX Live 使用者。

此 API 可讓遊戲用戶端針對特定遊戲傳送邀請給 XBOX Live 使用者。無論平台為何，邀請都會傳送至所有已註冊的端點。

```http theme={null}
POST /titles/{titleId}/invites
```

<a id="uri-parameters" />

## URI 參數

| 參數 | 位置 | 必要 | 類型 | 描述 |
| - | - | - | - | - |
| titleId | path | TRUE | integer | 傳送要求所針對之遊戲的 titleId。 |

<a id="request-header" />

## 要求標頭

| 名稱 | 必要 | 類型 | 描述 |
| - | - | - | - |
| Authorization | TRUE | integer | 呼叫端必須以 XBL 3.0 授權格式提供 XToken。例如，Authorization: XBL3.0 x=2553948354698;>encrypted token\<) |
| Content-Type | TRUE | string | ContentType 必須設定為 application/json |

<a id="request-body" />

## 要求本文

| 名稱 | 必要 | 類型 | 描述 |
| - | - | - | - |
| invitedUsers | TRUE | string\[] | 接收邀請之使用者的 XUID。XUID 以 10 進位整數表示。最多 16 個 XUID。 |
| connectionString | | string | 連線字串是在邀請送達使用者時傳遞給遊戲的內容。連線字串通常包含伺服器 IP 等資訊，讓受邀使用者能夠加入。如果連線字串欄位保留空白，則會以空的連線字串叫用遊戲。連線字串的長度限制為 512 個字元。 |
| platform | | [Platform](#platform) | |

<a id="responses" />

## 回應

| 名稱 | 類型 | 描述 |
| - | - | - |
| 204 No Content | | |
| 已成功傳送邀請。 | | |
| 400 Bad Request | [ErrorResponse](#errorresponse) | 處理要求時發生錯誤。可能的錯誤碼："RequestValidationError: 要求驗證失敗。"、" AuthorizationError: 不允許呼叫端存取資源。要求過多。" |
| 其他狀態碼 | [ThrottledEntity](#throttledentity) | 要求過多。標頭 Retry-After: integer |

<a id="definitions" />

## 定義

* [ErrorResponse](#errorresponse)
* [Platform](#platform)
* [SendInviteRequest](#sendinviterequest)
* [ThrottledEntity](#throttledentity)

<a id="errorresponse" />

### ErrorResponse

| 名稱 | 類型 | 描述 |
| - | - | - |
| debugMessage | string | 可用於偵錯、人類可讀的錯誤訊息版本。 |
| errorCode | string | 錯誤碼列舉。 |

<a id="platform" />

### Platform

| 名稱 | 類型 | 描述 |
| - | - | - |
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string | |
| Scarlett | string | |
| Win32 | string | |
| WindowsOneCore | string | |
| XboxOne | string | |

<a id="sendinviterequest" />

### SendInviteRequest

如果要求中未設定平台，邀請將允許收件者在可遊玩該遊戲的任何平台上加入。否則，邀請只會包含列出的平台。

**注意：** 例外情況是，如果未將 Scarlett 設定為平台，則指定 XboxOne 的邀請也會傳送至 Scarlett 裝置。

| 名稱 | 類型 | 描述 |
| - | - | - |
| connectionString | string | 連線字串是在邀請送達使用者時傳遞給遊戲的內容。連線字串通常包含伺服器 IP 等資訊，讓受邀使用者能夠加入。如果連線字串欄位保留空白，則會以空的連線字串叫用遊戲。連線字串的長度限制為 512 個字元。 |
| invitedUsers | string\[] | 接收邀請之使用者的 XUID。XUID 以 10 進位整數表示。最多 16 個 XUID。 |
| platform | [Platform](#platform) | |

<a id="throttleentity" />

### ThrottledEntity

| 名稱 | 類型 | 描述 |
| - | - | - |
| currentRequests | string | 目前的要求數 - 並行或速率。 |
| debugMessage | string | 可用於偵錯、人類可讀的節流訊息版本。 |
| limitType | string | 限制類型，亦即並行或速率。 |
| maxRequests | string | 允許的最大要求數 - 並行或速率。 |
| periodInSeconds | string | 超過速率或並行限制時所套用的期間 (以秒為單位)。 |
| version | string | 目前的節流合約版本。 |


## Related topics

- [傳送邀請](/zh-TW/services/xbox-services/multiplayer/invites/how-to/live-invites-send.md)
- [傳送邀請給其他玩家 (流程圖)](/zh-TW/services/xbox-services/multiplayer/mpm/concepts/flowcharts/live-mpm-send-invites.md)
- [傳送邀請讓另一位玩家加入多人遊戲](/zh-TW/services/xbox-services/multiplayer/mpa/concepts/live-mpa-invites.md)
- [邀請概觀](/zh-TW/services/xbox-services/multiplayer/invites/live-multiplayer-invites-overview.md)
- [使用多人遊戲管理員傳送遊戲邀請](/zh-TW/services/xbox-services/multiplayer/mpm/how-to/live-send-game-invites.md)