> ## 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 um número especificado de resumos de mensagens de usuário do serviço. O domínio desses URIs é `msg.xboxlive.com`. * [Comentários](#ID4EV) * [Parâmetros de URI](#ID4EEB) * [Parâmetros da cadeia de consulta](#ID4EIC) * [Autorização](#ID4EGE) * [Efeito das configurações de privacidade no recurso](#ID4ETE) * [Códigos de status HTTP](#ID4E5E) * [Resposta JSON (JavaScript Object Notation)](#ID4EMH) ## Comentários Um resumo de mensagem de usuário contém apenas o assunto da mensagem. Para mensagens geradas pelo usuário, atualmente são os primeiros 20 caracteres do texto da mensagem. Mensagens do sistema podem fornecer um assunto alternativo, como "LIVE System". As mensagens são retornadas na ordem inversa em que foram enviadas; ou seja, as mensagens mais recentes são retornadas primeiro. O único tipo de conteúdo compatível com esta API é "application/json", que é obrigatório nos cabeçalhos HTTP de cada chamada. ## Parâmetros de URI | Parâmetro | Tipo | Descrição | | - | - | - | | xuid | inteiro de 64 bits sem sinal | A ID de usuário do XBOX (XUID) do jogador que está fazendo a solicitação. | ## Parâmetros da cadeia de consulta \| Propriedade| Tipo| Comprimento máximo| Comentários| \| --- | --- | --- | --- | --- | --- | --- | \| maxItems| int| 100| Número máximo de mensagens retornadas.| \| continuationToken| string| | Cadeia de caracteres retornada em uma chamada de enumeração anterior; usada para continuar a enumeração.| \| skipItems| int| 100| Número de mensagens a serem ignoradas; ignorado se continuationToken estiver presente.| ## Autorização Você deve ter sua própria declaração de usuário para recuperar um resumo de mensagem de usuário. ## Efeito das configurações de privacidade no recurso Somente você pode enumerar suas próprias mensagens de usuário. ## Códigos de status HTTP O serviço retorna um dos códigos de status nesta seção em resposta a uma solicitação feita com este método neste recurso. Para obter uma lista completa dos códigos de status HTTP padrão usados com os XBOX Live Services, consulte [Códigos de status HTTP padrão](/pt-BR/reference/live/rest/additional/httpstatuscodes). \| Código| Descrição| \| --- | --- | --- | --- | --- | --- | --- | --- | --- | \| 200| A solicitação foi bem-sucedida.| \| 400| O serviço não conseguiu entender a solicitação malformada. Normalmente, um parâmetro inválido.| \| 403| A solicitação não é permitida para o usuário ou serviço.| \| 404| Uma XUID válida está ausente no URI.| \| 409| A coleção subjacente foi alterada com base no token de continuação que foi passado.| \| 416| O número de itens a serem ignorados é maior que o número de itens disponíveis.| \| 500| Erro geral do lado do servidor.| ## Resposta JSON (JavaScript Object Notation) Se chamado com êxito, o serviço retorna os dados de resultados em formato JSON. | Propriedade | Tipo | Comprimento máximo | Comentários | | - | - | - | - | | results | Message\[] | 100 | Matriz de mensagens de usuário | | pagingInfo | PagingInfo | | Informações de paginação do conjunto atual de resultados | #### Message | Propriedade | Tipo | Comprimento máximo | Comentários | | - | - | - | - | | header | Header | | Cabeçalho da mensagem de usuário | | messageSummary | string | 20 | UTF-8; geralmente os primeiros 20 caracteres da mensagem | #### Header | Propriedade | Tipo | Comprimento máximo | Comentários | | - | - | - | - | | id | string | 50 | Identificador da mensagem, usado para recuperar detalhes da mensagem ou excluir mensagens. | | isRead | bool | | Sinalizador que indica que o usuário já leu os detalhes da mensagem. | | sent | DateTime | | Data e hora UTC em que a mensagem foi enviada. (Fornecido pelo serviço.) | | expiration | DateTime | | Data e hora UTC em que a mensagem expira. (Todas as mensagens têm um tempo de vida máximo, a ser determinado no futuro.) | | messageType | string | 50 | Tipos de mensagem: User, System, FriendRequest, Video, QuickChat, VideoChat, PartyChat, Title, GameInvite. | | senderXuid | ulong | | XUID do remetente. | | sender | string | 15 | Gamertag do remetente. | | hasAudio | bool | | Se a mensagem tem um anexo de áudio (voz). | | hasPhoto | bool | | Se a mensagem tem um anexo de foto. | | hasText | bool | | Se a mensagem contém texto. | #### Informações de paginação | Propriedade | Tipo | Comprimento máximo | Comentários | | - | - | - | - | | continuationToken | string | 100 | Retornado opcionalmente pelo servidor. Permite que chamadas posteriores continuem a enumeração. | | totalItems | int | | Número total de mensagens na caixa de entrada. | #### Exemplo de resposta ```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, } } ``` #### Resposta de erro Em caso de erro, o serviço pode retornar um objeto errorResponse, que pode conter valores do ambiente do serviço. \| Propriedade| Tipo| Descrição| \| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | \| errorSource| string| Uma indicação de onde o erro se originou.| \| errorCode| int| Código numérico associado ao erro (pode ser nulo).| \| errorMessage| string| Detalhes do erro, se configurado para mostrar detalhes.| ## Confira também ##### Pai [/users/xuid({xuid})/inbox](/pt-BR/reference/live/rest/uri/users/uri-usersxuidinbox) ##### Referência [Códigos de status HTTP padrão](/pt-BR/reference/live/rest/additional/httpstatuscodes) ## Related topics - [XblUserStatisticsGetSingleUserStatisticAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticasync.md) - [XblUserStatisticsGetSingleUserStatisticsAsync](/zh-TW/reference/live/xsapi-c/user_statistics_c/functions/xbluserstatisticsgetsingleuserstatisticsasync.md)