Przesyłanie numerów listy kontaktów z pliku CSV
/v1/accounts/{accountId}/contactLists/{contactListId}/numbers/uploadDodaje do listy kontaktów numery z pliku CSV (wartości oddzielone przecinkami), wraz z wartościami ich zmiennych. 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. Numer z takimi samymi wartościami zmiennych jak istniejący również jest pomijany. 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.
Pierwsze numery dodane do listy kontaktów definiują jej zmienne. Kolejne przesyłane pliki muszą mieć tę samą liczbę kolumn zmiennych, a jeśli podano varNames, nazwy muszą być zgodne z istniejącymi.
Parametry ścieżki
ID Twojego konta SIP Caller. Zobacz ID konta.
ID listy kontaktów.
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. 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/contactLists/CONTACT_LIST_ID/numbers/upload
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/contactLists/CONTACT_LIST_ID/numbers/upload?firstRowIsHeader=true&varCount=2&varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-F 'file=@contact-list-numbers.csv;type=text/csv'Odpowiedź
200 OK
[
{
"fileName": "contact-list-numbers.csv",
"totalNumbers": 1255,
"numbersAdded": 1254,
"numbersSkipped": 1,
"firstInvalidNumbers": [
"55A0012"
]
}
]
