Skip to Content

Edit Auto Recording Setting

Edit the auto recording settings, including recording prompts and recording targets.

Request URL

POST {base_url}/{api_path}/autorecord/update?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
enb_internalNoIntegerWhether to record internal calls.

Valid value:

  • 0: Disabled
  • 1: Enabled
internal_promptNoStringThe prompt that will be played when internal calls are being recorded.
Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
outbound_promptNoStringThe prompt that will be played when outbound calls are being recorded.
Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
inbound_promptNoStringThe prompt that will be played when inbound calls are being recorded.
Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
start_promptNoStringThe prompt that will be played when recording starts during a call.
Note:
  • This prompt is triggered when authorized extension users start recording by pressing recording button on Simu Connect UC Clients or dialing the recording feature code (default *1).
  • You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
end_promptNoStringThe prompt that will be played when recording is stopped during a call.
Note:
  • This prompt is triggered when authorized extension users stop recording by pressing recording button on Simu Connect UC Clients or dialing the recording feature code (default *1).
  • You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt").
enb_channel_separateNoIntegerWhether to record the caller and callee on separate channels, generating a stereo recording with left and right channels.

Valid value:

  • 0: Disabled
  • 1: Enabled
record_file_formatNoStringThe file format of the recording when stereo recording is enabled.

Valid value:

  • wav
  • mp3
enb_pagingNoIntegerWhether to record paging/intercom calls.

Valid value:

  • 0: Disabled
  • 1: Enabled
record_trunk_listNoArray<Trunk_List>Specify the trunks to be recorded.
record_ext_listNoArray<Extension_List>Specify the extensions to be recorded.
record_conference_listNoArray<Conference_List>Specify the conferences to be recorded.
record_queue_listNoArray<Queue_List>Specify the queues to be recorded.
record_ivr_listNoArray<IVR_List>Specify the IVRs to be recorded.

Trunk_List

Note: You can query trunk information using Get Menu Options ("menu":"trunk").

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of a trunk.
typeNoStringTrunk type.
textNoStringTrunk name.
enb_configNoIntegerWhether to play a beep tone at regular intervals during a call to indicate that the call is being recorded.

Valid value:

  • 0: Disabled
  • 1: Enabled
number_valueNoIntegerThe time interval (in seconds) at which the beep tone will be played.

Extension_List

Note: You can query extension information using Get Menu Options ("menu":"extension").

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of extension, extension group, or organization.
typeYesStringThe type of recording target.

Valid value:

  • extension
  • ext_group
  • organization
textNoStringExtension name, extension group name, or organization name.
text2NoStringExtension number, extension group name, or organization name.
enb_continue_record_on_transferNoIntegerWhether to continue call recording after the extensions transfer the incoming calls to another destination.

Valid value:

  • 0: Disabled
  • 1: Enabled

Conference_List

Note: You can query conference information using Get Menu Options ("menu":"conference").

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of conference.
textNoStringConference name.

Queue_List

Note: You can query queue information using Get Menu Options ("menu":"queue").

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of queue.
textNoStringQueue name.
enb_continue_record_on_transferNoIntegerWhether to continue call recording after queue agents transfer incoming calls to another destination.

Valid value:

  • 0: Disabled
  • 1: Enabled

IVR_List

Note: You can query IVR information using Get Menu Options ("menu":"ivr").

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of IVR.
textNoStringIVR name.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

POST /openapi/v1.0/autorecord/update?access_token=iioRRjGzPoYGGJLjh7zkYfYxj3Xe4oqW HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json

{
    "enb_internal": 1,
    "internal_prompt": "internal_record.wav",
    "inbound_prompt": "inbound_record.wav",
    "outbound_prompt": "outbound_record.wav",
    "start_prompt": "welcome.wav",
    "end_prompt": "keypress.wav",
    "enb_channel_separate": 1,
    "record_file_format": "mp3",
    "enb_paging": 1,
    "record_trunk_list": [
        {
            "id": 5
        }
    ],
    "record_ext_list": [
        {
            "id": 18,
            "type": "extension",
            "enb_continue_record_on_transfer": 1
        }
    ],
    "record_conference_list": [
        {
            "id": 1        
         }
    ],
    "record_ivr_list": [
        {
            "id": 5
        }
    ],
    "record_queue_list": [
        {
            "id": 9,
            "enb_continue_record_on_transfer": 1
        }
    ]
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}