VOICEMAIL.BOX.UPDATE - API REQUEST

VOICEMAIL.BOX.UPDATE - update voicemail box

Description

VOICEMAIL.BOX.UPDATE is used to update voicemail box configuration for the account/sub-account.

Arguments

ACCOUNT_NUMBER
Required. Account number of a user which voicemail box will be updated

BOX_NUMBER
Required. Voicemail box number to be updated

Below are supported Voicemail Box parameters which can be changed using this API. You only need to include those parameters which need to be updated.

PIN
Optional. Voicemail PIN (4 digits max)

LANGUAGE
Optional. Voicemail Language. Accepted values: ENG, SPA, FRCA

TITLE
Optional. Voicemail box title

IS_CUSTOM_EMAIL
Optional. Indicates if a custom voicemail notification template is used. Accepted values: TRUE or FALSE

CUSTOM_EMAIL_SUBJECT
Optional. Email Subject for the custom voicemail notifications

CUSTOM_EMAIL_BODY
Optional. Email Body for the custom voicemail notifications

MAXIMUM_DURATION
Optional. Maximum Voicemail Duration (seconds)). Accepted values: 10,30,45,60,120

MINIMUM_DURATION
Optional. Minimum Voicemail Duration (seconds)). Accepted values: 0,1,2,3,4,5,6

IS_TRANSCRIPTION
Optional. Indicates if this Voicemail box should be transcribed. Accepted values: TRUE or FALSE

TRANSCRIPTION_LANGUAGE
Optional. Transcription Language. Accepted values: ENGLISH, SPANISH

NOTIFICATION_SMS
Optional. Phone number for SMS/TEXT alerts (phone number must include the country code)

NOTIFICATION_EMAIL
Optional. Email address for new voicemail alerts

NOTIFICATION_PUSHOVER_USERKEY
Optional. Pushover app userkey for alerts delivered to Pushover app

NOTIFICATION_URL
Optional. URL for HTTP alerts

KEEP_DAYS
Optional. Retention schedule (days) for Voicemail messages

Example:
<PARAMETER NAME="ACCOUNT_NUMBER">23434323423</PARAMETER>
<PARAMETER NAME="BOX_NUMBER">100</PARAMETER>
<PARAMETER NAME="NOTIFICATION_EMAIL">new@address.com</PARAMETER>

Response

SUCCESS is returned for successful Voicemail box update

API Request Example

<?xml version="1.0" standalone="no" ?>
<REQUEST>
	<USERTOKEN>
		<USERKEY>df141891e2e883904b0b294dc5bq79c1c1c13f6d</USERKEY>
	</USERTOKEN>
	<ACTION NAME="VOICEMAIL.BOX.UPDATE">
		<PARAMETER NAME="ACCOUNT_NUMBER">0123456789</PARAMETER>
		<PARAMETER NAME="BOX_NUMBER">100</PARAMETER>
		<PARAMETER NAME="NOTIFICATION_EMAIL">new@address.com</PARAMETER>
	</ACTION>
</REQUEST>

Response Example

<?xml version="1.0" standalone="no" ?>
<RESPONSE>
	<RESULT>SUCCESS</RESULT>
</RESPONSE>