POST Recording

Upload a recording audio file coming from any external source.

Mono/Stereo recordings upload

If the source recording audio file is Stereo, then you can keep the same format within Imagicle Call Recording by applying the following setting, accessible only through a RDP session to the Imagicle on-prem instance. In case of an Imagicle UCX Cloud Suite, please contact Imagicle Support for help.

Procedure

• Locate and edit the following file: \StonevoiceAS\Apps\Recorder\Settings\Recorder.defaults
• Add this line: EnableSpeechAnalyticsOptimization=1
• Save file and restart Imagicle Call Recording service

This setting is mostly important if you are leveraging Imagicle Voice Analytics application, to separate local/remote party call segments during transcription.

Resource URL

POST /fw/Apps/Recorder/WebAPI/Recordings

Resource Information

• Request Content-Type: application/json
• Request Content-Disposition: form-data; name=jsondata
• Requires authentication: No

Request body

The request body is a multipart/form-data containing a part that describes the recording information and a part as the audio track attachment you want to import.
The supported audio formats are: PCM-8/16, A-Law, u-Law, MPEG Layer III audio (MP3).

The maximum audio file size is 256 MBytes.

Recording metadata

Local party

Remote party

Direction

Responses

HTTP 201 Created

• Returns the ID of the imported recording

Error response

HTTP 400 Bad request

• Given recording data are not valid

Reasons

HTTP 401 Unauthorized

• Anonymous requesting user
• Wrong credentials

HTTP 403 Forbidden

• The user has not enough privileges

HTTP 409 Conflict

• The recording start date is out of the retention period

HTTP 500 Internal Server Error

• An internal server error occurs while importing the recording

HTTP 501 Not Implemented

• Call Recording license is not valid

Examples

POST    http://<IPAddress>/fw/Apps/Recorder/WebAPI/Recordings

Request body to import a Wave audio file

--8d0d51ed-3539-48fa-a239-fb4ee91b3b99
Content-Type: multipart/form-data
Content-Disposition: form-data; name=jsondata

{
    "direction":  2,
    "localParty":  {
                       "phoneNumber":  "376",
                       "username":  "giuliano"
                   },
    "pbxCallId":  "1",
    "preserved":  true,
    "duration":  "PT1M30S",
    "notes":  "text describing recording content",
    "startDateTime":  "2018-09-25T13:00:00.0000000Z",
    "remoteParty":  {
                        "phoneNumber":  "123456"
                    }
}

--8d0d51ed-3539-48fa-a239-fb4ee91b3b99
Content-Type: audio/wave
Content-Disposition: form-data; name=attachment; filename=sample.wav; filename*=utf-8''sample.wav

audio track bytes  
--8d0d51ed-3539-48fa-a239-fb4ee91b3b99--

Response

{"id":"f20850dd-6074-4c9f-8973-24381962ac6f"}

Request body to import an MP3 audio file

--8d0d51ed-3539-48fa-a239-fb4ee91b3b99
Content-Type: multipart/form-data
Content-Disposition: form-data; name=jsondata

{
    "direction":  2,
    "localParty":  {
                       "phoneNumber":  "1234",
                       "username":  "test"
                   },
    "pbxCallId":  "1",
    "preserved":  true,
    "duration":  "PT1M30S",
    "notes":  "text describing recording content",
    "startDateTime":  "2024-09-26T11:00:00.0000000Z",
    "remoteParty":  {
                        "phoneNumber":  "11111"
                    }
}

--8d0d51ed-3539-48fa-a239-fb4ee91b3b99
Content-Type: audio/mpeg
Content-Disposition: form-data; name=attachment; filename=sample.mp3; filename*=utf-8''sample.mp3

audio track bytes  
--8d0d51ed-3539-48fa-a239-fb4ee91b3b99--

Response

{"id":"f20850dd-6074-4c9f-8973-24381962ac6f"}