{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Voice Recording API V3 - Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"voice-recording-api-v3---developer-guide","__idx":0},"children":["Voice Recording API V3 - Developer Guide"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Voice Recording"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/voice/recording?caseNumber={caseNumber}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Voice Recording Stream"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/voice/recording/stream?recordingId={recordingId}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-url-and-environment","__idx":2},"children":["2. Base URL and environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls are sent to:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the Voice Recording resources in production are:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/voice/recording\nhttps://api3.sprinklr.com/{env}/api/v3/voice/recording/stream\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", etc.)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":3},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key"},"children":["Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {token}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential used by the API to authenticate a user with the server."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api-key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key used to authenticate the application with the server."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Content-Type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the media type associated with the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the acceptable response type from the server."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-api-operations","__idx":4},"children":["4. API operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-fetch-a-voice-recording","__idx":5},"children":["4.1 Fetch a voice recording"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/voice/recording?caseNumber={caseNumber}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this API to fetch voice recording information associated with a case."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":6},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["caseNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique case number for which voice recording information is fetched."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":7},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/voice/recording?caseNumber={caseNumber}' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developer note:"]}," The response body contains the requested recording stream bytes and can be directly played or downloaded by supported clients."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-fetch-a-voice-recording-stream","__idx":8},"children":["4.2 Fetch a voice recording stream"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/voice/recording/stream?recordingId={recordingId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this API to fetch the audio stream for a voice recording by its unique identifier."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-1","__idx":9},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["recordingId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the voice recording stream to fetch."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-1","__idx":10},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/voice/recording/stream?recordingId={recordingId}' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developer note:"]}," The response body contains the requested recording stream bytes and can be directly played or downloaded by supported clients."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5-use-cases","__idx":11},"children":["5. Use cases"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"51-retrieve-voice-recordings-associated-with-a-case","__idx":12},"children":["5.1 Retrieve voice recordings associated with a case"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Voice Recording"]}," API to retrieve voice recording information associated with a specific case."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is useful when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An application needs to retrieve the voice recordings associated with a customer case."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A case contains one or more recorded calls that need to be accessed programmatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Voice recordings need to be associated with the corresponding case as part of an integration workflow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An application needs to retrieve recordings for subsequent playback or download."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The case is identified using its unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseNumber"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording?caseNumber={caseNumber}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"52-retrieve-the-audio-stream-for-a-specific-voice-recording","__idx":13},"children":["5.2 Retrieve the audio stream for a specific voice recording"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Voice Recording Stream"]}," API to retrieve the audio stream for a specific recording using its unique identifier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is useful when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A user or application needs to play a specific voice recording."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A voice recording needs to be downloaded by a supported client."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An integration needs to retrieve recording stream bytes for subsequent processing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A specific recording needs to be accessed independently using its recording identifier."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The recording is identified using its unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordingId"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording/stream?recordingId={recordingId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"53-play-a-voice-recording-in-a-supported-client","__idx":14},"children":["5.3 Play a voice recording in a supported client"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Voice Recording Stream"]}," API when an application needs to provide playback of a voice recording."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is useful when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A client application needs to provide playback of a recorded voice interaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An authorized user needs to listen to a recording associated with an interaction."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recording playback needs to be incorporated into a case or interaction workflow."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API response contains the requested recording stream bytes, which can be played directly by supported clients."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording/stream?recordingId={recordingId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"54-download-a-voice-recording","__idx":15},"children":["5.4 Download a voice recording"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Voice Recording Stream"]}," API when the audio for a specific recording needs to be downloaded."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is useful when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A supported client needs to download the audio associated with a voice recording."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An integration needs to retrieve recording bytes for downstream processing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A recording needs to be accessed programmatically rather than through a public recording URL."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Recording URLs are non-public, so the recording must be accessed through the API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording/stream?recordingId={recordingId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"55-retrieve-recordings-as-part-of-a-case-based-workflow","__idx":16},"children":["5.5 Retrieve recordings as part of a case-based workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A typical workflow can include:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identify the case using its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseNumber"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch the recordings associated with the case"]}," using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording?caseNumber={caseNumber}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identify the required recording and obtain its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordingId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch the recording stream"]}," using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording/stream?recordingId={recordingId}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the returned recording stream bytes for playback or download in a supported client."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-migration-from-v2-to-v3","__idx":17},"children":["6. Migration from V2 to V3"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The recording download operation has moved to a new path in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3"]},", and a new case-level operation has been added. Below is a comparison of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 vs V3 endpoints and behavior"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operation"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key Differences"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Differences"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download a recording by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/voice/recording?recordingId={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording/stream?recordingId={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The path gains a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/stream"]}," segment. The parameter name, position and value are unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch recordings for a case"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Not supported in V2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/voice/recording?caseNumber={n}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Newly supported in V3. Returns an array, one entry per recorded call on the case."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"important-the-path-voicerecording-exists-in-both-versions-and-means-something-different-in-each","__idx":18},"children":["Important: the path ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/voice/recording"]}," exists in both versions and means something different in each"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Version"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"/voice/recording means"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/voice/recording"]}," means"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Keyed by"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Keyed by"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download a recording"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordingId"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List a case's recordings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caseNumber"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A client migrated by changing only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v2"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v3"]}," in the base URL will call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/voice/recording?recordingId={id}"]},". That request is syntactically valid and reaches a real endpoint, but ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordingId"]}," is not a parameter of the V3 operation and is ignored."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update the path by hand in every recording download call."]}," There is no safe mechanical rewrite."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-stays-the-same","__idx":19},"children":["What stays the same"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Aspect"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Aspect"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Behavior"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Host"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/..."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication headers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]}," path segment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retained in V3"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordingId"]}," format and meaning"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged. Still the message ID of the voice message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Restricted URL model"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recording URLs remain non-public; the API is still the only access route"]}]}]}]}]}]},"headings":[{"value":"Voice Recording API V3 - Developer Guide","id":"voice-recording-api-v3---developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"2. Base URL and environment","id":"2-base-url-and-environment","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. API operations","id":"4-api-operations","depth":2},{"value":"4.1 Fetch a voice recording","id":"41-fetch-a-voice-recording","depth":3},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Example request","id":"example-request","depth":4},{"value":"4.2 Fetch a voice recording stream","id":"42-fetch-a-voice-recording-stream","depth":3},{"value":"Query parameters","id":"query-parameters-1","depth":4},{"value":"Example request","id":"example-request-1","depth":4},{"value":"5. Use cases","id":"5-use-cases","depth":3},{"value":"5.1 Retrieve voice recordings associated with a case","id":"51-retrieve-voice-recordings-associated-with-a-case","depth":4},{"value":"5.2 Retrieve the audio stream for a specific voice recording","id":"52-retrieve-the-audio-stream-for-a-specific-voice-recording","depth":4},{"value":"5.3 Play a voice recording in a supported client","id":"53-play-a-voice-recording-in-a-supported-client","depth":4},{"value":"5.4 Download a voice recording","id":"54-download-a-voice-recording","depth":4},{"value":"5.5 Retrieve recordings as part of a case-based workflow","id":"55-retrieve-recordings-as-part-of-a-case-based-workflow","depth":4},{"value":"6. Migration from V2 to V3","id":"6-migration-from-v2-to-v3","depth":2},{"value":"Important: the path /voice/recording exists in both versions and means something different in each","id":"important-the-path-voicerecording-exists-in-both-versions-and-means-something-different-in-each","depth":4},{"value":"What stays the same","id":"what-stays-the-same","depth":3}],"frontmatter":{"seo":{"title":"Voice Recording API V3 - Developer Guide"}},"lastModified":"2026-11-20T08:03:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/voice/voice-recordings-v3","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}