查询提示音选项

查询系统的提示音选项。

请求 URL

GET {base_url}/{api_path}/prompt_preference/get?access_token={access_token}

请求参数

无请求参数。直接发送请求 URL 获取提示音选项。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
prompt_preference Object<Prompt_Preference> 系统的提示音选项。
Prompt_Preference
参数 类型 说明
moh String 等待音乐列表的名称。
注： 如果响应结果未包含此参数，表示当通话保持时，系统不播放等待音乐。
call_fwd_prompt String 呼叫前转等待音乐的类型。
  • moh
  • ring_tone
invaild_num_prompt String 被叫号码无效提示音的文件名。
注： 如果响应结果未包含此参数，表示当被叫号码为空号时，系统不播放提示音。
busy_line_prompt String 中继忙时提示音。
注： 如果响应结果未包含此参数，表示当中继处于忙线时，系统不播放提示音。
  • default：播放系统自带的提示音。
  • 自定义提示音的文件名：播放对应提示音
dial_fail_prompt String 呼叫失败提示音。
注： 如果响应结果未包含此参数，表示当外线呼叫失败时，系统不播放提示音。
event_center_prompt String 事件通知提示音。
注： 如果响应结果未包含此参数，表示当事件中心拨打告警电话给联系人时，系统不播放提示音。
  • default：播放系统自带的提示音。
  • 自定义提示音的文件名：播放对应提示音
enb_call_fwd_prompt Integer 播放呼叫前转提示音是否已启用。
  • 0：禁用
  • 1：启用
enb_call_waiting_prompt Integer 播放呼叫等待提示音是否已启用。
  • 0：禁用
  • 1：启用

示例

请求示例

GET /openapi/v1.0/prompt_preference/get?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "prompt_preference": {
    "moh": "stream",
    "call_fwd_prompt": "ring_tone",
    "invaild_num_prompt": "invalid_num.wav",
    "busy_line_prompt": "busy_line.wav",
    "dial_fail_prompt": "dial_fail.wav",
    "event_center_prompt": "event.wav",
    "enb_call_fwd_prompt": 1,
    "enb_call_waiting_prompt": 0
  }
}