NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

CDR (Call History) → Read Cdrs for Specific User

AI-generated

Summary

Read Call Detail Records for a specific user filtered by domain, date range and optional call type.

Inputs

  • refreshOptions — Bypass cached dropdown values to fetch fresh options
  • domain (required) — Domain to filter CDRs; selected from list of available domains for the user
  • user (required) — User identifier for which CDRs are retrieved; selected from list of users for the domain
  • GetDomainsByUsersByCdrs__query__datetime-start (required) — Start datetime for the CDR query
  • GetDomainsByUsersByCdrs__query__datetime-end (required) — End datetime for the CDR query
  • GetDomainsByUsersByCdrs__query__type — Call type filter; options include Inbound, Outbound, On-net, Off-net, Missed, Received, or integer 0‑3
  • GetDomainsByUsersByCdrs__pagination__returnAll — Whether to fetch all results by paging through the API
  • GetDomainsByUsersByCdrs__pagination__start — Start index for pagination; required only when returnAll is false
  • GetDomainsByUsersByCdrs__pagination__limit — Page size limit; required only when returnAll is false

Output shape

List of Call Detail Records (CDR) matching the specified filters

Results are returned as a collection; when Return All Results is false the response is limited by Start and Limit parameters and may be paginated. The shape is always a list, even if empty.

Examples

Example 1: Fetch all inbound CDRs for user 1001 in domain example.com between 2024‑01‑01 and 2024‑01‑31

domain=example.com&user.id=1001&datetime-start=2024-01-01T00:00:00Z&datetime-end=2024-01-31T23:59:59Z&type=Inbound&returnAll=true

Example 2: Retrieve the first 50 CDRs for user 2002 without pagination helpers

domain=demo.com&user.id=2002&datetime-start=2024-02-01T00:00:00Z&datetime-end=2024-02-28T23:59:59Z&returnAll=false&start=0&limit=50

Example 3: Refresh dropdown caches and list all available domains for user 3003

refreshOptions=true&user.id=3003

Links

Discussion