L’objet campagne
Représente une campagne, avec tous ses paramètres et sa progression actuelle. Les attributs marqués en lecture seule sont définis par SIP Caller, et sont ignorés lors de la création ou de la modification d’une campagne.
Attributs
Identifiant unique de la campagne.
Nom de la campagne, entre 2 et 99 caractères. Il doit être unique dans le compte.
ID des balises de la campagne. Seuls les utilisateurs ayant au moins une de ces balises peuvent voir la campagne dans la Console Web. Envoyez un tableau vide pour n’assigner aucune balise.
État de la campagne. Les nouvelles campagnes sont créées à l’état Draft. Utilisez Changer l’état d’une campagne pour activer, mettre en pause ou annuler une campagne. Les campagnes passent automatiquement à l’état Finished.
DraftActivePausedCanceledFinishedUniquement pour les campagnes Active, et null sinon : indique si la campagne effectue des appels (Running), ou la raison pour laquelle elle n’en effectue pas.
RunningWaitingForNumbersOutsideDateRangeOutsideWorkingHoursQueuesMonitorOfflineExtensionNotRegisteredNoServerAvailableInRegionPhoneSystemBlacklistedMaxCallsPerDayLimitReachedNumberProvisioningNotAllowedByPlanDialerModeNotAllowedByPlanCallHandlingModeNotAllowedByPlanPriorité de la campagne, utilisée pour décider de quelle campagne prendre les prochains numéros à appeler, lorsque plusieurs campagnes partagent des ressources.
LowNormalHighID du système téléphonique utilisé pour effectuer les appels.
ID de l’extension du système téléphonique utilisée pour effectuer les appels.
Mode de numérotation de la campagne, et ses paramètres. Le champ mode définit le mode, et les autres champs en dépendent.
Premier jour où la campagne peut effectuer des appels.
Dernier jour où la campagne peut effectuer des appels (ce jour inclus), ou null pour aucune date de fin. Elle ne peut pas être antérieure à startDate.
ID du groupe de jours fériés de la campagne, ou null. Les jours fériés utilisent les horaires de travail définis pour le dimanche.
Fuseau horaire IANA de la campagne, par exemple America/New_York. Les dates et les horaires de travail sont relatifs à ce fuseau horaire.
Plages horaires pendant lesquelles les appels peuvent être effectués, pour chaque jour de la semaine. Chaque jour doit être présent : envoyez un tableau vide pour les jours sans appels.
Indique si des numéros peuvent être ajoutés ou supprimés une fois la campagne activée (Dynamic) ou non (Static). Une campagne statique se termine automatiquement lorsque tous ses numéros ont été traités.
StaticDynamicOrdre dans lequel les numéros sont appelés : premier entré, premier sorti (Fifo), ou dernier entré, premier sorti (Lifo).
FifoLifoIndique si les numéros pas encore contactés sont appelés avant les nouvelles tentatives (NotContacted), ou l’inverse (RetryPending).
NotContactedRetryPendingPréfixe ajouté à chaque numéro avant l’appel, par exemple pour sélectionner une ligne sortante, ou "" pour aucun préfixe. Jusqu’à 256 préfixes séparés par des virgules peuvent être spécifiés, pour alterner entre eux : chacun d’au maximum 6 caractères, parmi les chiffres, *, # et +.
Temps d’attente pour que l’appel soit répondu : entre 1 et 600 secondes, ou entre 1 et 10 minutes. En mode Progressive, il s’applique à l’appel vers l’agent.
Nombre maximal de fois où chaque numéro est appelé, entre 1 et 9.
Temps minimal entre les tentatives, jusqu’à 6 mois. Entre 1 et 8 intervalles peuvent être définis, pour utiliser des temps d’attente différents pour les tentatives successives.
ID des listes noires contenant les numéros qui ne doivent pas être appelés. Envoyez un tableau vide pour n’en utiliser aucune.
Ce qui se passe lorsqu’un appel est répondu. Le champ $t définit le mode de gestion des appels, et les autres champs en dépendent. Obligatoire pour les modes de numérotation Power et Predictive, et doit être null pour le mode Progressive, où l’appel est toujours connecté à un agent.
ID du webhook qui reçoit les événements de la campagne, ou null.
Nombre de numéros de la campagne.
Nombre de numéros dans chaque statut.
Noms des variables dont les valeurs sont stockées pour chaque numéro, ou null si la campagne n’a pas encore de numéros. Ils sont définis par les premiers numéros ajoutés à la campagne.
Indique si la campagne est archivée. Les campagnes archivées sont masquées par défaut dans la Console Web.
Interactions de la campagne dont les résultats sont rapportés pour chaque appel, comme les saisies DTMF des flux d’appel, ou les objectifs de l’agent IA. Utilisé pour interpréter les inputResults des détails des appels.
Date et heure de création de la campagne.
Date et heure de la dernière modification. Envoyez cette valeur dans lastUpdatedAt lors de la modification de la campagne.
Toujours null, sauf dans la réponse de Supprimer une campagne, où il contient la date et l’heure de suppression de la campagne.
Date et heure auxquelles la campagne a commencé à effectuer des appels, ou null.
Date et heure auxquelles la campagne a été annulée ou s’est terminée, ou null.
L’objet campagne
{
"id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
"name": "Q4 Renewals",
"tagIds": [],
"state": "Active",
"activeStatus": "Running",
"runningPriority": "Normal",
"phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
"extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
"dialer": {
"mode": "Predictive",
"intensity": 0
},
"startDate": "2026-10-01",
"endDate": null,
"holidayGroupId": null,
"timeZoneId": "America/New_York",
"workingTimes": {
"monday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"friday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"saturday": [],
"sunday": []
},
"numberProvisioning": "Dynamic",
"numberSelection": "Fifo",
"numberPriority": "RetryPending",
"callPrefix": "",
"ringTimeout": {
"value": 30,
"unit": "Seconds"
},
"maxAttempts": 3,
"retryIntervals": [
{
"value": 1,
"unit": "Hours"
},
{
"value": 1,
"unit": "Days"
}
],
"blackListIds": [
"01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
],
"callHandling": {
"$t": "Callflow",
"answerTypeDetector": {
"$t": "AmdAgent",
"amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
"unknownAnswerTreatment": "Human",
"messageForVoicemail": {
"$t": "OnFirstDetection",
"callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
"isCallRetryEnabled": true
}
},
"callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
"ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
},
"webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb",
"numbersCount": 1250,
"progress": {
"notContacted": 610,
"contacting": 12,
"success": 402,
"failure": 96,
"retryPending": 118,
"blacklisted": 12,
"deleted": 0
},
"varNames": [
"Customer Name",
"Due Balance"
],
"isArchived": false,
"interactionLabels": [
{
"id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
"label": "Renewal confirmation"
}
],
"createdAt": "2026-09-28T14:02:11.482",
"updatedAt": "2026-10-01T09:00:02.731",
"deletedAt": null,
"startedAt": "2026-10-01T09:00:04.118",
"endedAt": null
}
