The Voice Recording APIs enable you to fetch voice recording information associated with a case and retrieve the audio stream for a voice recording using its unique identifier.
| Operation | Method | Endpoint |
|---|---|---|
| Fetch Voice Recording | GET | /api/v3/voice/recording?caseNumber={caseNumber} |
| Fetch Voice Recording Stream | GET | /api/v3/voice/recording/stream?recordingId={recordingId} |
All API calls are sent to:
https://api3.sprinklr.com/{env}/api/v3So the Voice Recording resources in production are:
https://api3.sprinklr.com/{env}/api/v3/voice/recording
https://api3.sprinklr.com/{env}/api/v3/voice/recording/streamReplace {env} with your assigned environment identifier (prod0, prod2, prod11, etc.).
API headers include the mandatory information sent with the request URL. This information provides the request context and authorisation credentials required to access protected resources.
| Key | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Credential used by the API to authenticate a user with the server. |
| Key | api-key | API key used to authenticate the application with the server. |
| Content-Type | application/json | Determines the media type associated with the request. |
| Accept | application/json | Determines the acceptable response type from the server. |
GET /api/v3/voice/recording?caseNumber={caseNumber}
Use this API to fetch voice recording information associated with a case.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| caseNumber | Required | Unique case number for which voice recording information is fetched. | String |
curl -X GET \
'https://api3.sprinklr.com/{env}/api/v3/voice/recording?caseNumber={caseNumber}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'Developer note: The response body contains the requested recording stream bytes and can be directly played or downloaded by supported clients.
GET /api/v3/voice/recording/stream?recordingId={recordingId}
Use this API to fetch the audio stream for a voice recording by its unique identifier.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| recordingId | Required | Unique identifier of the voice recording stream to fetch. | String |
curl -X GET \
'https://api3.sprinklr.com/{env}/api/v3/voice/recording/stream?recordingId={recordingId}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'Developer note: The response body contains the requested recording stream bytes and can be directly played or downloaded by supported clients.
The Voice Recording APIs can be used to retrieve voice recordings associated with a case and access the audio stream of a specific recording. The following are common use cases.
Use the Fetch Voice Recording API to retrieve voice recording information associated with a specific case.
This is useful when:
- An application needs to retrieve the voice recordings associated with a customer case.
- A case contains one or more recorded calls that need to be accessed programmatically.
- Voice recordings need to be associated with the corresponding case as part of an integration workflow.
- An application needs to retrieve recordings for subsequent playback or download.
The case is identified using its unique caseNumber.
API: GET /api/v3/voice/recording?caseNumber={caseNumber}
Use the Fetch Voice Recording Stream API to retrieve the audio stream for a specific recording using its unique identifier.
This is useful when:
- A user or application needs to play a specific voice recording.
- A voice recording needs to be downloaded by a supported client.
- An integration needs to retrieve recording stream bytes for subsequent processing.
- A specific recording needs to be accessed independently using its recording identifier.
The recording is identified using its unique recordingId.
API: GET /api/v3/voice/recording/stream?recordingId={recordingId}
Use the Fetch Voice Recording Stream API when an application needs to provide playback of a voice recording.
This is useful when:
- A client application needs to provide playback of a recorded voice interaction.
- An authorized user needs to listen to a recording associated with an interaction.
- Recording playback needs to be incorporated into a case or interaction workflow.
The API response contains the requested recording stream bytes, which can be played directly by supported clients.
API: GET /api/v3/voice/recording/stream?recordingId={recordingId}
Use the Fetch Voice Recording Stream API when the audio for a specific recording needs to be downloaded.
This is useful when:
- A supported client needs to download the audio associated with a voice recording.
- An integration needs to retrieve recording bytes for downstream processing.
- A recording needs to be accessed programmatically rather than through a public recording URL.
Recording URLs are non-public, so the recording must be accessed through the API.
API: GET /api/v3/voice/recording/stream?recordingId={recordingId}
The Voice Recording APIs can be used together to retrieve recordings associated with a case and subsequently access the audio stream for an individual recording.
A typical workflow can include:
- Identify the case using its
caseNumber. - Fetch the recordings associated with the case using
GET /api/v3/voice/recording?caseNumber={caseNumber}. - Identify the required recording and obtain its
recordingId. - Fetch the recording stream using
GET /api/v3/voice/recording/stream?recordingId={recordingId}. - Use the returned recording stream bytes for playback or download in a supported client.
The recording download operation has moved to a new path in V3, and a new case-level operation has been added. Below is a comparison of V2 vs V3 endpoints and behavior:
| Operation | V2 Endpoint | V3 Endpoint | Key Differences |
|---|---|---|---|
| Download a recording by ID | GET /api/v2/voice/recording?recordingId={id} | GET /api/v3/voice/recording/stream?recordingId={id} | The path gains a /stream segment. The parameter name, position and value are unchanged. |
| Fetch recordings for a case | Not supported in V2 | GET /api/v3/voice/recording?caseNumber={n} | Newly supported in V3. Returns an array, one entry per recorded call on the case. |
| Version | /voice/recording means | Keyed by |
|---|---|---|
| V2 | Download a recording | recordingId |
| V3 | List a case's recordings | caseNumber |
A client migrated by changing only v2 to v3 in the base URL will call /api/v3/voice/recording?recordingId={id}. That request is syntactically valid and reaches a real endpoint, but recordingId is not a parameter of the V3 operation and is ignored.
Update the path by hand in every recording download call. There is no safe mechanical rewrite.
| Aspect | Behavior |
|---|---|
| Host | https://api3.sprinklr.com/{env}/... |
| Authentication headers | Authorization and Key |
voice path segment | Retained in V3 |
recordingId format and meaning | Unchanged. Still the message ID of the voice message |
| Restricted URL model | Recording URLs remain non-public; the API is still the only access route |