Edit Prompt Preference Setting

Update the prompt preference settings of the system.

Request URL

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

Request parameters

Parameter Required Type Description
moh No String The filename of the MoH (music on hold).
Note: The maximum length is 255 characters.
call_fwd_prompt No String The type of the call forwarding prompt.

Valid value:

  • moh: The MoH (music on hold) is played.
  • ring_tone: The ring tone is played.
invaild_num_prompt No String The prompt to be played when the dial number is invalid.

Valid value:

  • Empty string: No prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played (e.g. demo.wav).
    Note:
    • The maximum length is 255 characters.
    • You can query the filename of the custom prompts using Search Custom Prompts.
busy_line_prompt No String The prompt to be played when the trunk is busy.

Valid value:

  • Empty string: No prompt is played.
  • default: The default built-in prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played (e.g. demo.wav).
    Note:
    • The maximum length is 255 characters.
    • You can query the filename of the custom prompts using Search Custom Prompts.
dial_fail_prompt No String The prompt to be played when a dial failed.

Valid value:

  • Empty string: No prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played (e.g. demo.wav).
    Note:
    • The maximum length is 255 characters.
    • You can query the filename of the custom prompts using Search Custom Prompts.
event_center_prompt No String The prompt to be played to the notification contact when answering an event notification call.

Valid value:

  • Empty string: No prompt is played.
  • default: The default built-in prompt is played.
  • The filename of a custom prompt: Corresponding prompt is played (e.g. demo.wav).
    Note:
    • The maximum length is 255 characters.
    • You can query the filename of the custom prompts using Search Custom Prompts.
enb_call_fwd_prompt No Integer Whether to enable playback of the call forwarding prompt.

Valid value:

  • 0: Disable
  • 1: Enable
enb_call_waiting_prompt No Integer Whether to enable playback of the call waiting prompt.

Valid value:

  • 0: Disable
  • 1: Enable

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.

Example

Request example

POST /openapi/v1.0/prompt_preference/update?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "enb_call_waiting_prompt": 0,
  "call_fwd_prompt": "ring_tone",
  "enb_call_fwd_prompt": 0
}

Response example

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