Query Prompt Preference Setting

Query the prompt preference settings of the system.

Request URL

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

Request parameters

No request parameters. Send the request URL directly to query prompt preference setting.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
prompt_preference Object<Prompt_Preference> The prompt preference settings of the system.
Prompt_Preference
Parameter Type Description
moh String The filename of the MoH (music on hold).
Note: If this parameter is not included in the response, this indicates that no MoH is played when a call is on hold.
call_fwd_prompt String The type of the call forwarding prompt.
invaild_num_prompt String The filename of the invalid number prompt.
Note: If this parameter is not included in the response, this indicates that no prompt is played when the dial number is invalid.
busy_line_prompt String The busy trunk prompt.
Note: If this parameter is not included in the response, this indicates that no prompt is played when the trunk is busy.
  • default: The default built-in prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played.
dial_fail_prompt String The filename of the dial failure prompt.
Note: If this parameter is not included in the response, this indicates that no prompt is played when a dial failed.
event_center_prompt String The event center prompt.
Note: If this parameter is not included in the response, this indicates that no prompt is played to the notification contact when answering an event notification call.
  • default: The default built-in prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played.
enb_call_fwd_prompt Integer Whether the call forwarding prompt is enabled.
  • 0: Disabled
  • 1: Enabled
enb_call_waiting_prompt Integer Whether the call waiting prompt is enabled.
  • 0: Disabled
  • 1: Enabled

Example

Request example

GET /openapi/v1.0/prompt_preference/get?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1
Host: 192.168.5.150:8088

Response example

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
  }
}