Lister les campagnes

GET/v1/accounts/{accountId}/campaigns

Renvoie les campagnes du compte, éventuellement filtrées et triées.

Les campagnes archivées sont traitées comme suit :

Lorsque le paramètre filter est omis, toutes les campagnes sont renvoyées, y compris les campagnes archivées.
Lorsque le paramètre filter est envoyé, même sous forme d’objet vide ({}), les campagnes archivées sont exclues, sauf si le filtre inclut le champ isArchived. Utilisez {"isArchived":true} pour obtenir uniquement les campagnes archivées.

Paramètres de chemin

accountIduuidObligatoire

ID de votre compte SIP Caller. Consultez ID du compte.

Paramètres de requête

filterJSON object

Conditions auxquelles les enregistrements doivent répondre, par exemple {"name":"sales"}. Consultez les Champs de filtre ci-dessous, et Filtrage pour la syntaxe.

sortJSON array

Champ et sens utilisés pour trier les enregistrements, par exemple ["name","DESC"]. Par défaut : ["name","ASC"]. Consultez Tri.

rangeJSON array

Positions, commençant à zéro, du premier et du dernier enregistrement à renvoyer, tous deux inclus, par exemple [0,99]. Par défaut : [0,9]. Consultez Pagination.

Champs de filtre

Champs utilisables dans le paramètre de requête filter. Consultez Filtrage pour la syntaxe générale.

idsarray of uuids

Campagnes ayant l’un des ID indiqués.

Exemple : {"ids":["CAMPAIGN_ID_1","CAMPAIGN_ID_2"]}

namestring

Campagnes dont le nom contient le texte (insensible à la casse).

Exemple : {"name":"renewals"}

tagIdsarray of stringsOpérateurs : _ovl_ctn

Campagnes ayant l’une des balises indiquées (_ovl), ou une balise spécifique (_ctn).

Exemple : {"tagIds_ovl":["TAG_ID_1","TAG_ID_2"]}

stateenum

Campagnes dans l’état indiqué. Utilisez un tableau pour plusieurs états.

Valeurs possibles :DraftActivePausedCanceledFinished

Exemple : {"state":["Active","Paused"]}

runningPriorityintegerOpérateurs : _gt_gte_lt_lte

Campagnes avec la priorité d’exécution indiquée, entre -20 et 20. Utilisez un tableau pour plusieurs valeurs, comme [10,20] pour High et Max, ou les opérateurs pour une plage.

Exemple : {"runningPriority":[10,20]}

phoneSystemIduuid

Campagnes qui utilisent le système téléphonique indiqué.

Exemple : {"phoneSystemId":"PHONE_SYSTEM_ID"}

extensionIdstring

Campagnes qui utilisent l’extension indiquée.

Exemple : {"extensionId":"EXTENSION_ID"}

dialerobject

Campagnes dont les paramètres de numérotation contiennent les valeurs indiquées.

Exemple : {"dialer":{"mode":"Predictive"}}

startDatedateOpérateurs : _gt_gte_lt_lte

Campagnes par date de début.

Exemple : {"startDate_gte":"2026-10-01"}

endDatedateOpérateurs : _gt_gte_lt_lte

Campagnes par date de fin.

Exemple : {"endDate_lt":"2026-12-31"}

numberProvisioningenum

Campagnes ayant le provisionnement des numéros indiqué.

Valeurs possibles :StaticDynamic

Exemple : {"numberProvisioning":"Dynamic"}

numberSelectionenum

Campagnes ayant la sélection des numéros indiquée.

Valeurs possibles :FifoLifo

Exemple : {"numberSelection":"Fifo"}

numberPriorityenum

Campagnes ayant la priorité des numéros indiquée.

Valeurs possibles :NotContactedRetryPending

Exemple : {"numberPriority":"RetryPending"}

callHandlingModeenum

Campagnes ayant le mode de gestion des appels indiqué (le champ $t de callHandling).

Valeurs possibles :CallflowAiAgent

Exemple : {"callHandlingMode":"AiAgent"}

callflowIdsarray of uuidsOpérateurs : _ctn_ovl

Campagnes qui utilisent le flux d’appel indiqué, que ce soit pour les réponses humaines ou pour les messageries vocales.

Exemple : {"callflowIds_ctn":"CALLFLOW_ID"}

aiAgentIduuid

Campagnes qui utilisent l’agent conversationnel IA indiqué.

Exemple : {"aiAgentId":"AI_AGENT_ID"}

amdAgentIduuid

Campagnes qui utilisent l’agent IA de détection de messagerie vocale indiqué.

Exemple : {"amdAgentId":"AMD_AGENT_ID"}

webhookEndpointIduuid

Campagnes qui envoient des événements au webhook indiqué.

Exemple : {"webhookEndpointId":"WEBHOOK_ID"}

isArchivedboolean

Campagnes archivées ou non archivées.

Exemple : {"isArchived":true}

startedAttimestampOpérateurs : _gt_gte_lt_lte

Campagnes selon la date et l’heure auxquelles elles ont commencé à effectuer des appels.

Exemple : {"startedAt_gte":"2026-10-01T00:00:00"}

endedAttimestampOpérateurs : _gt_gte_lt_lte

Campagnes selon la date et l’heure auxquelles elles ont été annulées ou se sont terminées.

Exemple : {"endedAt_lt":"2026-11-01T00:00:00"}

Champs de tri

Champs utilisables dans le paramètre de requête sort, en ordre croissant (ASC) ou décroissant (DESC). Consultez Tri pour la syntaxe générale. Lorsque sort est omis, les résultats sont triés par name en ordre croissant.

namestaterunningPrioritystartDateendDatenumbersCountstartedAtendedAt

Renvoie

Renvoie un tableau d’objets campagne pour la page demandée. Les en-têtes X-Total-Count et Content-Range contiennent le nombre total d’enregistrements correspondant au filtre, par exemple Content-Range: campaigns 0-9/57. Consultez Pagination.

GET

/v1/accounts/ACCOUNT_ID/campaigns

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns' \
  -H 'Authorization: Bearer API_KEY_TOKEN' \
  --data-urlencode 'filter={"state":"Active"}' \
  --data-urlencode 'sort=["name","ASC"]' \
  --data-urlencode 'range=[0,99]'

Réponse

200 OK

[
  {
    "id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
    "name": "Q4 Renewals",
    "tagIds": [],
    "state": "Active",
    "activeStatus": "Running",
    "runningPriority": 0,
    "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
  }
]

L’objet campagne

Récupérer une campagne

Lister les campagnes

Paramètres de chemin

Paramètres de requête

Champs de filtre

Champs de tri

Renvoie

Produit

Solutions

Entreprise

Aide et Docs

Légal