NetSapiens API v2
  1. CDR (Call History)
NetSapiens API v2
  • TODO LIST
  • Version
    • Read API Version
      GET
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
      • Read API Keys under your account
      • Read Info on specific APIKey via Key ID
      • Create API Key
      • Update API Key
      • Revoke API Key
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
      • Revoke current JWT
      • Read Current JWT
  • Event Subscriptions
    • Read Event Subscriptions
      GET
    • Read Event Subscription By Id
      GET
    • Create a Event Subscription
      POST
    • Update an Event Subscription
      PUT
    • Delete a subscription
      DELETE
  • Resellers
    • Get Resellers
      GET
    • Create Reseller
      POST
    • Update Reseller
      PUT
    • Delete Reseller
      DELETE
    • Get Specific Reseller
      GET
  • Domains
    • Get Domains
      GET
    • Count Domains
      GET
    • Get Specific Domain
      GET
    • Get Specific Domain With Billing Summary
      GET
    • Get My Domain Info
      GET
    • Check if Domain Exists
      GET
    • Create a Domain
      POST
    • Update a Domain
      PUT
    • Delete a Domain
      DELETE
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Users
    • Get Users in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Create User in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
  • Devices
    • Count Devices for User
    • Get Devices for User
    • Create Device for User
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
  • Phones/Macs
    • Supported Models and Servers
      • Get list of Supported/Provisionable Models
      • Get list of Supported/Provisionable by Vendor
      • Get details of Specific Model
      • Get list of Provisionable Server Profiles
      • Read Provisionable Server Details
    • Read Mac Addresses
    • Read Mac Addresses in Domain
    • Read Specific Mac Address
    • Add MAC address
    • Add MAC address for Domain
    • Update MAC address
    • Update MAC address in Domain
    • Remove MAC address
    • Remove MAC address in Domain
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Create Site in Domain
    • Update Site in Domain
    • Read Specific Site in Domain
  • Call Center
    • Callqueues
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
    • Agents
      • Read Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
  • Answer Rules
    • Read Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Add a Answerrule for a User
    • Delete a Answerrule for a User
    • Update a Answerrule for a User
    • Reorder Answerrules for my User
  • Call Blocking
    • Read blocked numbers for a Domain
    • Read blocked numbers for a User
    • Add blocked numbers for a Domain
    • Add blocked numbers for a User
    • Delete blocked numbers for a Domain
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Create a new MOH for Domain from TTS
        • Update MOH for Domain from TTS
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
        • Delete MOH for Domain
      • User
        • Read MOH for User
        • Create a new MOH for Domain from TTS
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Delete MOH for User
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • CDR (Call History)
    • Read CDRs
      GET
    • Read CDRs for Domain
      GET
    • Read CDRs for Specific User
      GET
    • Search CDRs for Domain
      GET
    • Read CDRs for Site in Domain
      GET
    • Count CDRs and SUM minutes
      GET
    • Count CDRs and SUM minutes for Domain
      GET
    • Count CDRs and SUM minutes for Specifc User
      GET
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Call Traces & Cradle to Grave
    • Get Call Trace (SIPFlow) For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
  • Calls (live/active calls)
    • Read Active Calls In Domain
    • Count Active Calls In Domain
    • Read Active Calls for User
    • Read Specific Actice Call
    • Make a new Call
    • Disconnect Call
    • Transfer Peer Call
    • Transfer Call
    • Answer Call
    • Hold Active Call
    • Un-Hold Active Call
    • Reject Call
    • Report Active Calls
  • Contacts
    • Shared Contacts
      • Get Domain Contacts
      • Get Specific Domain Contact
      • Create Shared Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get Contacts for User
    • Get Specific Contact for User
    • Count Contacts for User
    • Create Contact
    • Update Contact
    • Delete Contact
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Validate Address
    • Create Address for Domain
    • Update Address for Domain
    • Update Address for User
    • Update Address Endpoint
    • Create Address for User
    • Delete Address For User
    • Delete Address Endpoint
    • Delete Address For Domain
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
    • Get Addresses for User
    • Get Address Using Address ID
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Add a new dial rule into a dial plan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
  • Messages
    • Get Messagesessions for Domain
    • Start a new Message Session
    • Get Messagesessions for User
    • Get Messages for Messagesession
    • Send a message (Chat)
    • Send a message (Group Chat)
    • Send a message (Media Chat)
    • Send a message (SMS)
    • Send a message (Group SMS)
    • Send a message (MMS)
    • Update Messagesession (Participants)
    • Update Messagesession (Session Name)
    • Update Messagesession (Leave)
    • Delete Messagesession
  • SMS Numbers
    • Get All SMS Numbers for System
    • Get SMS Numbers for Domain
    • Create SMS Number
    • Update SMS Number Copy
    • Delete an SMS Number
    • Get SMS Numbers for User
    • Count SMS Numbers for User
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
  • Email
    • Send Email using Template
  • Connections
    • Get All Connections
    • Count All Conections
    • Get All Connections for a Domain
    • Get Specific Connection for a Domain
    • Delete a Specific Connection for a Domain
    • Create a Connection
    • Update a Connection
  • Routes
    • Read Routes
    • Count All Routes
    • Read Route Connections
    • Count All Route Connections
    • Create a Route
    • Create a Route Connection
    • Delete A Specific Route
    • Update A Specific Route
    • Update A Specific Route Connection
  • Meetings
    • Event Logs
      • Create a Meeting Log Event
      • Read Meeting Events
    • Iotum
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • Create a Meeting with Id
    • Create a Meeting
    • Read Meeting
    • Count Domains Meetings
    • Count Meeting
    • Register Meeting
    • Update a Meeting
    • Delete a Meeting
    • Request a Meeting ID
    • Read Meetings for User
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Read a Specific Configuration Definition
      • Create a Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (Multipart/Mixed Post)
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Update Template from Upload (Multipart/Mixed Post)
    • Update Template from Upload (JSON + Base64 File)
  • Timeframes
    • Domain (Shared)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • Read SSL certificates for CertManager
    • Read SSL certificate by Common Name
    • Create SSL certificate for CertManager
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  1. CDR (Call History)

