# API de Message Inbox

## getInboxMessages

Devuelve la lista de mensajes del Inbox para un HWID especificado.

`POST` `https://api.pushwoosh.com/json/1.3/getInboxMessages`

#### Encabezados de solicitud

| Nombre | Requerido | Valor | Descripción |
|---|---|---|---|
| Authorization | Sí | Token `XXXX` | [Token de API de dispositivo](/es/developer/api-reference/api-access-token/#device-api-token) para acceder a la API de dispositivo. Reemplace `XXXX` con su token de API de dispositivo real. |

#### Cuerpo de la solicitud

| Nombre | Tipo | Descripción |
|---|---|---|
| application\* | string | [Código de aplicación de Pushwoosh](/es/developer/api-reference/api-identifiers/#application-code) |
| userId\* | string | Si no se establece un [User ID](/es/developer/api-reference/api-identifiers/#user-id) personalizado, use el HWID. |
| hwid | string | [ID de hardware de un dispositivo](/es/developer/api-reference/api-identifiers/#hardware-id) para obtener los mensajes del Inbox. |
| last\_code | string | Código del último mensaje recuperado en la respuesta anterior. Si está vacío, se devuelven los primeros mensajes. |
| count | integer | El número de mensajes que se mostrarán en una sola respuesta; utilizado para la paginación. 0 para cargar todos los mensajes en el Inbox. |

<Tabs>
<TabItem label="200">
```
{
  "response": {
    "messages": [{                      // array of messages currently stored in user's Inbox
      "inbox_id": "avde1c792cd",
      "rt": "146078676",                // date to remove the message from Inbox
      "send_date": "1459758676",        // date when the message was saved to Inbox
      "order": "59138176",              // position in Inbox presentation order
      "title": "New Rich Media in inbox!",
      "text": "Hi! New feature is available right now!",
      "action_type": "RichMedia",
      "action_params": {                // payload describing the actions on push opening
        "rm": "{\"url\":\"https:\/\/richmedia.pushwoosh.com\/C82F7-51FC1.zip\",\"ts\":\"1459758676\",\"tags\":{\"tagName\":\"tagValue\"}}"
      },
      "status": 1,                      // 1 - delivered, 2 - read, 3 - opened,
                                        // 4 - deleted(by a user), 5 - deleted from Control Panel
      "hash":"1C"                       // hash code of push notification
    }, {
      ...
    }],
    "next":"afarew511",                 // the next Inbox code to be returned by
                                        // the following /getInboxMessages request
    "deleted": ["bbaf85ab", "a41957b"], // the list of messages deleted from Control Panel
    "new_inbox": 6                      // the number of delivered Inbox messages for that user (can be used for badge)
  }
}
```
</TabItem>
</Tabs>

```json title="Ejemplo de solicitud"
{
  "request": {
    "application": "XXXXX-XXXXX", // required. Pushwoosh app code
     "userId": "user_name_1",     // required. User ID registered in Pushwoosh
     "device_type": 1             // optional. For device types refer to /registerDevice
  }
}
```

<Aside type="note">
Para iOS, asegúrese de haber agregado la Notification Service Extension a su proyecto para realizar el seguimiento de la entrega de notificaciones push. [Más información](/es/developer/pushwoosh-sdk/ios-sdk/ios-message-delivery-tracking/)
</Aside>

## inboxStatus

Actualiza el estado de un mensaje de Inbox particular.

`POST` `https://api.pushwoosh.com/json/1.3/inboxStatus`

#### Encabezados de solicitud

| Nombre | Requerido | Valor | Descripción |
|---|---|---|---|
| Authorization | Sí | Token `XXXX` | [Token de API de dispositivo](/es/developer/api-reference/api-access-token/#device-api-token) para acceder a la API de dispositivo. Reemplace `XXXX` con su token de API de dispositivo real. |

#### Cuerpo de la solicitud

| Nombre | Tipo | Descripción |
|---|---|---|
| application\* | string | [Código de aplicación de Pushwoosh](/es/developer/api-reference/api-identifiers/#application-code) |
| inbox\_code\* | string | Se puede obtener de los detalles del mensaje en el Panel de Control o del parámetro "order" de la solicitud `/getInboxMessages`. |
| hash | string | Código hash del mensaje de Inbox. |
| hwid | string | [ID de hardware del dispositivo](/es/developer/api-reference/api-identifiers/#hardware-id) para actualizar el estado del Inbox. |
| time | string | Marca de tiempo (timestamp) de la fecha de envío. |
| userID\* | string | Si no se establece un [User ID](/es/developer/api-reference/api-identifiers/#user-id) personalizado, use el HWID. |
| status\* | integer | 1 - entregado, 2 - leído, 3 - abierto, 4 - eliminado por un usuario. |
| device\_type | integer | [Ver valores posibles](/es/developer/api-reference/api-identifiers/#device-type). |

<Tabs>
<TabItem label="200">
```
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
```
</TabItem>
</Tabs>

```json title="Ejemplo"
{
  "request": {
    "application": "XXXXX-XXXXX",    // required. Pushwoosh application code
    "inbox_code": "874393934032909", // required. "order" parameter of /getInboxMessages request
    "hash": "1C",                    // optional.
    "userId": "some_user",           // required.
    "status": 2,                     // required. status to set: 1-delivered, 2-read, 3-opened, 4-deleted (by a user)
    "device_type": 3                 // optional.
  }
}
```