Téléverser des numéros depuis un fichier CSV
/v1/accounts/{accountId}/campaigns/{campaignId}/numbers/uploadAjoute à une campagne les numéros d’un fichier CSV (valeurs séparées par des virgules). C’est la méthode la plus efficace pour ajouter un grand nombre de numéros.
Chaque ligne du fichier contient un numéro dans la première colonne, suivi des valeurs de ses variables. Par exemple, un fichier avec 2 variables :
5550001,John,199
5550002,Mary,299
5550003,Susan,149
La première colonne peut contenir plusieurs numéros pour le même contact, séparés par des points-virgules. Les numéros invalides sont ignorés, et signalés dans la réponse. Une ligne avec un nombre de colonnes incorrect fait échouer toute la requête avec 400 Bad Request, en indiquant la ligne concernée.
Des numéros peuvent être ajoutés aux campagnes à l’état Draft, ainsi qu’aux campagnes Active ou Paused dont le provisionnement des numéros est Dynamic. Les autres campagnes renvoient 409 Conflict.
Les doublons sont gérés différemment selon l’état de la campagne. Dans les campagnes Draft, un numéro ayant les mêmes valeurs de variables qu’un numéro existant est ignoré (le même numéro peut être ajouté à nouveau avec des valeurs différentes). Dans les campagnes Active ou Paused, chaque numéro envoyé est ajouté, même s’il existe déjà, car il est considéré comme un nouvel appel à effectuer, par exemple pour recontacter le même client.
Paramètres de chemin
ID de votre compte SIP Caller. Consultez ID du compte.
ID de la campagne.
Paramètres de requête
Indique si la première ligne du fichier contient les noms des colonnes, et doit être ignorée.
Nombre de colonnes de variables après la colonne du numéro, entre 0 et 20.
Noms des colonnes de variables, dans l’ordre, par exemple ["Customer Name","Due Balance"]. Lorsqu’il est inclus, il doit contenir varCount noms.
Encodage des caractères du fichier. Par défaut : UTF8. D’autres valeurs courantes sont LATIN1 et windows-1252.
Corps de la requête
Un corps multipart/form-data avec le fichier, jusqu’à 100 Mo. Plusieurs fichiers peuvent être téléversés dans la même requête.
Renvoie
Renvoie un tableau avec un résultat pour chaque fichier téléversé :
Nom du fichier téléversé.
Nombre de lignes lues dans le fichier.
Nombre de numéros ajoutés.
Nombre de lignes ignorées, car le numéro était invalide ou en double.
Jusqu’à 10 des numéros invalides trouvés dans le fichier, pour vous aider à identifier le problème.
/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'Réponse
200 OK
[
{
"fileName": "campaign-numbers.csv",
"totalNumbers": 5000,
"numbersAdded": 4997,
"numbersSkipped": 3,
"firstInvalidNumbers": [
"55A0012",
"12"
]
}
]
