Lista szczegółów połączeń

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

Zwraca szczegóły połączeń wykonanych przez kampanię, opcjonalnie przefiltrowane i posortowane.

Parametry ścieżki

accountIduuidWymagane

ID Twojego konta SIP Caller. Zobacz ID konta.

campaignIduuidWymagane

ID kampanii.

Parametry zapytania

filterJSON object

Warunki, które muszą spełniać rekordy, na przykład {"name":"sales"}. Zobacz Pola filtra poniżej oraz Filtrowanie, aby poznać składnię.

sortJSON array

Pole i kierunek sortowania rekordów, na przykład ["startedAtLocal","DESC"]. Domyślnie ["startedAtLocal","ASC"]. Zobacz Sortowanie.

rangeJSON array

Liczone od zera pozycje pierwszego i ostatniego zwracanego rekordu, obie włącznie, na przykład [0,99]. Domyślnie [0,9]. Zobacz Paginacja.

Pola filtra

Pola, których można używać w parametrze zapytania filter. Ogólną składnię opisano w sekcji Filtrowanie.

numberstring

Połączenia do numerów zawierających podany tekst.

Przykład: {"number":"555100"}

varValuesobject

Połączenia, których zmienna zawiera podany tekst (bez rozróżniania wielkości liter). Kluczem jest $, po którym następuje pozycja zmiennej, licząc od 1.

Przykład: {"varValues":{"$1":"robertson"}}

calledNumberstring

Połączenia, których wybrany numer zawiera podany tekst.

Przykład: {"calledNumber":"9555100"}

numberPrefixstring

Połączenia wykonane z podanym prefiksem.

Przykład: {"numberPrefix":"9"}

attemptintegerOperatory: _gt_gte_lt_lte

Połączenia według numeru próby.

Przykład: {"attempt":1}

addedAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny dodania numeru.

Przykład: {"addedAtLocal_gte":"2026-10-01T00:00:00"}

startedAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny rozpoczęcia.

Przykład: {"startedAtLocal_gte":"2026-10-01T00:00:00","startedAtLocal_lt":"2026-10-02T00:00:00"}

answeredAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny odebrania.

Przykład: {"answeredAtLocal_gte":"2026-10-01T00:00:00"}

endedAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny zakończenia.

Przykład: {"endedAtLocal_lt":"2026-10-02T00:00:00"}

ringResultenum

Połączenia z podanym wynikiem dzwonienia.

Możliwe wartości:AnswerNoAnswerBusyCallError

Przykład: {"ringResult":"Answer"}

sipResponseCodeinteger

Połączenia z podanym kodem odpowiedzi SIP.

Przykład: {"sipResponseCode":486}

answerTypeenum

Połączenia z podanym rodzajem odpowiedzi.

Możliwe wartości:HumanMachineVoicemailMessageUnknown

Przykład: {"answerType":"Human"}

endTypeenum

Połączenia z podanym rodzajem zakończenia.

Możliwe wartości:CallflowCompleteInteractionCompleteHangUpExecutionError

Przykład: {"endType":["CallflowComplete","InteractionComplete"]}

lastActionobject

Połączenia, których ostatnia akcja jest zgodna.

Przykład: {"lastAction":{"$t":"TransferCall"}}

voicemailLeftboolean

Połączenia, w których pozostawiono (lub nie) wiadomość na poczcie głosowej.

Przykład: {"voicemailLeft":true}

errorDetailsstring

Połączenia, których szczegóły błędu zawierają podany tekst.

Przykład: {"errorDetails":"timeout"}

inputResultsobject

Połączenia z podanymi wynikami interakcji. Każdy klucz to ID akcji wejścia DTMF lub celu agenta AI, a każda wartość to oczekiwany wynik.

Przykład: {"inputResults":{"a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05":"1"}}

transcriptionsstring

Połączenia, których rozmowa zawiera podany tekst.

Przykład: {"transcriptions":"call me back"}

queueIdstring

Połączenia obsłużone przez podaną kolejkę.

Przykład: {"queueId":"800"}

agentIdstring

Połączenia obsłużone przez podanego agenta.

Przykład: {"agentId":"101"}

transferResultenum

Połączenia z podanym wynikiem przeniesienia.

Możliwe wartości:ConnectedNotConnectedConnectionUnknown

Przykład: {"transferResult":"NotConnected"}

transferConnectedAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny, w której numer zewnętrzny odebrał przeniesione połączenie.

Przykład: {"transferConnectedAtLocal_gte":"2026-10-01T00:00:00"}

agentReleasedAtLocaltimestampOperatory: _gt_gte_lt_lte

Połączenia według daty i godziny zakończenia połączenia między agentem a numerem zewnętrznym.

Przykład: {"agentReleasedAtLocal_gte":"2026-10-01T00:00:00"}

setupDurationdurationOperatory: _gt_gte_lt_lte

Połączenia według czasu nawiązywania połączenia. To samo dotyczy pól connectedDuration, totalDuration, transferDuration, agentSetupDuration, agentConnectedDuration i agentTotalDuration.

Przykład: {"connectedDuration_gte":"00:01:00"}

outcomeenum

Połączenia z podanym rezultatem.

Możliwe wartości:SuccessFailureWithRetryPendingFailureWithNoRetryLeft

Przykład: {"outcome":"Success"}

Pola sortowania

Pola, których można używać w parametrze zapytania sort, w kolejności rosnącej (ASC) lub malejącej (DESC). Ogólną składnię opisano w sekcji Sortowanie. Gdy parametr sort zostanie pominięty, wyniki są sortowane rosnąco według pola startedAtLocal.

startedAtLocalnumberaddedAtLocalattemptringResultsipResponseCodeansweredAtLocalanswerTypeendedAtLocalendTypesetupDurationconnectedDurationtotalDurationtransferDurationtransferConnectedAtLocalagentReleasedAtLocalagentSetupDurationagentConnectedDurationagentTotalDurationoutcome

Zwraca

Zwraca tablicę obiektów szczegółów połączenia dla żądanej strony. Nagłówki X-Total-Count i Content-Range zawierają całkowitą liczbę rekordów pasujących do filtra, na przykład Content-Range: callDetails 0-9/57. Zobacz Paginacja.

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

Odpowiedź

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

Poprzednia

Obiekt szczegółów numeru

Następna

Eksport szczegółów połączeń

Lista szczegółów połączeń

Parametry ścieżki

Parametry zapytania

Pola filtra

Pola sortowania

Zwraca

Produkt

Rozwiązania

Firma

Pomoc i Dokumenty

Prawny