> For the complete documentation index, see [llms.txt](https://docs-es.sinch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-es.sinch.com/documentacion-tecnica/api-integraciones/listas-whatsapp-via-api.md).

# Listas WhatsApp a través de API

#### Solicitud <a href="#solicitud" id="solicitud"></a>

Usando GET, puede hacer una solicitud enviando todos los parámetros en la query string (cadena de consulta)

`GET http://api-messaging.wavy.global/v1/list/{listType}?customerId={customerId}&subAccountId={subAccountId}`

| Tipo de Lista                    | Valor pasado en {listType} |
| -------------------------------- | -------------------------- |
| **Whatsapp OPT-OUT List**        | OPTOUT                     |
| **Whatsapp OPT-IN List**         | OPTIN                      |
| **Whatsapp Blacklist**           | BLACKLIST                  |
| **Whatsapp Whitelist (para MT)** | WHITELIST                  |

El parámetro ***customerId*** es obligatorio, mientras que el ***subAccountId*** es opcional.

Atención: Tenga cuidado de reemplazar ‘{’ y ‘}’ también. Por ejemplo, “{listType}” se convierte en “OPTIN”.

Todavía es necesario pasar los siguientes headers:

| Header                  | Valor                           |
| ----------------------- | ------------------------------- |
| **Content-Type**        | application/json                |
| **authenticationToken** | Token de Messaging1             |
| **userName**            | Nombre de usuario de Messaging1 |

Puede obtener su nombre de usuario y su token a través de la plataforma Messaging1: `https://messaging.wavy.global`

#### Respuesta <a href="#respuesta" id="respuesta"></a>

En caso de éxito, si hay datos asociados al customerId y al subAccountId, la solicitud devuelve un JSON con 3 atributos:

| Atributo    | Valor                                                                                                                       |
| ----------- | --------------------------------------------------------------------------------------------------------------------------- |
| **success** | true                                                                                                                        |
| **status**  | 200                                                                                                                         |
| **data**    | Link para descargar un archivo de tipo csv que contiene los campos “source” y “createdAt” de todos los destinos encontrados |

La columna “createdAt” está en la zona horaria **America/Sao\_Paulo**, UTC-3 o UTC-2 en el horario de verano

En caso de que no haya datos relacionados con customerId y subAccountId, sólo se devuelve un JSON similar, pero sin el campo “data”, lo que significa que no hubo problemas con la solicitud, pero no había datos relativos a los parámetros pasados.

> Ejemplo de respuesta:

```
{
    "success": true,
    "status": 200,
    "data": "https://chatclub-cdn.wavy.global/2019/02/12/f2b8effb-d0bc-4327-86c2-48fedcb01b1b/list-42-4330544192402746957.csv"
}
```