POST (/users/xuid({xuid})/outbox)
受信者のリストに指定されたメッセージを送信します。
これらの URI のドメインは msg.xboxlive.com です。
解説
この API がサポートする唯一のコンテンツ タイプは "application/json" で、これは各呼び出しの HTTP ヘッダーに必須です。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| xuid | 符号なし 64 ビット整数 | 要求を行っているプレイヤーの Xbox ユーザー ID (XUID)。 |
Authorization
ユーザー メッセージを送信するには、独自のユーザー クレームと有効なゴールド メンバーシップが必要です。
プライバシー設定がリソースに与える影響
プレイヤーにユーザー メッセージを送信すると、そのプレイヤーがフレンドであるかどうかに関わらず、200 の結果コードとなります。 ただし、お客様をブロックしているユーザーにメッセージを送信すると、受信者はメッセージを受け取りません。また、メッセージの送信が失敗したことが示されることもありません。
また、1 日に送信できるメッセージの数、およびフレンドの数とフレンドでないユーザーの数にも、次のような制限があります。
- 1 つのメッセージで送信できる見知らぬユーザーは 20 人まで
- 24 時間ごとに送信できる見知らぬユーザーは 200 人まで
- 24 時間ごとに送信できるメッセージは合計で 250 まで
- 24 時間ごとに送信できる受信者は合計で 2500 人まで
| 要求元のユーザー | ターゲット ユーザーのプライバシー設定 | 動作 |
|---|---|---|
| 自分 | - | 説明のとおり。 |
| フレンド | すべての人 | 200 OK |
| フレンド | フレンドのみ | 200 OK |
| フレンド | 制限 | 200 OK |
| フレンドではないユーザー | すべての人 | 200 OK |
| フレンドではないユーザー | フレンドのみ | 200 OK |
| フレンドではないユーザー | 制限 | 200 OK |
| サードパーティーのサイト | すべての人 | 200 OK |
| サードパーティーのサイト | フレンドのみ | 200 OK |
| サードパーティーのサイト | 制限 | 200 OK |
リクエストの本文
| プロパティ | 種類 | 最大の長さ | 使用者 | 解説 |
|---|---|---|---|---|
| header | ヘッダー | すべて | ユーザー メッセージのヘッダー | |
| messageText | 文字列 | 250 | Windows 8 以外のすべてのプラットフォーム | ユーザー メッセージのテキスト (UTF-8) |
ヘッダー
| プロパティ | 種類 | 最大の長さ | 使用者 | 解説 |
|---|---|---|---|---|
| recipients | User[] | 20 | すべて | メッセージ受信者のリスト。 |
ユーザー
| プロパティ | 種類 | 最大の長さ | 使用者 | 解説 |
|---|---|---|---|---|
| xuid | ulong | すべて | 受信者の XUID。 ゲーマータグが送信される場合は使用されません。 | |
| gamertag | 文字列 | 15 | すべて | 受信者のゲーマータグ。 XUID が送信される場合は使用されません。 |
要求本文の例
{
"header":
{
"recipients":
[{"gamertag":"GoTeamEmily"},
{"gamertag":"Longstreet360"}]
},
"messageText":"random user text"
}
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 説明 |
|---|---|
| 200 | 成功です。 |
| 400 | 受信者の一覧が空であるか、最大長を超えています。または、ゲーマータグと XUID の両方が指定されました。または、messageText が長すぎます。 |
| 403 | XUID を変換できません。 |
| 404 | ゲーマータグが正しくないか、ユーザーが見つかりません。 |
| 409 | ユーザーは、システムによって適用されている 1 日の制限に達しました。 |
| 500 | 一般的なサーバー側のエラーです。 |
応答の本文
この応答の本体で送信されるオブジェクトはありません。