Start recording a connected call on the line identified by the device name and/or the directory number.
POST fw/Apps/Recorder/WebAPI/LiveRecordings
None
The request body is an application/json object with the following model:
Name | Type | Required | Description | Default | Example |
---|---|---|---|---|---|
deviceName | string | Yes, if directoryNumber is not specified | The device you want to record (there must be a connected call on it). If directoryNumber is specified too, the call on the device will be recorded only if it belongs to the given line | null | "SEP123456789ABC" |
directoryNumber | string | Yes, if deviceName is not specified | The line you want to record (there must be a connected call on it). If deviceName is specified too, the call on the line will be recorded only if it belongs to the given device | null | "101" |
mode | RecordingMode | No | The recording mode you want to use. | 0 | 0 |
Value | Description |
---|---|
0 | Cisco Media Forking |
1 | Dial-In |
The call is being recorded
Name | Type | Description |
---|---|---|
id | string | The identifier of the recording you just started |
The request contains some errors
Name | Type | Description |
---|---|---|
reason | BadRequestReason | The reason why the request has been rejected |
deviceName | string | The name of the device that cannot be monitored through TAPI. Present only if reason=1. |
Value | Descritpion |
---|---|
0 | The request body contains neither the device name nor the directory number |
1 | The line identified by given device name and/or directory number does not exist or isn't monitorable through TAPI |
2 | Invalid recording mode |
4 | The device is not configured to manually start recording a call |
No authentication provided or wrong user credentials
The call cannot be recorded due to user authorization issues or to the restrictions set on the Imagicle Call Recording Service
Name | Type | Description |
---|---|---|
reason | ForbiddenReason | The reason why the request has been rejected |
username | string | The username associated to the call is not authorized to record. Present only if reason=1. |
Value | Description |
---|---|
0 | Authenticated user is unauthorized |
1 | The user associated to the call is not authorized to record |
2 | The call direction doesn't match the filter set on the Imagicle Call Recording service |
3 | The call traffic type doesn't match the filter set on the Imagicle Call Recording service |
4 | Remote party is in the blacklist set on the Imagicle Call Recording service |
The call cannot be recorded due to the current status of the Imagicle Call Recording service
Name | Type | Description |
---|---|---|
reason | ConflictReason | The reason why the request has been rejected |
extension | string | Directory number of the line having a connected call but no user associated (may be null if no such line has been found) |
Value | Descritpion |
---|---|
0 | The call connected on given device is on a line with no IAS user associated to it |
1 | There is no connected call on given device |
The request has already been received
Name | Type | Description |
---|---|---|
reason | TooManyRequestsReason | The reason why the request has been rejected |
Value | Descritpion |
---|---|
0 | Another recording request has already been received for this call (the recording has not started yet) |
1 | The call is already being recorded |
An error occurred while processing the request
The call cannot be recorded due to a misconfiguration of the Imagicle Call Recording service
Name | Type | Description |
---|---|---|
reason | NotImplementedReason | The reason why the request has been rejected |
Value | Description |
---|---|
0 | Invalid Imagicle Call Recording license |
1 | No recording pilot has been configured on the Imagicle Call Recording service |
2 | Configured recording pilot doesn't route calls to the Imagicle Call Recording service (if mode is DialIn), or something is not correctly configured on CUCM side (if mode is MediaForking) |
The call cannot be recorded because all licensed channels are being used
Imagicle Call Recording service is unavailable
In this example we start recording a connected call on the device "SEP123456789ABC" using Cisco Media Forking:
POST fw/Apps/Recorder/WebAPI/LiveRecordings
Request body:
The response status is 201 Created, and its body is:
In this example we try to start recording a connected call on the device "SEP123456789ABC" for the directory number "101" using Dial-In, but the call is already being recorded:
POST fw/Apps/Recorder/WebAPI/LiveRecordings
Request body:
The response status is 429 TooManyRequests, and its body is: