Update Voicemail Global Setting

Updates the global voicemail settings of the tenant.

Request URL

PUT {base_url}/uc-cconfig/api/v1/voicemail/global-settings

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
data Yes Object<Global_Setting_Data> The global voicemail setting data.
Global_Setting_Data
Parameter Required Type Description
allowCallerReviewMessage No Boolean Whether the caller can review the recorded message before leaving it.
globalDefaultGreetingEnabled No Boolean Whether the global default greeting is enabled.
globalDefaultGreetingSelector No String

The global default greeting selector:

Valid value:

  • GLOBAL_GREETING_DEFAULT: The system default audio file vm-greeting-ext-unavailable-com is used.
  • GLOBAL_GREETING_SPECIFIED: The audio file specified by globalDefaultGreetingAudioId is used.
globalDefaultGreetingAudioId No String The ID of the global default greeting audio file. This parameter is required when the selector is set to GLOBAL_GREETING_SPECIFIED.
maxGreetingPlayTime No Integer The maximum greeting play time in seconds.
voicemailNumberEnabled No Boolean Whether the voicemail number is enabled.
voicemailNumber No String The voicemail number, which is dialed to check voicemail messages.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Update_Result> The updated global voicemail settings of the tenant.
Update_Result
Parameter Type Description
data Object<Global_Setting_Data> The global voicemail setting data after the update.
Global_Setting_Data
Parameter Type Description
allowCallerReviewMessage Boolean Whether the caller can review the recorded message before leaving it.
globalDefaultGreetingEnabled Boolean Whether the global default greeting is enabled.
globalDefaultGreetingSelector String

The global default greeting selector:

  • GLOBAL_GREETING_DEFAULT: The system default audio file vm-greeting-ext-unavailable-com is used.
  • GLOBAL_GREETING_SPECIFIED: The audio file specified by globalDefaultGreetingAudioId is used.
globalDefaultGreetingAudioId String The ID of the global default greeting audio file. Only returned when the selector is GLOBAL_GREETING_SPECIFIED or an audio file has been specified.
maxGreetingPlayTime Integer The maximum greeting play time in seconds.
voicemailNumberEnabled Boolean Whether the voicemail number is enabled.
voicemailNumber String The voicemail number, which is dialed to check voicemail messages.