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

# GET (/users/xuid({xuid})/inbox)

> GET (/users/xuid({xuid})/inbox)

# GET (/users/xuid({xuid})/inbox)

Recupera un número especificado de resúmenes de mensajes de usuario del servicio.
El dominio de estos URI es `msg.xboxlive.com`.

* [Comentarios](#ID4EV)
* [Parámetros de URI](#ID4EEB)
* [Parámetros de cadena de consulta](#ID4EIC)
* [Autorización](#ID4EGE)
* [Efecto de la configuración de privacidad en el recurso](#ID4ETE)
* [Códigos de estado HTTP](#ID4E5E)
* [Respuesta de notación de objetos JavaScript (JSON)](#ID4EMH)

## Comentarios

Un resumen de mensaje de usuario contiene solo el asunto del mensaje. Para los mensajes generados por el usuario, actualmente son los primeros 20 caracteres del texto del mensaje. Los mensajes del sistema pueden proporcionar un asunto alternativo, como "LIVE System".

Los mensajes se devuelven en el orden inverso al que se enviaron; es decir, los mensajes más recientes se devuelven primero.

El único tipo de contenido que admite esta API es "application/json", que es obligatorio en los encabezados HTTP de cada llamada.

## Parámetros de URI

| Parámetro | Tipo | Descripción |
| - | - | - |
| xuid | entero de 64 bits sin signo | Identificador de usuario de XBOX (XUID) del jugador que realiza la solicitud. |

## Parámetros de cadena de consulta

\| Propiedad| Tipo| Longitud máxima| Comentarios|
\| --- | --- | --- | --- | --- | --- | --- |
\| maxItems| int| 100| Número máximo de mensajes devueltos.|
\| continuationToken| string|  | Cadena devuelta en una llamada de enumeración anterior; se usa para continuar la enumeración.|
\| skipItems| int| 100| Número de mensajes que se omiten; se ignora si continuationToken está presente.|

## Autorización

Debe tener su propia notificación de usuario para recuperar un resumen de mensaje de usuario.

## Efecto de la configuración de privacidad en el recurso

Solo usted puede enumerar sus propios mensajes de usuario.

## Códigos de estado HTTP

El servicio devuelve uno de los códigos de estado de esta sección en respuesta a una solicitud realizada con este método en este recurso. Para obtener una lista completa de los códigos de estado HTTP estándar que se usan con los servicios de XBOX Live, consulte [Códigos de estado HTTP estándar](https://devdocs.xbox.com/es/reference/live/rest/additional/httpstatuscodes).

\| Código| Descripción|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| 200| La solicitud se realizó correctamente.|
\| 400| El servicio no pudo interpretar una solicitud con formato incorrecto. Normalmente, un parámetro no válido.|
\| 403| La solicitud no está permitida para el usuario o el servicio.|
\| 404| Falta un XUID válido en el URI.|
\| 409| La colección subyacente cambió con respecto al token de continuación que se pasó.|
\| 416| El número de elementos que se van a omitir es mayor que el número de elementos disponibles.|
\| 500| Error general del lado servidor.|

## Respuesta de notación de objetos JavaScript (JSON)

Si se llama correctamente, el servicio devuelve los datos de resultados en formato JSON.

| Propiedad | Tipo | Longitud máxima | Comentarios |
| - | - | - | - |
| results | Message\[] | 100 | Matriz de mensajes de usuario |
| pagingInfo | PagingInfo | | Información de paginación del conjunto de resultados actual |

#### Message

| Propiedad | Tipo | Longitud máxima | Comentarios |
| - | - | - | - |
| header | Header | | Encabezado del mensaje de usuario |
| messageSummary | string | 20 | UTF-8; normalmente, los primeros 20 caracteres del mensaje |

#### Header

| Propiedad | Tipo | Longitud máxima | Comentarios |
| - | - | - | - |
| id | string | 50 | Identificador del mensaje, que se usa para recuperar los detalles del mensaje o eliminar mensajes. |
| isRead | bool | | Marca que indica que el usuario ya ha leído los detalles del mensaje. |
| sent | DateTime | | Fecha y hora UTC en que se envió el mensaje. (Proporcionadas por el servicio.) |
| expiration | DateTime | | Fecha y hora UTC en que expira el mensaje. (Todos los mensajes tienen una duración máxima, que se determinará en el futuro.) |
| messageType | string | 50 | Tipos de mensaje: User, System, FriendRequest, Video, QuickChat, VideoChat, PartyChat, Title, GameInvite. |
| senderXuid | ulong | | XUID del remitente. |
| sender | string | 15 | Gamertag del remitente. |
| hasAudio | bool | | Indica si el mensaje tiene datos adjuntos de audio (voz). |
| hasPhoto | bool | | Indica si el mensaje tiene una foto adjunta. |
| hasText | bool | | Indica si el mensaje contiene texto. |

#### Paging Info

| Propiedad | Tipo | Longitud máxima | Comentarios |
| - | - | - | - |
| continuationToken | string | 100 | Devuelto opcionalmente por el servidor. Permite que llamadas posteriores continúen la enumeración. |
| totalItems | int | | Número total de mensajes de la bandeja de entrada. |

#### Respuesta de ejemplo

```cpp theme={null}
{
          "results":
          [
            {
              "header":
              {
                "expiration":"2011-10-11T23:59:59.9999999",
                "id":"opaqueBlobOfText",
                "messageType":"User",
                "isRead":false,
                "senderXuid":"123456789",
                "sender":"Striker",
                "sent":"2011-05-08T17:30:00Z",
                "hasAudio":false,
                "hasPhoto":false,
                "hasText":true
              },
            "messageSummary":"first 20 chars"
          },
          ...
        ],
        "pagingInfo":
          {
          "continuationToken":"opaqueBlobOfText"
          "totalItems":5,
          }
        }

```

#### Respuesta de error

En caso de error, el servicio puede devolver un objeto errorResponse, que puede contener valores del entorno del servicio.

\| Propiedad| Tipo| Descripción|
\| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
\| errorSource| string| Indicación del lugar donde se originó el error.|
\| errorCode| int| Código numérico asociado al error (puede ser null).|
\| errorMessage| string| Detalles del error si está configurado para mostrar detalles.|

## Consulte también

##### Elemento primario

[/users/xuid({xuid})/inbox](https://devdocs.xbox.com/es/reference/live/rest/uri/users/uri-usersxuidinbox)

##### Referencia  [Códigos de estado HTTP estándar](https://devdocs.xbox.com/es/reference/live/rest/additional/httpstatuscodes)


## Related topics

- [XblUserStatisticsGetSingleUserStatisticAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md)
- [XblUserStatisticsGetSingleUserStatisticsAsync](https://devdocs.xbox.com/ja-jp/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)
