Przesyłanie numerów z pliku CSV
/v1/accounts/{accountId}/campaigns/{campaignId}/numbers/uploadDodaje do kampanii numery z pliku CSV (wartości oddzielone przecinkami). Jest to najbardziej wydajny sposób dodawania dużej liczby numerów.
Każdy wiersz pliku zawiera numer w pierwszej kolumnie, a po nim wartości jego zmiennych. Na przykład plik z 2 zmiennymi:
5550001,John,199
5550002,Mary,299
5550003,Susan,149
Pierwsza kolumna może zawierać kilka numerów tego samego kontaktu, oddzielonych średnikami. Nieprawidłowe numery są pomijane i zgłaszane w odpowiedzi. Wiersz z nieprawidłową liczbą kolumn powoduje, że całe żądanie kończy się błędem 400 Bad Request, ze wskazaniem wiersza, w którym wystąpił problem.
Numery można dodawać do kampanii w stanie Draft oraz do kampanii Active lub Paused z dostarczaniem numerów Dynamic. Dla pozostałych kampanii zwracany jest błąd 409 Conflict.
Duplikaty są obsługiwane różnie w zależności od stanu kampanii. W kampaniach Draft numer z takimi samymi wartościami zmiennych jak istniejący jest pomijany (ten sam numer można dodać ponownie z innymi wartościami). W kampaniach Active lub Paused dodawany jest każdy wysłany numer, nawet jeśli już istnieje, ponieważ jest traktowany jako nowe połączenie do wykonania, na przykład w celu ponownego kontaktu z tym samym klientem.
Parametry ścieżki
ID Twojego konta SIP Caller. Zobacz ID konta.
ID kampanii.
Parametry zapytania
Czy pierwszy wiersz pliku zawiera nazwy kolumn i należy go pominąć.
Liczba kolumn zmiennych po kolumnie numeru, od 0 do 20.
Nazwy kolumn zmiennych, w kolejności, na przykład ["Customer Name","Due Balance"]. Jeśli parametr zostanie podany, musi zawierać varCount nazw.
Kodowanie znaków pliku. Domyślnie UTF8. Inne popularne wartości to LATIN1 i windows-1252.
Treść żądania
Treść multipart/form-data z plikiem o rozmiarze do 100 MB. W tym samym żądaniu można przesłać kilka plików.
Zwraca
Zwraca tablicę z jednym wynikiem dla każdego przesłanego pliku:
Nazwa przesłanego pliku.
Liczba wierszy odczytanych z pliku.
Liczba dodanych numerów.
Liczba pominiętych wierszy, ponieważ numer był nieprawidłowy lub zduplikowany.
Do 10 nieprawidłowych numerów znalezionych w pliku, aby ułatwić znalezienie problemu.
/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'Odpowiedź
200 OK
[
{
"fileName": "campaign-numbers.csv",
"totalNumbers": 5000,
"numbersAdded": 4997,
"numbersSkipped": 3,
"firstInvalidNumbers": [
"55A0012",
"12"
]
}
]
