NetSapiens icon

NetSapiens

Interact with the NetSapiens API

Actions477

CDR (Call History) → Read Cdrs for Domain

AI-generated

Summary

Read CDRs for a specified domain within a date range, optionally filtered by type and pagination.

Inputs

  • refreshOptions — Bypass cached dropdown values and fetch fresh options.
  • GetDomainsByCdrs__path__domain (required) — Domain to query; can be selected from a list or entered as a domain name string.
  • GetDomainsByCdrs__query__datetime-start (required) — Start datetime for filtering CDRs.
  • GetDomainsByCdrs__query__datetime-end (required) — End datetime for filtering CDRs.
  • GetDomainsByCdrs__query__type — Filter by CDR type (e.g., Inbound, Outbound, Missed) or a custom type value.
  • GetDomainsByCdrs__pagination__returnAll — Fetch all results by paging through the API when true.
  • GetDomainsByCdrs__pagination__start — Start index for pagination; required only when returnAll is false.
  • GetDomainsByCdrs__pagination__limit — Page size limit; required only when returnAll is false.

Output shape

an array of domain records

Each record represents a domain with its associated CDRs; pagination can be controlled via start and limit when returnAll is false; the operation returns a success response even if no records are found.

Examples

Example 1: Fetch all inbound CDRs for example.com between Jan 1 and Jan 31 2024

Domain=example.com, Datetime Start=2024-01-01T00:00:00Z, Datetime End=2024-01-31T23:59:59Z, Type=Inbound, Return All Results=true

Example 2: Retrieve a paginated subset of domains with a limit of 50 entries

Return All Results=false, Start=0, Limit=50

Example 3: Identify missed calls for any domain using default date range

Type=Missed, Datetime Start and End left empty, Return All Results=true

Links

Discussion