Listar detalhes das chamadas

GET/v1/accounts/{accountId}/campaigns/{campaignId}/reports/callDetails

Retorna os detalhes das chamadas feitas por uma campanha, opcionalmente filtrados e ordenados.

Parâmetros de caminho

accountIduuidObrigatório

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

campaignIduuidObrigatório

ID da campanha.

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 ["startedAtLocal","DESC"]. O padrão é ["startedAtLocal","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.

numberstring

Chamadas para números que contêm o texto.

Exemplo: {"number":"555100"}

varValuesobject

Chamadas cuja variável contém o texto (sem diferenciar maiúsculas e minúsculas). A chave é $ seguido da posição da variável, começando em 1.

Exemplo: {"varValues":{"$1":"robertson"}}

calledNumberstring

Chamadas cujo número discado contém o texto.

Exemplo: {"calledNumber":"9555100"}

numberPrefixstring

Chamadas feitas com o prefixo informado.

Exemplo: {"numberPrefix":"9"}

attemptintegerOperadores: _gt_gte_lt_lte

Chamadas por número da tentativa.

Exemplo: {"attempt":1}

addedAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas pela data e hora em que o número foi adicionado.

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

startedAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas por data e hora de início.

Exemplo: {"startedAtLocal_gte":"2026-10-01T00:00:00","startedAtLocal_lt":"2026-10-02T00:00:00"}

answeredAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas por data e hora de atendimento.

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

endedAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas por data e hora de término.

Exemplo: {"endedAtLocal_lt":"2026-10-02T00:00:00"}

ringResultenum

Chamadas com o resultado de toque informado.

Valores possíveis:AnswerNoAnswerBusyCallError

Exemplo: {"ringResult":"Answer"}

sipResponseCodeinteger

Chamadas com o código de resposta SIP informado.

Exemplo: {"sipResponseCode":486}

answerTypeenum

Chamadas com o tipo de atendimento informado.

Valores possíveis:HumanMachineVoicemailMessageUnknown

Exemplo: {"answerType":"Human"}

endTypeenum

Chamadas com o tipo de finalização informado.

Valores possíveis:CallflowCompleteInteractionCompleteHangUpExecutionError

Exemplo: {"endType":["CallflowComplete","InteractionComplete"]}

lastActionobject

Chamadas cuja última ação corresponde.

Exemplo: {"lastAction":{"$t":"TransferCall"}}

voicemailLeftboolean

Chamadas em que foi deixada, ou não, uma mensagem na caixa postal.

Exemplo: {"voicemailLeft":true}

errorDetailsstring

Chamadas cujos detalhes do erro contêm o texto.

Exemplo: {"errorDetails":"timeout"}

inputResultsobject

Chamadas com os resultados de interação informados. Cada chave é o ID da ação de entrada DTMF ou do objetivo do agente de IA, e cada valor é o resultado esperado.

Exemplo: {"inputResults":{"a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05":"1"}}

transcriptionsstring

Chamadas cuja conversa contém o texto.

Exemplo: {"transcriptions":"call me back"}

queueIdstring

Chamadas atendidas pela fila informada.

Exemplo: {"queueId":"800"}

agentIdstring

Chamadas atendidas pelo agente informado.

Exemplo: {"agentId":"101"}

transferResultenum

Chamadas com o resultado de transferência informado.

Valores possíveis:ConnectedNotConnectedConnectionUnknown

Exemplo: {"transferResult":"NotConnected"}

transferConnectedAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas pela data e hora em que o número externo atendeu a chamada transferida.

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

agentReleasedAtLocaltimestampOperadores: _gt_gte_lt_lte

Chamadas pela data e hora em que a chamada entre o agente e o número externo terminou.

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

setupDurationdurationOperadores: _gt_gte_lt_lte

Chamadas por duração da configuração. O mesmo se aplica a connectedDuration, totalDuration, transferDuration, agentSetupDuration, agentConnectedDuration e agentTotalDuration.

Exemplo: {"connectedDuration_gte":"00:01:00"}

outcomeenum

Chamadas com o desfecho informado.

Valores possíveis:SuccessFailureWithRetryPendingFailureWithNoRetryLeft

Exemplo: {"outcome":"Success"}

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 startedAtLocal em ordem crescente.

startedAtLocalnumberaddedAtLocalattemptringResultsipResponseCodeansweredAtLocalanswerTypeendedAtLocalendTypesetupDurationconnectedDurationtotalDurationtransferDurationtransferConnectedAtLocalagentReleasedAtLocalagentSetupDurationagentConnectedDurationagentTotalDurationoutcome

Retorna

Retorna um array de objetos detalhes da chamada 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: callDetails 0-9/57. Consulte Paginação.

GET

/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/reports/callDetails

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/reports/callDetails' \
  -H 'Authorization: Bearer API_KEY_TOKEN' \
  --data-urlencode 'filter={"startedAtLocal_gte":"2026-10-01T00:00:00","ringResult":"Answer"}' \
  --data-urlencode 'sort=["startedAtLocal","ASC"]' \
  --data-urlencode 'range=[0,99]'

Resposta

200 OK

[
  {
    "id": "01928322-32a3-7000-bf0d-bf1af7eda4c5",
    "numberId": 1048165,
    "number": "+18035551004",
    "varValues": [
      "Stefan Robertson",
      "$99.00"
    ],
    "addedAtLocal": "2026-10-01T10:05:23.452",
    "attempt": 1,
    "numberPrefix": "",
    "calledNumber": "+18035551004",
    "queueId": "800",
    "agentId": "101",
    "startedAtLocal": "2026-10-01T11:48:29.479",
    "ringResult": "Answer",
    "sipResponseCode": 200,
    "sipResponseDescrip": "OK",
    "answeredAtLocal": "2026-10-01T11:48:33.735",
    "answerType": "Human",
    "endedAtLocal": "2026-10-01T11:48:50.819",
    "endType": "CallflowComplete",
    "lastAction": {
      "$t": "DtmfInput"
    },
    "voicemailLeft": false,
    "errorDetails": null,
    "inputResults": [
      {
        "inputActionId": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
        "inputValue": "1"
      }
    ],
    "transcriptions": null,
    "setupDuration": "00:00:04.256",
    "connectedDuration": "00:00:17.084",
    "totalDuration": "00:00:21.340",
    "transferDuration": null,
    "transferResult": null,
    "transferConnectedAtLocal": null,
    "agentReleasedAtLocal": null,
    "agentSetupDuration": null,
    "agentConnectedDuration": null,
    "agentTotalDuration": null,
    "outcome": "Success"
  }
]

O objeto detalhes do número

Baixar detalhes das chamadas

Listar detalhes das chamadas

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