System Call Recording

Display system’s call recording platforms

GET /api/v1/system/services/call_recording/platforms/

Retrieve the list of the call recording platforms in the system.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/system/services/call_recording/platforms/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "systemDefault": "Call Rec Platform 1",
      "callRecordingPlatforms": [
          {
              "name": "Call Rec Platform 1",
              "netAddress": "10.0.32.55",
              "port": 222,
              "mediaStream": "Dual",
              "transportProtocol": "UDP",
              "description": "test description",
              "schemaVersion": "1.0",
              "supportVideoRecording": false
          },
          {
              "name": "Call Rec Platform 2",
              "netAddress": "10.0.32.55",
              "port": 222,
              "mediaStream": "Dual",
              "transportProtocol": "UDP",
              "description": "test description",
              "schemaVersion": "1.0",
              "supportVideoRecording": false
          }
      ]
}
Response JSON Object:

  • systemDefault (string) – the system’s default call recording platform name.

  • callRecordingPlatforms (array) – the list of the call recording platforms as defined as Call Recording Platform attributes.

Status Codes:

Add a system’s call recording platform

POST /api/v1/system/services/call_recording/platforms/

Add a call recording platform.

Authorization rights: minimum System Admin.

Example request:

POST /api/v1/system/services/call_recording/platforms/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "name": "Call Rec Platform 2",
      "netAddress": "10.0.32.55",
      "port": 222,
      "mediaStream": "Dual",
      "transportProtocol": "UDP",
      "description": "test description",
      "schemaVersion": "1.0",
      "supportVideoRecording": false
}
Request JSON Object:

  • name (string) – The Call Recording Platform name.

  • netAddress (string) – The Call Recording Platform net address. IP Address, hostname, or domain.

  • port (integer) – (Optional) The Call Recording Platform port.

  • mediaStream (string) – Value comes from list: “Dual”, “Single”. Subscriber’s media is sent separately from the media generated by the called/calling parties when “Dual” is selected while “Single” is a single media stream that contains all media.

  • transportProtocol (string) – The Call Recording Platform Network Transport Protocol. Value comes from list: “UDP”, “TCP”, “Unspecified”.

  • description (string) – (Optional) The Call Recording Platform description.

  • schemaVersion (string) – Supported versions of the extension metadata. Value comes from list: “1.0”, “2.0”, “3.0”.

  • supportVideoRecording (boolean) – Specifies if to enable the video recording support.

Example response:

Response:

Similar to GET method response.

Status Codes:

Display a system’s call recording platform

GET /api/v1/system/services/call_recording/platforms/(string: instance_name)/

Retrieve a system’s call recording platform.

Authorization rights: minimum System Admin.

Example request:

GET /api/v1/system/services/call_recording/platforms/Call_Rec_Platform_1/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "default": true,
      "netAddress": "10.0.32.55",
      "port": 222,
      "mediaStream": "Dual",
      "transportProtocol": "UDP",
      "description": "test description",
      "schemaVersion": "1.0",
      "supportVideoRecording": false
}
Response JSON Object:

  • default (boolean) – Indicates if it is the system default platform.

  • netAddress (string) – The Call Recording Platform net address. IP Address, hostname, or domain.

  • port (integer) – The Call Recording Platform port.

  • mediaStream (string) – Value comes from list: “Dual”, “Single”. Subscriber’s media is sent separately from the media generated by the called/calling parties when “Dual” is selected while “Single” is a single media stream that contains all media.

  • transportProtocol (string) – The Call Recording Platform Network Transport Protocol. Value comes from list: “UDP”, “TCP”, “Unspecified”.

  • description (string) – The Call Recording Platform description.

  • schemaVersion (string) – Supported versions of the extension metadata. Value comes from list: “1.0”, “2.0”, “3.0”.

  • supportVideoRecording (boolean) – Specifies if to enable the video recording support.

Status Codes:

Modify a system’s call recording platform

PUT /api/v1/system/services/call_recording/platforms/(string: instance_name)/

Modify a call recording platform.

Authorization rights: minimum System Admin.

Example request:

