Voicemail Box

Unlock a sub voicemailbox

Use to unlock the pin on a subvoicemail box

put/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/unlock

Request

Base URL
https://api.alianza.com
Auth
API key in header X-AUTH-TOKEN
TypeScript
https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/unlock/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

ID of account

partitionIdstring required

ID of partition

voicemailBoxIdstring required

ID of Voicemail Box

Query parameters

resetPinboolean

New voicemail Pin

Response

Successful operation

idstring

namestring

name of the box

partitionIdstring

partitionid of the account

accountIdstring

accountid of the voicemail box

voicemailToEmailAddressesstring[]

email addresses to forward all voicemail messages to

voicemailToEmailEnabledboolean

enables voicemail to email

voicemailKeepAfterEmailboolean

keep or delete the voicemail after being emailed

localestring

Locale of the voicemail box

totalVoicemailsinteger

Total voicemails on the box

totalUnreadVoicemailsinteger

Total unread voicemails on the box

type'Normal' | 'Sub' | 'Primary' | 'BUSINESS_LINE'

Type of voicemail

subIdsstring[]

List of sub voicemail ids, this will be populated only if this voicemail box is primary

parentIdstring

Parent id for this voicemail box. Applicable if this voicemail box is a sub

dtmfOptionstring

DTMF option for this voicemail box. If this voicemail box is a sub, options are 2 through 8 otherwise option must be 1

pinLockedOutboolean

Marks whether the pin on this sub voicemailbox has been locked out

messageTranscriptionEnabledboolean

Specifies whether voicemail messages will be transcribed to text after a voicemail message is left

greetingsobject

Map of voicemail box greetings

Changes

No recorded changes to this operation across all 1 revision of this API.