Add Audio Files for UVC
This API allows you to add an audio file for the UVC connector at tenant level. The uploaded audio file is stored in an AWS S3 bucket and played as a response from the UVC connector to the end user.
Endpoint
Method: POST
URL: https://<<hostname>>/cse/postAudioFilesUvc/tenantName/<<tenantname>>/connector/UVC
curl -X 'POST' \ 'https://<<hostname>>/cse/postAudioFilesUvc/tenantName/ussngdev/connector/UVC' \
-H 'accept: application/json' \
-H 'Environment-Name: Dev' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiYWRtaW4iLCJBY2NvdW50IEFkbWluaXN0cmF0b3IiLCJ1X2FkbWluaXN0cmF0b3IiLCJpbnRlcmFjdF9hY2NvdW50X2FkbWluIl0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9lbWFpbF9pZCI6Im11bmlzYW15QHVuaXBob3JlLmNvbSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9hdXRoMF9uYW1lIjoiTXVuaXNhbXkgTWFuaWNrYW0iLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9pZCI6ImF1dGgwfDY0MjkyOTExOTk2ODQ0NzlkMjZjMTcwZSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91cGRhdGVkX2F0IjoiMjAyNS0wNi0wMlQxNTozOTowOS4xMjRaIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3VzZXJfbWV0YWRhdGEiOnsiY2xpZW50X2lkIjoibXVuaXNhbXlAdW5pcGhvcmUuY29tIiwiZmlyc3ROYW1lIjoiTXVuaXNhbXkiLCJsYXN0TmFtZSI6Ik1hbmlja2FtIiwicmVzdHJpY3RQcm9kdWN0aW9uQWNjZXNzIjpmYWxzZSwidXBkYXRlZF9hdCI6IjE3NDc2NDgwNDg5NTYifSwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL3RlbmFudCI6IjZiNWIyMzY1LWQwZjItNDA1MC04YjA5LTliNTI3NTkzNDFkOSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS90ZW5hbnRfbmFtZSI6InVzc25nZGV2IiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL2NsdXN0ZXIiOiJ1cyIsImlzcyI6Imh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS8iLCJzdWIiOiJhdXRoMHw2NDI5MjkxMTk5Njg0NDc5ZDI2YzE3MGUiLCJhdWQiOlsiYXBpLnVuaXBob3JlLmNvbSIsImh0dHBzOi8vZGV2LWcyajVtdTJ6LnVzLmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE3NDg5MzIzNzcsImV4cCI6MTc0OTUzNzE3Nywic2NvcGUiOiJvcGVuaWQiLCJvcmdfaWQiOiJvcmdfU2NnenJUQzNoYnRoRlkxcSIsImF6cCI6InBkdEdoWGdCWkVyNlBzWDRZWFo0TnlMOXl2dnlrYUR4IiwicGVybWlzc2lvbnMiOlsiYXVkaXQtbG9nOnZpZXc6dWNhcHR1cmUiLCJjb25maWd1cmF0aW9uOnN5c3RlbTp1Y2FwdHVyZSIsImNyZWF0ZTp0ZW5hbnQ6bG9va2VyIiwiZGVsZXRlOnVzZXJzIiwiZGVzaWduOmJpOmxvb2tlciIsInBvbGljeTphY3RpdmF0ZTp1Y2FwdHVyZSIsInBvbGljeTpjcmVhdGU6dWNhcHR1cmUiLCJwb2xpY3k6ZGVhY3RpdmF0ZTp1Y2FwdHVyZSIsInJlYWQ6ZXhwZXJpZW5jZXMiLCJyZWFkOm9yZ0hpZXJhcmNoeSIsInJlYWQ6dWFzc2lzdCIsInJlY29yZGluZzpsb2NrOnVjYXB0dXJlICIsInJlY29yZGluZzpvbi1kZW1hbmQ6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy1saXZlOnVjYXB0dXJlIiwicmVjb3JkaW5nOnZpZXctbWV0YWRhdGE6dWNhcHR1cmUiLCJyZWNvcmRpbmc6dmlldy10cmFuc2NyaXB0OnVjYXB0dXJlIiwic2VhcmNoOnZpZXc6dWNhcHR1cmUiLCJ2aWV3OmJpOmxvb2tlciIsInZpZXc6b3JnLWhpZXJhcmNoeSIsIndyaXRlOmV4cGVyaWVuY2VzIiwid3JpdGU6dWFzc2lzdCJdfQ.HtoB6F2JU-oDfZ6jCW8c8neqDDjxG49eHdS25D-RSY-TlhjOixhoh3rDFxIB8ZKW_ogKPPubm6Wrchdv99KmXbRk1xDxhL13piew_nM6PWmXCXC1PpXL2AFF2Nsj19oKPGUaDZamXsCVl0yyy6zXu6ODHNWI0JDm2HmA-NCDY8mzhACeRJPL_C0FWLKy7DerSyJgWZxpEkLHYp5C_4gkJ4JLxunYsOigSPOnZpkE1kcUNHhj0__CrxrzrRz0RGCqqZcCL2odyDOsnanj2wvoFVcUPXfqvbjKdSXZ2CokqHjWJEBpEywUMHw' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@unityping.wav;type=audio/wav'Header Parameter
Authorization - <Bearer Token>
To learn more about Authorization, click here.
Parametr Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
Environment-Name | String | The name of the environment. | Required |
Path Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
tenantName | String | Name of the tenant. To know the tenantName, reach out to the U-Self Serve Engineering Team. | Required |
connector | String | Name of the connector that uses the audio file. Currently, UVC is set as the default value. | Required |
Request Parameter
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
File | File | Select the audio file to be uploaded. The audio file should be in 16 bit mono, pcm, wav format with a sample rate of 8000 Hz. | Required |
Sample Response
{
"errorBody": null,
"mediaResponse": {
"statusCode": 200,
"status": "success",
"mediaUrlSet": null,
"audioFileName": "unityping.wav"
}
}Response and Error Codes
Response Code | Condition |
|---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
500 | Internal Server Error |