Listar campañas

GET/v1/accounts/{accountId}/campaigns

Devuelve las campañas de la cuenta, opcionalmente filtradas y ordenadas.

Las campañas archivadas se gestionan de la siguiente manera:

Cuando el parámetro filter se omite, se devuelven todas las campañas, incluidas las archivadas.
Cuando el parámetro filter se envía, aunque sea como un objeto vacío ({}), las campañas archivadas se excluyen, a menos que el filtro incluya el campo isArchived. Usa {"isArchived":true} para obtener solo las campañas archivadas.

Parámetros de ruta

accountIduuidObligatorio

ID de tu cuenta de SIP Caller. Consulta ID de la cuenta.

Parámetros de consulta

filterJSON object

Condiciones que deben cumplir los registros, como {"name":"sales"}. Consulta los Campos de filtro más abajo, y Filtro para ver la sintaxis.

sortJSON array

Campo y dirección usados para ordenar los registros, como ["name","DESC"]. El valor predeterminado es ["name","ASC"]. Consulta Ordenamiento.

rangeJSON array

Posiciones, comenzando en cero, del primer y del último registro a devolver, ambos incluidos, como [0,99]. El valor predeterminado es [0,9]. Consulta Paginación.

Campos de filtro

Campos que se pueden usar en el parámetro de consulta filter. Consulta Filtro para ver la sintaxis general.

idsarray of uuids

Campañas con cualquiera de los IDs indicados.

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

namestring

Campañas cuyo nombre contiene el texto (sin distinguir mayúsculas de minúsculas).

Ejemplo: {"name":"renewals"}

tagIdsarray of stringsOperadores: _ovl_ctn

Campañas con cualquiera de las etiquetas indicadas (_ovl), o con una etiqueta específica (_ctn).

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

stateenum

Campañas en el estado indicado. Usa un array para varios estados.

Valores posibles:DraftActivePausedCanceledFinished

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

runningPriorityenum

Campañas con la prioridad de ejecución indicada.

Valores posibles:LowNormalHigh

Ejemplo: {"runningPriority":"High"}

phoneSystemIduuid

Campañas que usan la central telefónica indicada.

Ejemplo: {"phoneSystemId":"PHONE_SYSTEM_ID"}

extensionIdstring

Campañas que usan la extensión indicada.

Ejemplo: {"extensionId":"EXTENSION_ID"}

dialerobject

Campañas cuya configuración de discador contiene los valores indicados.

Ejemplo: {"dialer":{"mode":"Predictive"}}

startDatedateOperadores: _gt_gte_lt_lte

Campañas por fecha de inicio.

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

endDatedateOperadores: _gt_gte_lt_lte

Campañas por fecha de finalización.

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

numberProvisioningenum

Campañas con la provisión de números indicada.

Valores posibles:StaticDynamic

Ejemplo: {"numberProvisioning":"Dynamic"}

numberSelectionenum

Campañas con la selección de números indicada.

Valores posibles:FifoLifo

Ejemplo: {"numberSelection":"Fifo"}

numberPriorityenum

Campañas con la prioridad de números indicada.

Valores posibles:NotContactedRetryPending

Ejemplo: {"numberPriority":"RetryPending"}

callHandlingModeenum

Campañas con el modo de gestión de llamada indicado (el campo $t de callHandling).

Valores posibles:CallflowAiAgent

Ejemplo: {"callHandlingMode":"AiAgent"}

callflowIdsarray of uuidsOperadores: _ctn_ovl

Campañas que usan el flujo de llamada indicado, ya sea para respuestas humanas o para buzones de voz.

Ejemplo: {"callflowIds_ctn":"CALLFLOW_ID"}

aiAgentIduuid

Campañas que usan el agente conversacional de IA indicado.

Ejemplo: {"aiAgentId":"AI_AGENT_ID"}

amdAgentIduuid

Campañas que usan el agente de IA de detección de buzón de voz indicado.

Ejemplo: {"amdAgentId":"AMD_AGENT_ID"}

webhookEndpointIduuid

Campañas que envían eventos al webhook indicado.

Ejemplo: {"webhookEndpointId":"WEBHOOK_ID"}

isArchivedboolean

Campañas archivadas o no archivadas.

Ejemplo: {"isArchived":true}

startedAttimestampOperadores: _gt_gte_lt_lte

Campañas por la fecha y hora en que comenzaron a realizar llamadas.

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

endedAttimestampOperadores: _gt_gte_lt_lte

Campañas por la fecha y hora en que se cancelaron o finalizaron.

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

Campos de ordenamiento

Campos que se pueden usar en el parámetro de consulta sort, en orden ascendente (ASC) o descendente (DESC). Consulta Ordenamiento para ver la sintaxis general. Cuando se omite sort, los resultados se ordenan por name en orden ascendente.

namestaterunningPrioritystartDateendDatenumbersCountstartedAtendedAt

Devuelve

Devuelve un array de objetos campaña para la página solicitada. Los encabezados X-Total-Count y Content-Range contienen la cantidad total de registros que cumplen el filtro, por ejemplo Content-Range: campaigns 0-9/57. Consulta Paginación.

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

Respuesta

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

El objeto campaña

Obtener una campaña

Listar campañas

Parámetros de ruta

Parámetros de consulta

Campos de filtro

Campos de ordenamiento

Devuelve

Producto

Soluciones

Empresa

Ayuda & Docs

Legal