Download Audio File API
This API allows downloading of audio files for the given session ID. The redacted audio file can be downloaded.
Endpoint
Method: GET
URL: https://<<Hostname>>/uzng-gateway/v1/audio/download?sessionId={sessionId}?redaction=true
curl --location 'https://<<hostname>>/uzng-gateway/v1/audio/download?sessionId=d7ac1059-4395-8674-8ef5671eaa4c&redaction=true' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiMTViYjEwN2UtMGM1Yi00NGJlLTg0ZTEtNWYyNzYxMTE1ODNhIiwiaXNzIjoiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tLyIsInN1YiI6InRKYXZQUlcyYWlNcVBYdlluNXhVM3VuNGh4QjhVTlVSQGNsaWVudHMiLCJhdWQiOiJhcGkudW5pcGhvcmUuY29tIiwiaWF0IjoxNzIwNzU3NTI1LCJleHAiOjE3MjA4NDM5MjUsInNjb3BlIjoicmVhZDp0ZW5hbnRzIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwiYXpwIjoidEphdlBSVzJhaU1xUFh2WW41eFUzdW40aHhCOFVOVVIiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOnRlbmFudHMiXX0.tKazb8VoMCWkpgx1t9g52LTIbQV3WnBFR0xHm5k8egaNEpMvukyIOPXI161wY’Header Parameter
Authorization - Bearer <Token>
Note
To obtain an authorization token, click here.
Query Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
sessionId | String | Unique ID of the conversation provided by the organization/customer, using which the conversation audio file (recordings) can be downloaded. | Required |
redaction | Boolean | If you wish to redact the PCI data from the conversation audio file, then set redaction to True. By default, redaction is set to True. | Optional |
Important
In Postman, after entering the Query parameter, select Save and Download.
Sample Response
An audio file will be downloaded, which can be saved either as a .wav or an MP3 file, as per the configuration set in their system. If no configuration is set, the Save As dialog appears, where you can give a name and a file format (.wav or .mp3) of your choice.
Response and Error Codes
Response Code | Condition | Message | Description |
|---|---|---|---|
200 | OK | Data fetched successfully. | The audio file was downloaded successfully. |
204 | No Content | No Data Found | Ensure the correct session ID is passed. |
400 | Invalid Request Body | NA | Check whether the response parameters are correct. |
401 | UnAuthorized | NA | Invalid token or invalid signature received for JSON Web Token validation. |
500 | Internal Server Error | NA | The server encountered an unexpected error that prevented it from fulfilling the request. Retry after some time. |