Edit an Extension Voicemail Greeting

Request URL

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

Request parameters

Edit a recorded or uploaded voicemail greeting

Parameter	Required	Type	Description
id	Yes	Integer	The ID of the voicemail greeting. Note: You can query the voicemail greeting ID using Query Extension Voicemail Greeting List.
number	Yes	String	The number of the extension to which the voicemail greeting belongs.
file	Yes	String	The filename of the voicemail greeting. Note: The filename can not include the file extension, space, or special characters ' " ! : @ # $ % ^ * . & ( ) { } [ ] ; / , `. The maximum length is 250 characters.

Edit a voicemail greeting generated via text-to-speech (TTS)

Note: If any TTS-related field is modified, such as the language, voice, text, and speech, the audio is regenerated and the result is returned through an asynchronous callback.

Parameter	Required	Type	Description
id	Yes	Integer	The ID of the voicemail greeting. Note: You can query the voicemail greeting ID using Query Extension Voicemail Greeting List.
number	Yes	String	The number of the extension to which the voicemail greeting belongs.
file	No	String	The filename of the voicemail greeting. Note: The filename can not include the file extension, space, or special characters ' " ! : @ # $ % ^ * . & ( ) { } [ ] ; / , `. The maximum length is 250 characters.
text	No	String	The text used to generate voicemail greeting. Note: The maximum length is 1000 characters. The text language must be same as the language set in language.
language	No	String	The language code used for TTS (e.g., "en-US" or "zh-CN"). Note: The language must be supported by the vendor set in asr_manufacturer.
asr_manufacturer	No	String	The TTS vendor. Valid value: aws azure xunfei
voice_id	No	String	The ID of the voice profile.
speed	No	Integer	The speech rate. Note: A number from 1 to 100 is allowed.
volume	No	Integer	The volume. Note: A number from 1 to 100 is allowed.
pitch	No	Integer	The pitch. Note: A number from 1 to 100 is allowed.

Response parameters

Example

Request example

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

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "id": 5,
  "file": "doc_demo_ext_v2"
}

Response example

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