PUT /api/v1/system/services/call_recording/platforms/Call_Rec_Platform_1/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "default": true
      "netAddress": "10.0.32.55",
      "port": 222,
      "mediaStream": "Dual",
      "transportProtocol": "UDP",
      "description": "test description",
      "schemaVersion": "1.0",
      "supportVideoRecording": false
}
Request JSON Object:

  • default (boolean) – (Optional) If true, set this Call Recording Platform as System default.

  • netAddress (string) – (Optional) The Call Recording Platform net address. IP Address, hostname, or domain.

  • port (integer) – (Optional) The Call Recording Platform port. Can be set to 0 to delete.

  • mediaStream (string) – (Optional) Value comes from list: “Dual”, “Single”. Subscriber’s media is sent separately from the media generated by the called/calling parties when “Dual” is selected while “Single” is a single media stream that contains all media.

  • transportProtocol (string) – (Optional) The Call Recording Platform Network Transport Protocol. Value comes from list: “UDP”, “TCP”, “Unspecified”.

  • description (string) – (Optional) The Call Recording Platform description. An empty string will delete the value.

  • schemaVersion (string) – (Optional) Supported versions of the extension metadata. Value comes from list: “1.0”, “2.0”, “3.0”.

  • supportVideoRecording (boolean) – (Optional) Specifies if to enable the video recording support.

Example response:

Response:

Similar to GET method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub error codes:

    • 18 INVALID_OPERATION, ‘Call Recording platform does not exist.’.

Delete a system’s call recording platform

DELETE /api/v1/system/services/call_recording/platforms/(string: instance_name)/

Delete a system’s call recording platform.

Authorization rights: minimum System Admin.

Example request:

DELETE /api/v1/system/services/call_recording/platforms/Call_Rec_Platform_1/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{}
Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to possible sub error codes:

    • 18 INVALID_OPERATION, ‘Call Recording platform does not exist.’.

    • 21 NOT_DELETED, ‘The system default Recording Platform cannot be deleted, unless it is not in use and the unique one defined.’.

Display system’s call recording platform usage

GET /api/v1/system/services/call_recording/platforms/(string: instance_name)/usage/

Retrieve the list of the call recording platforms in the system.

Authorization rights: minimum System Admin.

Example request:

GET /api/v1/system/services/call_recording/platforms/Call_Rec_Platform_1/usage/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  'groups': [
      {
          'groupId': 'ApioGrpTest',
          'tenantId': 'ApioSpTest'
      }
  ]
}
Response JSON Object:

  • groups (array) – the list of the groups using the Call Recording Platform as defined as Group instance.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to possible sub error codes:

    • 18 INVALID_OPERATION, ‘Call Recording platform does not exist.’.

Display system’s call recording properties

GET /api/v1/system/services/call_recording/properties/

Retrieve system’s call recording properties.

Authorization rights: minimum System Admin.

Example request:

GET /api/v1/system/services/call_recording/properties/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "continueCallAfterRecordingFailure": true,
      "refreshPeriodSeconds": 60,
      "maxConsecutiveFailures": 1,
      "maxResponseWaitTimeMilliseconds": 3000,
      "continueCallAfterVideoRecordingFailure": true
}
Response JSON Object:

  • continueCallAfterRecordingFailure (boolean) – Specifies if to continue the call after the audio recording failure.

  • refreshPeriodSeconds (integer) – TO DO.

  • maxConsecutiveFailures (integer) – TO DO.

  • maxResponseWaitTimeMilliseconds (integer) – The maximum response wait (in milliseconds).

  • continueCallAfterVideoRecordingFailure (boolean) – Specifies if to continue the call after the video recording failure.

Status Codes:

Modify system’s call recording properties

PUT /api/v1/system/services/call_recording/properties/

Modify system’s call recording properties.

Authorization rights: minimum System Admin.

Example request:

PUT /api/v1/system/services/call_recording/properties/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "continueCallAfterRecordingFailure": true,
      "refreshPeriodSeconds": 60,
      "maxConsecutiveFailures": 1,
      "maxResponseWaitTimeMilliseconds": 3000,
      "continueCallAfterVideoRecordingFailure": true
}
Request JSON Object:

  • continueCallAfterRecordingFailure (boolean) – (Optional) Specifies if to continue the call after the audio recording failure.

  • refreshPeriodSeconds (integer) – (Optional) (deprecated since rel 22) TO DO.

  • maxConsecutiveFailures (integer) – (Optional) (deprecated since rel 22) TO DO.

  • maxResponseWaitTimeMilliseconds (integer) – (Optional) The maximum response wait (in milliseconds).

  • continueCallAfterVideoRecordingFailure (boolean) – (Optional) Specifies if to continue the call after the video recording failure.

Example response:

Response:

Similar to GET method response.

Status Codes: