Aggiungere numeri
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersAggiunge uno o più numeri a una campagna, con i valori delle loro variabili.
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
Nomi delle variabili i cui valori vengono inviati in varValues, nello stesso ordine, ad esempio ["Customer Name","Due Balance"]. Ogni nome deve iniziare con una lettera, e contenere solo lettere, cifre, spazi e trattini bassi, fino a 255 caratteri.
I primi numeri aggiunti alla campagna ne definiscono i nomi delle variabili: se in quel momento varNames viene omesso, le variabili vengono denominate Var1, Var2 e così via. Le richieste successive devono inviare lo stesso numero di valori delle variabili, e se varNames è incluso, i nomi devono corrispondere a quelli esistenti.
Corpo della richiesta
Un array JSON di oggetti, uno per ogni numero da aggiungere. È accettato anche un singolo oggetto.
Numero di telefono da chiamare. I separatori come spazi, trattini, punti e parentesi sono consentiti e vengono rimossi, ad esempio +1 (555) 123-9000. Il numero deve contenere tra 3 e 50 cifre, e può terminare con p seguito da cifre DTMF da comporre dopo la risposta alla chiamata, ad esempio +15551239000p123. È possibile specificare fino a 15 numeri per lo stesso contatto, separati da punto e virgola (;).
Valori delle variabili per questo numero, utilizzati per personalizzare i messaggi del flusso di chiamata o la conversazione dell'agente IA. Tutti i numeri della richiesta devono avere lo stesso numero di valori, corrispondente alle variabili della campagna. Il valore predefinito è un array vuoto.
Restituisce
Restituisce un array con gli oggetti numero della campagna aggiunti. I duplicati saltati non sono inclusi, quindi l'array è vuoto se tutti i numeri erano duplicati.
/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"
]
}
]'Risposta
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"
}
]
