Ajouter des numéros
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersAjoute un ou plusieurs numéros à une campagne, avec leurs valeurs de variables.
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
Noms des variables dont les valeurs sont envoyées dans varValues, dans le même ordre, par exemple ["Customer Name","Due Balance"]. Chaque nom doit commencer par une lettre, et ne contenir que des lettres, des chiffres, des espaces et des traits de soulignement, jusqu’à 255 caractères.
Les premiers numéros ajoutés à la campagne définissent ses noms de variables : si varNames est omis à ce moment-là, elles sont nommées Var1, Var2, etc. Les requêtes suivantes doivent envoyer le même nombre de valeurs de variables, et si varNames est inclus, les noms doivent correspondre aux noms existants.
Corps de la requête
Un tableau JSON d’objets, un pour chaque numéro à ajouter. Un objet unique est également accepté.
Numéro de téléphone à appeler. Les séparateurs tels que les espaces, tirets, points et parenthèses sont autorisés et supprimés, par exemple +1 (555) 123-9000. Le numéro doit contenir entre 3 et 50 chiffres, et peut se terminer par p suivi de chiffres DTMF à composer après la réponse à l’appel, par exemple +15551239000p123. Jusqu’à 15 numéros peuvent être spécifiés pour le même contact, séparés par des points-virgules (;).
Valeurs des variables pour ce numéro, utilisées pour personnaliser les invites du flux d’appel ou la conversation de l’agent IA. Tous les numéros de la requête doivent avoir le même nombre de valeurs, correspondant aux variables de la campagne. Par défaut : un tableau vide.
Renvoie
Renvoie un tableau avec les objets numéro de campagne ajoutés. Les doublons ignorés ne sont pas inclus : le tableau est donc vide si tous les numéros étaient en double.
/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"
]
}
]'Réponse
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"
}
]
