List call details

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

Returns the details of the calls made by a campaign, optionally filtered and sorted.

Path parameters

accountIduuidRequired

ID of your SIP Caller account. See Account ID.

campaignIduuidRequired

ID of the campaign.

Query parameters

filterJSON object

Conditions that the records must match, such as {"name":"sales"}. See the Filter fields below, and Filter for the syntax.

sortJSON array

Field and direction used to sort the records, such as ["startedAtLocal","DESC"]. Defaults to ["startedAtLocal","ASC"]. See Sort.

rangeJSON array

Zero-based positions of the first and last records to return, both included, such as [0,99]. Defaults to [0,9]. See Pagination.

Filter fields

Fields that can be used in the filter query parameter. See Filter for the general syntax.

numberstring

Calls to numbers that contain the text.

Example: {"number":"555100"}

varValuesobject

Calls whose variable contains the text (case-insensitive). The key is $ followed by the position of the variable, starting at 1.

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

calledNumberstring

Calls whose dialed number contains the text.

Example: {"calledNumber":"9555100"}

numberPrefixstring

Calls made with the given prefix.

Example: {"numberPrefix":"9"}

attemptintegerOperators: _gt_gte_lt_lte

Calls by attempt number.

Example: {"attempt":1}

addedAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by the date and time the number was added.

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

startedAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by start date and time.

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

answeredAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by answer date and time.

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

endedAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by end date and time.

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

ringResultenum

Calls with the given ring result.

Possible values:AnswerNoAnswerBusyCallError

Example: {"ringResult":"Answer"}

sipResponseCodeinteger

Calls with the given SIP response code.

Example: {"sipResponseCode":486}

answerTypeenum

Calls with the given answer type.

Possible values:HumanMachineVoicemailMessageUnknown

Example: {"answerType":"Human"}

endTypeenum

Calls with the given end type.

Possible values:CallflowCompleteInteractionCompleteHangUpExecutionError

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

lastActionobject

Calls whose last action matches.

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

voicemailLeftboolean

Calls where a voicemail message was left, or not.

Example: {"voicemailLeft":true}

errorDetailsstring

Calls whose error details contain the text.

Example: {"errorDetails":"timeout"}

inputResultsobject

Calls with the given interaction results. Each key is the ID of the DTMF input action or AI agent goal, and each value is the expected result.

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

transcriptionsstring

Calls whose conversation contains the text.

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

queueIdstring

Calls handled by the given queue.

Example: {"queueId":"800"}

agentIdstring

Calls handled by the given agent.

Example: {"agentId":"101"}

transferResultenum

Calls with the given transfer result.

Possible values:ConnectedNotConnectedConnectionUnknown

Example: {"transferResult":"NotConnected"}

transferConnectedAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by the date and time the external number answered the transferred call.

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

agentReleasedAtLocaltimestampOperators: _gt_gte_lt_lte

Calls by the date and time the call between the agent and the external number ended.

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

setupDurationdurationOperators: _gt_gte_lt_lte

Calls by setup duration. The same applies to connectedDuration, totalDuration, transferDuration, agentSetupDuration, agentConnectedDuration and agentTotalDuration.

Example: {"connectedDuration_gte":"00:01:00"}

outcomeenum

Calls with the given outcome.

Possible values:SuccessFailureWithRetryPendingFailureWithNoRetryLeft

Example: {"outcome":"Success"}

Sort fields

Fields that can be used in the sort query parameter, in ascending (ASC) or descending (DESC) order. See Sort for the general syntax. When sort is omitted, results are sorted by startedAtLocal in ascending order.

startedAtLocalnumberaddedAtLocalattemptringResultsipResponseCodeansweredAtLocalanswerTypeendedAtLocalendTypesetupDurationconnectedDurationtotalDurationtransferDurationtransferConnectedAtLocalagentReleasedAtLocalagentSetupDurationagentConnectedDurationagentTotalDurationoutcome

Returns

Returns an array of call details objects for the requested page. The X-Total-Count and Content-Range headers contain the total number of records matching the filter, for example Content-Range: callDetails 0-9/57. See Pagination.

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

Response

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

The number details object

Download call details

Trustpilot

List call details

Path parameters

Query parameters

Filter fields

Sort fields

Returns

Product

Solutions

Company

Help & Docs

Legal