Knowlege base

Start Recording

Article ID: 533
Last updated: 30 Jan, 2019

Start recording a connected call on the line identified by the device name and/or the directory number.

Resource URL

POST fw/Apps/Recorder/WebAPI/LiveRecordings

Resource Information

  • Request Content-Type: application/json
  • Response Content-Type: application/json
  • Requires authentication: Yes
  • Minimum authorization level: Call Recording lv.10

URL Parameters

None

Request body

The request body is an application/json object with the following model:

StartRecording
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
RecordingMode
Value Description
0 Cisco Media Forking
1 Dial-In

Response

201 Created

The call is being recorded

Response body
Name Type Description
id string The identifier of the recording you just started

Error response

400 Bad Request

The request contains some errors

Response body
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.
BadRequestReason
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

401 Unauthorized

No authentication provided or wrong user credentials

403 Forbidden

The call cannot be recorded due to user authorization issues or to the restrictions set on the Imagicle Call Recording Service

Response body
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.
ForbiddenReason
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

409 Conflict

The call cannot be recorded due to the current status of the Imagicle Call Recording service

Response body
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)
ConflictReason
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

429 Too Many Requests

The request has already been received

Response body
Name Type Description
reason TooManyRequestsReason The reason why the request has been rejected
TooManyRequestsReason
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

500 Internal Server Error

An error occurred while processing the request

501 Not Implemented

The call cannot be recorded due to a misconfiguration of the Imagicle Call Recording service

Response body
Name Type Description
reason NotImplementedReason The reason why the request has been rejected
NotImplementedReason
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)

503 Service Unavailable

The call cannot be recorded because all licensed channels are being used

504 Gateway Timeout

Imagicle Call Recording service is unavailable

Examples

Successful request

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:


{
    "deviceName": "SEP123456789ABC"
}

The response status is 201 Created, and its body is:


{
    "id": "6b98303a-b295-473a-adae-19b78aca468d"
}

Request failure

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:


{
    "deviceName": "SEP123456789ABC",
    "directoryNumber": "101",
    "mode": 1
}

The response status is 429 TooManyRequests, and its body is:


{
    "reason": 1
}

Article ID: 533
Last updated: 30 Jan, 2019
Revision: 12
Views: 1112
Print Export to PDF Subscribe Share
Prev   Next
Overview     Stop Recording