Accessing CDRs and Recordings
This guide outlines how to leverage the PortSIP REST API to interact with Call Detail Records (CDRs) and call recordings.
Authentication Requirement
Before making any API requests, you must successfully authenticate and obtain an access token. This token serves as a security credential to authorize your interactions with the PortSIP REST API.
Permission Restrictions
Access to CDRs and recordings is restricted based on user roles within a tenant:
Admin or Queue Manager: Users with these roles can access CDRs and recordings at the tenant level, meaning they can view data for all users within the tenant.
Regular Users: Regular users can only access their own CDRs and recordings, limiting their visibility to personal call data.
Retrieve CDR
POST
/api/cdrs
Retrieve the CDRs at the tenant level using the specified query parameters.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Query Options
You can specify the query options as the URL parameters to filter the CDR, more details please see Query Options Overview.
Response
Retrieve Call Recordings
POST
/api/recordings
Retrieve the call recordings at the tenant level using the specified query parameters.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Query Options
You can specify the query options as the URL parameters to filter the CDR, more details please see Query Options Overview.
Response
Retrieve Recordings Information
POST
/api/recordings/{id}
This API endpoint allows you to fetch detailed information about a specific recording based on its unique identifier.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Query Options
Specify the recording ID which you parsed from the response of Retrieve Call Records as the URL path.
Response
Download a Recording File
GET
/api/blobs/rZTOS5yB5elnATSbfxd_pgAQQKn01i8M
Once you have retrieved the recording information, the response will contain a file_url
property. Use this URL to directly download the recording file. No additional authentication (e.g., access token) is required for this download request.
Simply make a GET request to the specified file_url
to initiate the download. The recording file will be available for download at the provided location.
Last updated