Search CDRs for Domain

GET
/domains/{domain}/cdrsHASHHACK2
Last modified:2023-12-21 20:52:14

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
domain
string 
required
Example:
{{domain}}
Query Params
datetime-start
string 
required
Example:
2023-11-27T13:00:00Z[US/Pacific]
datetime-end
string 
required
Example:
2023-11-27T13:00:00Z[US/Pacific]
dialled
string 
optional
The dialed number for the call. Can be a paritial match.
caller
string 
optional
The callerid number for the call. Can be a paritial match.
site
string 
optional
Use if wanting to seach for calls in a certain "site".
group
string 
optional
Use if wanting to seach for calls in a certain "department".

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/cdrsHASHHACK2?datetime-start=2023-11-27T13:00:00Z[US/Pacific]&datetime-end=2023-11-27T13:00:00Z[US/Pacific]&dialled=&caller=&site=&group='

Responses

🟢200OK
application/json
Body
array of:
id
string 
required
domain
string 
required
reseller
string 
required
call-account-code
string  | null 
required
call-answer-datetime
string 
required
call-audio-codec
string 
required
call-audio-relay-side-a-local-port
integer 
required
call-audio-relay-side-a-packet-count
integer 
required
call-audio-relay-side-a-remote-ip
string 
required
call-audio-relay-side-b-packet-count
integer 
required
call-audio-relay-side-b-remote-ip
string 
required
call-batch-answer-datetime
string 
required
call-batch-on-hold-duration-seconds
integer 
required
call-batch-sequence-marker
string 
required
call-batch-start-datetime
string 
required
call-batch-total-duration-seconds
integer 
required
call-direction
integer 
required
call-disconnect-datetime
string 
required
call-disconnect-reason-text
string 
required
call-disposition
null 
required
call-disposition-notes
null 
required
call-disposition-reason
null 
required
call-disposition-submitted-datetime
null 
required
call-disposition-type
null 
required
call-fax-codec
null 
required
call-fax-relay-side-a-local-port
null 
required
call-fax-relay-side-a-packet-count
null 
required
call-fax-relay-side-a-remote-ip
null 
required
call-fax-relay-side-b-packet-count
null 
required
call-fax-relay-side-b-remote-ip
null 
required
call-intelligence-job-id
string 
required
call-intelligence-percent-negative
string 
required
call-intelligence-percent-neutral
string 
required
call-intelligence-percent-positive
string 
required
call-intelligence-topics-top
string 
required
call-leg-ordinal-index
integer 
required
call-on-hold-duration-seconds
integer 
required
call-orig-call-id
string 
required
call-orig-caller-id
integer 
required
call-orig-department
string 
required
call-orig-domain
string 
required
call-orig-from-host
string 
required
call-orig-from-name
string 
required
call-orig-from-uri
string 
required
call-orig-from-user
string 
required
call-orig-ip-address
string 
required
call-orig-match-uri
string 
required
call-orig-pre-routing-uri
string 
required
call-orig-request-host
string 
required
call-orig-request-uri
string 
required
call-orig-request-user
string 
required
call-orig-reseller
string 
required
call-orig-site
string 
required
call-orig-to-host
string 
required
call-orig-to-uri
string 
required
call-orig-to-user
string 
required
call-orig-user
integer 
required
call-parent-call-id
string 
required
call-parent-cdr-id
string 
required
call-record-creation-datetime
null 
required
call-ringing-datetime
null 
required
call-routing-class
integer 
required
call-routing-match-uri
string 
required
call-start-datetime
string 
required
call-tag
string 
required
call-talking-duration-seconds
integer 
required
call-term-call-id
string 
required
call-term-caller-id
string 
required
call-term-department
null 
required
call-term-domain
string 
required
call-term-ip-address
string 
required
call-term-match-uri
string 
required
call-term-pre-reouting-uri
string 
required
call-term-reseller
null 
required
call-term-site
null 
required
call-term-to-uri
string 
required
call-term-user
null 
required
call-through-action
string 
required
call-through-call-id
null 
required
call-through-caller-id
null 
required
call-through-department
null 
required
call-through-domain
null 
required
call-through-reseller
null 
required
call-through-site
null 
required
call-through-uri
null 
required
call-through-user
null 
required
call-total-duration-seconds
integer 
required
call-video-codec
null 
required
call-video-relay-side-a-local-port
null 
required
call-video-relay-side-a-packet-count
null 
required
call-video-relay-side-a-remote-ip
null 
required
call-video-relay-side-b-packet-count
null 
required
call-video-relay-side-b-remote-ip
null 
required
call-server-mac-address
string 
required
core-server
string 
required
hide-from-results
integer 
required
is-trace-expected
boolean 
required
prefilled-trace-api
string 
required
prefilled-transcription-api
string 
required
Example
[
  {
    "id": "string",
    "domain": "string",
    "reseller": "string",
    "call-account-code": "string",
    "call-answer-datetime": "string",
    "call-audio-codec": "string",
    "call-audio-relay-side-a-local-port": 0,
    "call-audio-relay-side-a-packet-count": 0,
    "call-audio-relay-side-a-remote-ip": "string",
    "call-audio-relay-side-b-packet-count": 0,
    "call-audio-relay-side-b-remote-ip": "string",
    "call-batch-answer-datetime": "string",
    "call-batch-on-hold-duration-seconds": 0,
    "call-batch-sequence-marker": "string",
    "call-batch-start-datetime": "string",
    "call-batch-total-duration-seconds": 0,
    "call-direction": 0,
    "call-disconnect-datetime": "string",
    "call-disconnect-reason-text": "string",
    "call-disposition": null,
    "call-disposition-notes": null,
    "call-disposition-reason": null,
    "call-disposition-submitted-datetime": null,
    "call-disposition-type": null,
    "call-fax-codec": null,
    "call-fax-relay-side-a-local-port": null,
    "call-fax-relay-side-a-packet-count": null,
    "call-fax-relay-side-a-remote-ip": null,
    "call-fax-relay-side-b-packet-count": null,
    "call-fax-relay-side-b-remote-ip": null,
    "call-intelligence-job-id": "string",
    "call-intelligence-percent-negative": "string",
    "call-intelligence-percent-neutral": "string",
    "call-intelligence-percent-positive": "string",
    "call-intelligence-topics-top": "string",
    "call-leg-ordinal-index": 0,
    "call-on-hold-duration-seconds": 0,
    "call-orig-call-id": "string",
    "call-orig-caller-id": 0,
    "call-orig-department": "string",
    "call-orig-domain": "string",
    "call-orig-from-host": "string",
    "call-orig-from-name": "string",
    "call-orig-from-uri": "string",
    "call-orig-from-user": "string",
    "call-orig-ip-address": "string",
    "call-orig-match-uri": "string",
    "call-orig-pre-routing-uri": "string",
    "call-orig-request-host": "string",
    "call-orig-request-uri": "string",
    "call-orig-request-user": "string",
    "call-orig-reseller": "string",
    "call-orig-site": "string",
    "call-orig-to-host": "string",
    "call-orig-to-uri": "string",
    "call-orig-to-user": "string",
    "call-orig-user": 0,
    "call-parent-call-id": "string",
    "call-parent-cdr-id": "string",
    "call-record-creation-datetime": null,
    "call-ringing-datetime": null,
    "call-routing-class": 0,
    "call-routing-match-uri": "string",
    "call-start-datetime": "string",
    "call-tag": "string",
    "call-talking-duration-seconds": 0,
    "call-term-call-id": "string",
    "call-term-caller-id": "string",
    "call-term-department": null,
    "call-term-domain": "string",
    "call-term-ip-address": "string",
    "call-term-match-uri": "string",
    "call-term-pre-reouting-uri": "string",
    "call-term-reseller": null,
    "call-term-site": null,
    "call-term-to-uri": "string",
    "call-term-user": null,
    "call-through-action": "string",
    "call-through-call-id": null,
    "call-through-caller-id": null,
    "call-through-department": null,
    "call-through-domain": null,
    "call-through-reseller": null,
    "call-through-site": null,
    "call-through-uri": null,
    "call-through-user": null,
    "call-total-duration-seconds": 0,
    "call-video-codec": null,
    "call-video-relay-side-a-local-port": null,
    "call-video-relay-side-a-packet-count": null,
    "call-video-relay-side-a-remote-ip": null,
    "call-video-relay-side-b-packet-count": null,
    "call-video-relay-side-b-remote-ip": null,
    "call-server-mac-address": "string",
    "core-server": "string",
    "hide-from-results": 0,
    "is-trace-expected": true,
    "prefilled-trace-api": "string",
    "prefilled-transcription-api": "string"
  }
]
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:52:14
Previous
Read CDRs for Specific User
Next
Read CDRs for Site in Domain
Built with