Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Media/Voicemail

Forward Voicemail to another user

patch/domains/{domain}/users/{user}/voicemails/{folder}/{filename}/forward

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000
folderstring required

Options include new, save, and trash

filenamestring required

Request body

voicemail-forward-new-destinationstring required

Should be a user extension where there voicemail will be moved that user's voicemail as a new message.

Response

filenamestring

This is the filename without and path or folder. Should end in .wav

ordinal-orderinteger

This is the index of the audio file.

file-duration-secondsinteger

This value is the length of the file in seconds.

file-size-kilobytesstring

This value will be a formated filesize of the file in kilobytes

created-datetimestring

This is the timestamp of create time fo the file

file-access-urlstring

This will be URL of the file for remote playback.

file-script-textstring

This is the script that was used for text to speech and also used to create a new file.

file-sourcestring

This is the source of the file, it will show how the file was created originally.

text-to-speech-voice-idstring

This is the voice id used when using text to speech.

text-to-speech-languagestring

This is the voice language when using TTS.

FromNamestring
FromUserstring
FromHoststring
NmsAnistring
recorded-datetimestring

This is the timestamp of record time fo the file

NmsRecStartTimestring
NmsRecDurationstring
TimeZonestring
transcriptionstring