Caricare numeri da un file CSV
/v1/accounts/{accountId}/campaigns/{campaignId}/numbers/uploadAggiunge a una campagna i numeri di un file CSV (valori separati da virgola). È il modo più efficiente per aggiungere una grande quantità di numeri.
Ogni riga del file contiene un numero nella prima colonna, seguito dai valori delle sue variabili. Ad esempio, un file con 2 variabili:
5550001,John,199
5550002,Mary,299
5550003,Susan,149
La prima colonna può contenere più numeri per lo stesso contatto, separati da punto e virgola. I numeri non validi vengono saltati, e riportati nella risposta. Una riga con un numero errato di colonne fa fallire l'intera richiesta con 400 Bad Request, indicando la riga con il problema.
I numeri possono essere aggiunti alle campagne nello stato Draft, e alle campagne Active o Paused con provisioning dei numeri Dynamic. Le altre campagne restituiscono 409 Conflict.
I duplicati vengono gestiti in modo diverso a seconda dello stato della campagna. Nelle campagne Draft, un numero con gli stessi valori delle variabili di uno esistente viene saltato (lo stesso numero può essere aggiunto di nuovo con valori diversi). Nelle campagne Active o Paused, ogni numero inviato viene aggiunto, anche se esiste già, poiché viene considerato una nuova chiamata da effettuare, ad esempio per ricontattare lo stesso cliente.
Parametri di percorso
ID del tuo account SIP Caller. Consulta ID dell'account.
ID della campagna.
Parametri di query
Indica se la prima riga del file contiene i nomi delle colonne, e deve essere saltata.
Numero di colonne di variabili dopo la colonna del numero, tra 0 e 20.
Nomi delle colonne di variabili, in ordine, ad esempio ["Customer Name","Due Balance"]. Se incluso, deve contenere varCount nomi.
Codifica dei caratteri del file. Il valore predefinito è UTF8. Altri valori comuni sono LATIN1 e windows-1252.
Corpo della richiesta
Un corpo multipart/form-data con il file, fino a 100 MB. È possibile caricare più file nella stessa richiesta.
Restituisce
Restituisce un array con un risultato per ogni file caricato:
Nome del file caricato.
Numero di righe lette dal file.
Quantità di numeri aggiunti.
Numero di righe saltate, perché il numero non era valido o era duplicato.
Fino a 10 dei numeri non validi trovati nel file, per aiutarti a individuare il problema.
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers/upload
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers/upload?firstRowIsHeader=false&varCount=2&varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-F 'file=@campaign-numbers.csv;type=text/csv'Risposta
200 OK
[
{
"fileName": "campaign-numbers.csv",
"totalNumbers": 5000,
"numbersAdded": 4997,
"numbersSkipped": 3,
"firstInvalidNumbers": [
"55A0012",
"12"
]
}
]
