User Call Recording

The Call Recording service allows the user to record calls that you originate or receive.

Retrieve user’s Call Recording settings

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/call_recording/

Retrieve the settings of the Call Recording service of the user.

Authorization rights: minimum EndUser.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/call_recording/ HTTP/1.1
Host: example.com

Example response:

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

{
      "recordingOption": "Never",
      "pauseResumeNotification": "None",
      "enableCallRecordingAnnouncement": false,
      "enableRecordCallRepeatWarningTone": false,
      "recordCallRepeatWarningToneTimerSeconds": 15,
      "enableVoiceMailRecording": false
}
Response JSON Object:

  • recordingOption (string) – the recording option. Value comes from list: “Always”, “Never”, “On Demand”, “Always with Pause/Resume”, “On Demand with User Initiated Start”.

  • pauseResumeNotification (string) – the recording option. Value comes from list: “None”, “Beep”, “Play Announcement”.

  • enableCallRecordingAnnouncement (boolean) – Specify if to notify call participants when the call is being recorded.

  • enableRecordCallRepeatWarningTone (boolean) – Specify if to play a periodic reminder to the call participants that the call is being recorded, set the frequency in seconds with ‘recordCallRepeatWarningToneTimerSeconds’.

  • recordCallRepeatWarningToneTimerSeconds (integer) – Specify the frequency in seconds with which play the periodic reminder enabled with enableRecordCallRepeatWarningTone.

  • enableVoiceMailRecording (boolean) – Specify if to record calls to your voice mailbox.

Status Codes:

Update user’s Call Recording settings

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/call_recording/

Update the settings of the Call Recording service of the user.

Authorization rights: minimum EndUser.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/call_recording/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "recordingOption": "Never",
      "pauseResumeNotification": "None",
      "enableCallRecordingAnnouncement": false,
      "enableRecordCallRepeatWarningTone": false,
      "recordCallRepeatWarningToneTimerSeconds": 15,
      "enableVoiceMailRecording": false
}
Request JSON Object:

  • recordingOption (string) –

    (Optional) the recording option. Value comes from list: “Always”, “Never”, “On Demand”, “Always with Pause/Resume”, “On Demand with User Initiated Start”.

    • Always – Select this option if you want all your calls to be recorded.

    • Always with Pause/Resume – Select this option if you want all your calls to be automatically recorded but you want to have the option of stopping and resuming recording.

    • On Demand – Select this option is you want selected calls to be recorded. In this mode, your calls are automatically recorded from the beginning to the end, but you have to explicitly request the call to be recorded, for example, by dialing 44 (default), before the end of the call to keep the recording. Otherwise the recording is discarded. Once you have indicated that you want the call to be recorded, you can pause and resume the recording during the call, to keep only selected parts of it.

    • On Demand with User Initiated Start – Select this option is you want selected calls to be recorded. This option differs from the On Demand option in that the recording does not start until you explicitly request the call to be recorded. Once you have indicated that you want the call to be recorded, you can pause and resume the recording during the call, to keep only selected parts of it. You can also stop the recording at any point after the recording has started. If you do that and then make another recording request for the same call, a new recording is started.

    • Never – Select this option to disable call recording.

  • pauseResumeNotification (string) –

    (Optional) the recording option. Value comes from list: “None”, “Beep”, “Play Announcement”. Configure the type of notification played to the call participants when you pause or resume the recording. For the Play/Resume Notification setting, select one of the following:

    • Select None to give no indication to the parties in the call that the recording is paused or resumed.

    • Select Beep to play a tone when the recording is paused or resumed.

    • Select Play Announcement to play an announcement when the recording is paused or resumed.

  • enableCallRecordingAnnouncement (boolean) – (Optional) Specify if to notify call participants when the call is being recorded.

  • enableRecordCallRepeatWarningTone (boolean) – (Optional) Specify if to play a periodic reminder to the call participants that the call is being recorded, set the frequency in seconds with ‘recordCallRepeatWarningToneTimerSeconds’.

  • recordCallRepeatWarningToneTimerSeconds (integer) – (Optional) Specify the frequency in seconds with which play the periodic reminder enabled with enableRecordCallRepeatWarningTone.

  • enableVoiceMailRecording (boolean) – (Optional) Specify if to record calls to your voice mailbox.

Example response:

HTTP/1.1 200 OK
Status Codes: