Recording Link

Use the RingQ API Web Hook to retrieve a direct download link for a specific call recording — integrate call recordings into your CRM, helpdesk, or reporting tools.

The Recording Link web hook returns a direct URL to download a specific call recording from RingQ. Use this to attach call recordings to CRM records, helpdesk tickets, or reporting dashboards automatically.

Prerequisites

Before you begin, you need your API Key from the RingQ admin dashboard.

1. Log in to the RingQ admin dashboard.
2. Go to Settings → API.
3. Copy the API Key shown on this page. You will use it in every web hook URL.

API URL Format

https://{your-ringq-domain}/api/v2/{api-key}/recordinglink/{call-id}

Parameter	Description
your-ringq-domain	The domain or IP address of your RingQ instance (e.g. pbx.yourdomain.com).
api-key	Your API key from Settings → API.
call-id	The unique ID of the call whose recording you want to retrieve. This is returned in call events or can be found in the call log.

Example

To retrieve the recording link for call ID cdr_20240315_101_abc123:

https://pbx.yourdomain.com/api/v2/abc123xyz/recordinglink/cdr_20240315_101_abc123

Response

A successful request returns HTTP 200 with a JSON body containing the recording URL:

{
  "result": "success",
  "url": "https://pbx.yourdomain.com/recordings/2024/03/15/cdr_20240315_101_abc123.mp3"
}

You can use the returned url to stream or download the recording directly.

Finding the Call ID

The call ID is available in two places:

• Call Logs: In the RingQ admin dashboard under Reports → Call Logs, click on any call to view its details including the Call ID.
• Event Webhooks: If you have RingQ event webhooks configured, the call ID is included in the call start and call end event payloads.

Combine the Recording Link web hook with a call event webhook to automatically attach recordings to CRM records the moment a call ends.