编辑录音设置

编辑录音设置，包括录音提示音和录音对象。

请求 URL

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

请求参数

参数 是否必填 类型 说明
enb_internal 否 Integer 是否启用内部通话录音。

取值范围：

  • 0：禁用
  • 1：启用
internal_prompt 否 String 内部通话录音时播放的提示音。
注： 可通过 获取菜单选项 ("menu":"custom_prompt") 查询可用的自定义提示音。
outbound_prompt 否 String 呼出通话录音时播放的提示音。
注： 可通过 获取菜单选项 ("menu":"custom_prompt") 查询可用的自定义提示音。
inbound_prompt 否 String 呼入通话录音时播放的提示音。
注： 可通过 获取菜单选项 ("menu":"custom_prompt") 查询可用的自定义提示音。
enb_channel_separate 否 Integer 是否启用双声道录音，将主叫和被叫分别录制在不同声道。

取值范围：

  • 0：禁用
  • 1：启用
record_file_format 否 String 启用双声道录音后，生成的录音文件格式。

取值范围：

  • 0：禁用
  • 1：启用
enb_paging 否 Integer 是否启用广播/对讲通话录音。

取值范围：

  • 0：禁用
  • 1：启用
record_trunk_list 否 Array<Trunk_List> 配置需要录音的中继。
record_ext_list 否 Array<Extension_List> 配置需要录音的分机。
record_conference_list 否 Array<Conference_List> 配置需要录音的会议室。
record_queue_list 否 Array<Queue_List> 配置需要录音的队列。
record_ivr_list 否 Array<IVR_List> 配置需要录音的 IVR。
Trunk_List
注： 可通过 获取菜单选项 ("menu":"trunk") 查询中继信息。
参数 是否必填 类型 说明
id 是 Integer 中继的唯一 ID。
type 否 String 中继类型。
text 否 String 中继名称。
enb_config 否 Integer 通话过程中是否定期播放 Beep 提示音，提醒通话方通话正在被录音。

取值范围：

  • 0：禁用
  • 1：启用
number_value 否 Integer Beep 提示音的播放间隔，单位为秒。
Extension_List
注： 可通过 获取菜单选项 ("menu":"extension") 查询分机信息。
参数 是否必填 类型 说明
id 是 Integer 分机、分机组或部门的唯一 ID。
type 是 String 录音对象类型。

取值范围：

  • extension：分机
  • ext_group：分机组
  • organization：部门
text 否 String 分机、分机组或部门的名称。
text2 否 String 分机号码，或分机组/部门的名称。
Conference_List
注： 可通过 获取菜单选项 ("menu":"conference") 查询会议室信息。
参数 是否必填 类型 说明
id 是 Integer 会议室的唯一 ID。
text 否 String 会议室名称。
Queue_List
注： 可使用 获取菜单选项 ("menu":"queue") 查询队列信息。
参数 是否必填 类型 说明
id 是 Integer 队列的唯一 ID。
text 否 String 队列名称。
IVR_List
注： 可通过 获取菜单选项 ("menu":"ivr") 查询 IVR 信息。
参数 是否必填 类型 说明
id 是 Integer IVR 的唯一 ID。
text 否 String IVR 名称。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/autorecord/update?access_token=iioRRjGzPoYGGJLjh7zkYfYxj3Xe4oqW HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

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

响应示例

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