Dodawanie numerów
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersDodaje jeden lub więcej numerów do kampanii, wraz z wartościami ich zmiennych.
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
Nazwy zmiennych, których wartości są wysyłane w varValues, w tej samej kolejności, na przykład ["Customer Name","Due Balance"]. Każda nazwa musi zaczynać się od litery i zawierać wyłącznie litery, cyfry, spacje i podkreślenia, maksymalnie 255 znaków.
Pierwsze numery dodane do kampanii definiują nazwy jej zmiennych: jeśli w tym momencie varNames zostanie pominięte, otrzymują one nazwy Var1, Var2 i tak dalej. Kolejne żądania muszą wysyłać tę samą liczbę wartości zmiennych, a jeśli zawierają varNames, nazwy muszą być zgodne z istniejącymi.
Treść żądania
Tablica JSON z obiektami, po jednym dla każdego dodawanego numeru. Akceptowany jest również pojedynczy obiekt.
Numer telefonu do wybrania. Separatory, takie jak spacje, myślniki, kropki i nawiasy, są dozwolone i usuwane, na przykład +1 (555) 123-9000. Numer musi zawierać od 3 do 50 cyfr i może kończyć się znakiem p, po którym następują cyfry DTMF wybierane po odebraniu połączenia, na przykład +15551239000p123. Dla tego samego kontaktu można podać do 15 numerów, oddzielonych średnikami (;).
Wartości zmiennych dla tego numeru, używane do personalizacji monitów przepływu połączenia lub rozmowy z agentem AI. Wszystkie numery w żądaniu muszą mieć tę samą liczbę wartości, zgodną ze zmiennymi kampanii. Domyślnie pusta tablica.
Zwraca
Zwraca tablicę z dodanymi obiektami numeru kampanii. Pominięte duplikaty nie są uwzględniane, więc tablica jest pusta, jeśli wszystkie numery były duplikatami.
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers?varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
{
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
]
},
{
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
]
}
]'Odpowiedź
200 OK
[
{
"id": 1048201,
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
},
{
"id": 1048202,
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
}
]
