Listar campanhas

GET/v1/accounts/{accountId}/campaigns

Retorna as campanhas da conta, opcionalmente filtradas e ordenadas.

As campanhas arquivadas são tratadas da seguinte forma:

Quando o parâmetro filter é omitido, todas as campanhas são retornadas, incluindo as arquivadas.
Quando o parâmetro filter é enviado, mesmo como um objeto vazio ({}), as campanhas arquivadas são excluídas, a menos que o filtro inclua o campo isArchived. Use {"isArchived":true} para obter apenas as campanhas arquivadas.

Parâmetros de caminho

accountIduuidObrigatório

ID da sua conta SIP Caller. Consulte ID da conta.

Parâmetros de query string

filterJSON object

Condições que os registros devem atender, como {"name":"sales"}. Consulte os Campos de filtro abaixo, e Filtro para a sintaxe.

sortJSON array

Campo e direção usados para ordenar os registros, como ["name","DESC"]. O padrão é ["name","ASC"]. Consulte Ordenação.

rangeJSON array

Posições, começando em zero, do primeiro e do último registro a retornar, ambos incluídos, como [0,99]. O padrão é [0,9]. Consulte Paginação.

Campos de filtro

Campos que podem ser usados no parâmetro de query string filter. Consulte Filtro para a sintaxe geral.

idsarray of uuids

Campanhas com qualquer um dos IDs informados.

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

namestring

Campanhas cujo nome contém o texto (sem diferenciar maiúsculas e minúsculas).

Exemplo: {"name":"renewals"}

tagIdsarray of stringsOperadores: _ovl_ctn

Campanhas com qualquer uma das tags informadas (_ovl), ou com uma tag específica (_ctn).

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

stateenum

Campanhas no estado informado. Use um array para vários estados.

Valores possíveis:DraftActivePausedCanceledFinished

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

runningPriorityenum

Campanhas com a prioridade de execução informada.

Valores possíveis:LowNormalHigh

Exemplo: {"runningPriority":"High"}

phoneSystemIduuid

Campanhas que usam a central telefônica informada.

Exemplo: {"phoneSystemId":"PHONE_SYSTEM_ID"}

extensionIdstring

Campanhas que usam o ramal informado.

Exemplo: {"extensionId":"EXTENSION_ID"}

dialerobject

Campanhas cujas configurações do discador contêm os valores informados.

Exemplo: {"dialer":{"mode":"Predictive"}}

startDatedateOperadores: _gt_gte_lt_lte

Campanhas por data de início.

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

endDatedateOperadores: _gt_gte_lt_lte

Campanhas por data de término.

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

numberProvisioningenum

Campanhas com o provisionamento de números informado.

Valores possíveis:StaticDynamic

Exemplo: {"numberProvisioning":"Dynamic"}

numberSelectionenum

Campanhas com a seleção de números informada.

Valores possíveis:FifoLifo

Exemplo: {"numberSelection":"Fifo"}

numberPriorityenum

Campanhas com a prioridade de números informada.

Valores possíveis:NotContactedRetryPending

Exemplo: {"numberPriority":"RetryPending"}

callHandlingModeenum

Campanhas com o modo de tratamento da chamada informado (o campo $t de callHandling).

Valores possíveis:CallflowAiAgent

Exemplo: {"callHandlingMode":"AiAgent"}

callflowIdsarray of uuidsOperadores: _ctn_ovl

Campanhas que usam o fluxo de chamada informado, seja para atendimentos humanos ou para caixas postais.

Exemplo: {"callflowIds_ctn":"CALLFLOW_ID"}

aiAgentIduuid

Campanhas que usam o agente conversacional de IA informado.

Exemplo: {"aiAgentId":"AI_AGENT_ID"}

amdAgentIduuid

Campanhas que usam o agente de detecção de caixa postal com IA informado.

Exemplo: {"amdAgentId":"AMD_AGENT_ID"}

webhookEndpointIduuid

Campanhas que enviam eventos para o webhook informado.

Exemplo: {"webhookEndpointId":"WEBHOOK_ID"}

isArchivedboolean

Campanhas arquivadas ou não arquivadas.

Exemplo: {"isArchived":true}

startedAttimestampOperadores: _gt_gte_lt_lte

Campanhas pela data e hora em que começaram a fazer chamadas.

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

endedAttimestampOperadores: _gt_gte_lt_lte

Campanhas pela data e hora em que foram canceladas ou finalizadas.

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

Campos de ordenação

Campos que podem ser usados no parâmetro de query string sort, em ordem crescente (ASC) ou decrescente (DESC). Consulte Ordenação para a sintaxe geral. Quando sort é omitido, os resultados são ordenados por name em ordem crescente.

namestaterunningPrioritystartDateendDatenumbersCountstartedAtendedAt

Retorna

Retorna um array de objetos campanha para a página solicitada. Os cabeçalhos X-Total-Count e Content-Range contêm o número total de registros que atendem ao filtro, por exemplo Content-Range: campaigns 0-9/57. Consulte Paginação.

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

Resposta

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

O objeto campanha

Obter uma campanha

Listar campanhas

Parâmetros de caminho

Parâmetros de query string

Campos de filtro

Campos de ordenação

Retorna

Produto

Soluções

Empresa

Ajuda e Documentação

Jurídico