Elencare le campagne

GET/v1/accounts/{accountId}/campaigns

Restituisce le campagne dell'account, con filtri e ordinamento opzionali.

Le campagne archiviate vengono gestite come segue:

Quando il parametro filter viene omesso, vengono restituite tutte le campagne, incluse quelle archiviate.
Quando il parametro filter viene inviato, anche come oggetto vuoto ({}), le campagne archiviate vengono escluse, a meno che il filtro includa il campo isArchived. Usa {"isArchived":true} per ottenere solo le campagne archiviate.

Parametri di percorso

accountIduuidObbligatorio

ID del tuo account SIP Caller. Consulta ID dell'account.

Parametri di query

filterJSON object

Condizioni che i record devono soddisfare, ad esempio {"name":"sales"}. Consulta i Campi di filtro più avanti, e Filtro per la sintassi.

sortJSON array

Campo e direzione utilizzati per ordinare i record, ad esempio ["name","DESC"]. Il valore predefinito è ["name","ASC"]. Consulta Ordinamento.

rangeJSON array

Posizioni, a partire da zero, del primo e dell'ultimo record da restituire, entrambi inclusi, ad esempio [0,99]. Il valore predefinito è [0,9]. Consulta Paginazione.

Campi di filtro

Campi utilizzabili nel parametro di query filter. Consulta Filtro per la sintassi generale.

idsarray of uuids

Campagne con uno qualsiasi degli ID indicati.

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

namestring

Campagne il cui nome contiene il testo (senza distinzione tra maiuscole e minuscole).

Esempio: {"name":"renewals"}

tagIdsarray of stringsOperatori: _ovl_ctn

Campagne con uno qualsiasi dei tag indicati (_ovl), o con un tag specifico (_ctn).

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

stateenum

Campagne nello stato indicato. Usa un array per più stati.

Valori possibili:DraftActivePausedCanceledFinished

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

runningPriorityenum

Campagne con la priorità di esecuzione indicata.

Valori possibili:LowNormalHigh

Esempio: {"runningPriority":"High"}

phoneSystemIduuid

Campagne che utilizzano il sistema telefonico indicato.

Esempio: {"phoneSystemId":"PHONE_SYSTEM_ID"}

extensionIdstring

Campagne che utilizzano l'interno indicato.

Esempio: {"extensionId":"EXTENSION_ID"}

dialerobject

Campagne le cui impostazioni del dialer contengono i valori indicati.

Esempio: {"dialer":{"mode":"Predictive"}}

startDatedateOperatori: _gt_gte_lt_lte

Campagne per data di inizio.

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

endDatedateOperatori: _gt_gte_lt_lte

Campagne per data di fine.

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

numberProvisioningenum

Campagne con il provisioning dei numeri indicato.

Valori possibili:StaticDynamic

Esempio: {"numberProvisioning":"Dynamic"}

numberSelectionenum

Campagne con la selezione dei numeri indicata.

Valori possibili:FifoLifo

Esempio: {"numberSelection":"Fifo"}

numberPriorityenum

Campagne con la priorità dei numeri indicata.

Valori possibili:NotContactedRetryPending

Esempio: {"numberPriority":"RetryPending"}

callHandlingModeenum

Campagne con la modalità di gestione delle chiamate indicata (il campo $t di callHandling).

Valori possibili:CallflowAiAgent

Esempio: {"callHandlingMode":"AiAgent"}

callflowIdsarray of uuidsOperatori: _ctn_ovl

Campagne che utilizzano il flusso di chiamata indicato, sia per le risposte umane sia per le segreterie telefoniche.

Esempio: {"callflowIds_ctn":"CALLFLOW_ID"}

aiAgentIduuid

Campagne che utilizzano l'agente conversazionale IA indicato.

Esempio: {"aiAgentId":"AI_AGENT_ID"}

amdAgentIduuid

Campagne che utilizzano l'agente IA di rilevamento segreteria telefonica indicato.

Esempio: {"amdAgentId":"AMD_AGENT_ID"}

webhookEndpointIduuid

Campagne che inviano eventi al webhook indicato.

Esempio: {"webhookEndpointId":"WEBHOOK_ID"}

isArchivedboolean

Campagne archiviate o non archiviate.

Esempio: {"isArchived":true}

startedAttimestampOperatori: _gt_gte_lt_lte

Campagne per data e ora in cui hanno iniziato a effettuare chiamate.

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

endedAttimestampOperatori: _gt_gte_lt_lte

Campagne per data e ora in cui sono state annullate o sono terminate.

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

Campi di ordinamento

Campi utilizzabili nel parametro di query sort, in ordine crescente (ASC) o decrescente (DESC). Consulta Ordinamento per la sintassi generale. Se sort viene omesso, i risultati sono ordinati per name in ordine crescente.

namestaterunningPrioritystartDateendDatenumbersCountstartedAtendedAt

Restituisce

Restituisce un array di oggetti campagna per la pagina richiesta. Le intestazioni X-Total-Count e Content-Range contengono il numero totale di record che corrispondono al filtro, ad esempio Content-Range: campaigns 0-9/57. Consulta Paginazione.

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]'

Risposta

200 OK

[
  {
    "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
  }
]

L'oggetto campagna

Ottenere una campagna

Elencare le campagne

Parametri di percorso

Parametri di query

Campi di filtro

Campi di ordinamento

Restituisce

Prodotto

Soluzioni

Azienda

Aiuto e Documentazione

Legale