Export

Esporta in modo asincrono contatti o report di consegna come file scaricabili files.

📄️Elenca esportazioni

Restituisce un elenco paginato di tutti i job di esportazione del tuo account, ordinati per data di creazione. È il principale endpoint di polling nel flusso di esportazione asincrona. Dopo aver creato un job di esportazione tramite POST /exports/contacts o POST /exports/delivery-reports, il job viene messo in coda ed elaborato in background. Chiama questo endpoint periodicamente (intervallo consigliato: ogni 5-10 secondi) per monitorarne l'avanzamento. Ogni voce di esportazione include un campo status e un flag isAvailableForDownload. Quando isAvailableForDownload diventa true, chiama GET /exports/{exportId} per recuperare l'URL di download a validità limitata. Gli URL di download scadono dopo un certo periodo di tempo. Se l'URL è scaduto, il flag isAvailableForDownload potrebbe tornare a false; in tal caso usa POST /exports/{exportId} per rigenerare l'esportazione e ottenere un nuovo URL. La paginazione è controllata da page (a partire da 0) e limit (elementi per pagina, predefinito 10). Restituisce 500 se si verifica un errore interno durante il recupero dell'elenco delle esportazioni.

📄️Esporta contatti

Accoda un'esportazione CSV asincrona dei contatti del tuo account. Puoi delimitare l'esportazione in tre modi: (1) fornisci listIds per esportare tutti i contatti che appartengono a una o più liste contatti, (2) fornisci contactIds per esportare un insieme specifico di contatti tramite i loro ID, oppure (3) ometti entrambi per esportare tutti i contatti del tuo account. L'endpoint restituisce subito 202 Accepted, a indicare che il job di esportazione è stato messo in coda ma non è ancora completato. Per monitorare l'avanzamento, interroga GET /exports periodicamente (si consiglia ogni 5-10 secondi). Quando il job termina e isAvailableForDownload diventa true, chiama GET /exports/{exportId} per recuperare l'URL di download a validità limitata del file CSV. Se devi esportare di nuovo gli stessi dati dopo la scadenza dell'URL, usa POST /exports/{exportId} per rigenerare l'esportazione. Restituisce 400 se il corpo della richiesta non è valido (es. ID di liste o ID di contatti malformati). Restituisce 500 se si verifica un errore interno durante la messa in coda del job.

📄️Esporta report di consegna

Accoda un'esportazione CSV asincrona dei report di consegna (stati di invio e di consegna a livello di singolo messaggio). Puoi delimitare l'esportazione in due modi: (1) fornisci un campaignId per esportare i report di consegna di una campagna specifica, oppure (2) fornisci un intervallo di date con startDateTime e endDateTime per esportare tutti i report di consegna di quel periodo. L'endpoint restituisce subito 202 Accepted, a indicare che il job di esportazione è stato messo in coda ma non è ancora completato. Per monitorare l'avanzamento, interroga GET /exports periodicamente (si consiglia ogni 5-10 secondi). Quando il job termina e isAvailableForDownload diventa true, chiama GET /exports/{exportId} per recuperare l'URL di download a validità limitata del file CSV. Se devi esportare di nuovo gli stessi dati dopo la scadenza dell'URL, usa POST /exports/{exportId} per rigenerare l'esportazione. Restituisce 400 se il corpo della richiesta non è valido (es. mancano sia campaignId sia l'intervallo di date, oppure il formato della data non è valido). Restituisce 500 se si verifica un errore interno durante la messa in coda del job.

📄️Rigenera esportazione scaduta

Rimette in coda un job di esportazione scaduto, in modo che venga generato un nuovo file scaricabile con gli stessi filtri e parametri dell'esportazione originale. È utile quando l'URL di download restituito da GET /exports/{exportId} è scaduto e hai ancora bisogno dei dati. L'endpoint restituisce subito 202 Accepted. La rigenerazione viene elaborata in modo asincrono, proprio come l'esportazione originale. Interroga GET /exports per monitorare il nuovo job e, quando isAvailableForDownload diventa true, chiama GET /exports/{exportId} per recuperare il nuovo URL di download. Restituisce 400 se l'esportazione è ancora disponibile e non è ancora scaduta (non c'è bisogno di rigenerarla; scaricala e basta). Restituisce 404 se l'exportId non esiste o non appartiene al tuo account. Restituisce 500 in caso di errore interno.

📄️Ottieni URL di download dell'esportazione

Restituisce un URL di download pre-firmato per un file di esportazione completato. Dovresti chiamare questo endpoint solo dopo aver verificato che l'elaborazione dell'esportazione sia terminata, controllando che isAvailableForDownload sia true nella risposta dell'elenco GET /exports. L'URL restituito ha validità limitata e scadrà dopo un certo periodo. Una volta scaduto, qualsiasi tentativo di scaricare il file con quell'URL non andrà a buon fine. Se ti serve un nuovo link dopo la scadenza, chiama POST /exports/{exportId} per rigenerare l'esportazione, poi interroga di nuovo GET /exports finché la nuova esportazione non è pronta e recupera il nuovo URL di download da questo endpoint. Restituisce 400 se l'esportazione è scaduta e non è più disponibile per il download diretto (usa POST /exports/{exportId} per rigenerarla). Restituisce 404 se l'exportId non esiste o non appartiene al tuo account. Restituisce 500 in caso di errore interno.