Overview

Overview
Rest API V2.1

SSL ONLY

We require that all requests are performed over SSL.
 

AUTHENTICATION

Authentication is required with every API call.

We use the Basic-Auth scheme
Set the “Authorization” header as base64 encoded <username>@<domain>:<password>
The domain can either be provided as your full domain e.g. mycompany.calln.com or just mycompany.
Example;-
If you want to authorize as john@mycompany:mypassword
Authorization: Basic am9obkBteWNvbXBhbnk6bXlwYXNzd29yZA==

RESULT SETS

By default, all results are returned in the JSON format. If you want to change this to XML, you can include an ‘Accept’ Header.
Example;-
Accept: application/json
or
Accept: text/xml

CALL

Call represents a single call that has been recorded and stored within the CallN hosted recording solution.
GET /api/callSearch for call(s) within the search criteria.
GET /api/call/{id}Returns detailed information for a single call.
PUT /api/call/{id}Update details for a single call. This may include notes, or rating.
DELETE /api/call/{id}Delete a single call.
POST /api/callUpload a call.

 


CALLAUDIO

CallAudio represents the audio recording attachment for a single call.
GET /api/callaudio/{id}Retrieve the audio recording for a single call.
PUT /api/callaudio/{id}Upload an audio recording for a single call.

 


RECORDINGNODE

RecordingNode represents a single recording point. e.g. a computer with the CallN software installed.
GET /api/recordingnodeSearch for recording node(s) within the search criteria.
GET /api/recordingnode/{machinesid}Returns detailed information for a single recording node.
PUT /api/recordingnode/{machinesid}Report a heartbeat from a client recording node.

 


HANDSET

Handset represents a single handset configured within the CallN hosted recording solution.
GET /api/handsetSearch for handset(s) within the search criteria.
GET /api/handset/{id}Returns detailed information for a single handset.
PUT /api/handset/{id}Update details for a single handset. This may include name or notes.
DELETE /api/handset/{id}Delete a single handset.

 


PING

Ping represents a heartbeat from the client computer.
Depreciated as of version 1.17.0 client
POST /api/pingUpload a ping.

 


DIAGNOSTICFILE

DiagnosticFile represents an upload of a diagnostic file.
PUT /api/diagnosticfileUpload a diagnostic file.

Calculate your CallN Costs in 60 Seconds

  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • After you sign up, this will be used for your Calln domain.
  • A Team member will contact you on this number.
  • A summary of your calculations will be sent to this email address.
  • You may review our terms and conditions and privacy policies by clicking on the links above.