VoiceMailMain()

Since 0.1.0 Applications

Check Voicemail messages.

Last reviewed 2026-04-14

VoiceMailMain(mailbox[,options])

Dialplan Builder -- build your VoiceMailMain() command

mailbox@ (optional)

options (optional)

Full arguments reference

mailbox required
- mailbox
- context
options
- p - Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller.
- g - Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB).
  - # required
- r - "Read only". Prevent user from deleting any messages. This applies only to specific executions of VoiceMailMain, NOT the mailbox itself.
- s - Skip checking the passcode for the mailbox.
- a - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
  - folder required
  - 0 - INBOX
  - 1 - Old
  - 2 - Work
  - 3 - Family
  - 4 - Friends
  - 5 - Cust1
  - 6 - Cust2
  - 7 - Cust3
  - 8 - Cust4
  - 9 - Cust5

Description

This application allows the calling party to check voicemail messages. A specific mailbox, and optional corresponding context, may be specified. If a mailbox is not provided, the calling party will be prompted to enter one. If a context is not specified, the default context will be used.

The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox or Password, and the extension exists:

* - Jump to the a extension in the current dialplan context.

Arguments

mailbox required
- mailbox
- context
options
- p - Consider the mailbox parameter as a prefix to the mailbox that is entered by the caller.
- g - Use the specified amount of gain when recording a voicemail message. The units are whole-number decibels (dB).
  - # required
- r - "Read only". Prevent user from deleting any messages. This applies only to specific executions of VoiceMailMain, NOT the mailbox itself.
- s - Skip checking the passcode for the mailbox.
- a - Skip folder prompt and go directly to folder specified. Defaults to INBOX (or 0).
  - folder required
  - 0 - INBOX
  - 1 - Old
  - 2 - Work
  - 3 - Family
  - 4 - Friends
  - 5 - Cust1
  - 6 - Cust2
  - 7 - Cust3
  - 8 - Cust4
  - 9 - Cust5

User Notes

Know a tip or gotcha for this topic? Share it below and help others.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Related

If()

Start an if branch.

Applications application dialplan

Zapateller()

Generates special information tone to block telemarketers from calling you. This application will set the following chan...

Applications application dialplan

While()

Start a while loop.

Applications application dialplan

WaitUntil()

Wait (sleep) until the current time is the given epoch.

Applications application dialplan

WaitForTone()

Waits for a single-frequency tone to be detected before dialplan execution continues. WAITFORTONESTATUS - This indicates...

Applications application dialplan

ConfBridge() MusicOnHold() StartMusicOnHold() StopMixMonitor() ADSIProg() AELSub() AGI() AMD() AddQueueMember() AgentLogin() AgentRequest() AlarmReceiver() Answer() AttendedTransfer() AudioSocket() Authenticate() Background() BackgroundDetect() BlindTransfer() Bridge() BridgeAdd() BridgeWait() Broadcast() Busy() CELGenUserEvent() CallCompletionCancel() CallCompletionRequest() ChanIsAvail() ChanSpy() ChangeMonitor() ChannelRedirect() ClearHash() ConfKick() Congestion() ContinueWhile() ControlPlayback() DAHDIAcceptR2Call() DAHDIRAS() DAHDIScan() DAHDISendCallreroutingFacility() DAHDISendKeypadFacility() DBdeltree() DISA() DateTime() DeadAGI() Dial() Dictate() Directory() DumpChan() EAGI() Echo() Else() ElseIf() EndIf() EndWhile() Exec() ExecIf() ExecIfTime() ExitIf() ExitWhile() ExtenSpy() ExternalIVR() Festival() Flash() FollowMe() ForkCDR() GetCPEID() Gosub() GosubIf() Goto() GotoIf() GotoIfTime() Hangup() HangupCauseClear() IAX2Provision() ICES() IVRDemo() If() ImportVar() Incomplete() JACK() JabberJoin() JabberLeave() JabberSend() JabberSendGroup() JabberStatus() Log() MP3Player() MSet() Macro() MacroExclusive() MacroExit() MacroIf() MailboxExists() MeetMe() MeetMeAdmin() MeetMeChannelAdmin() MeetMeCount() MessageSend() Milliwatt() MinivmAccMess() MinivmDelete() MinivmGreet() MinivmMWI() MinivmNotify() MinivmRecord() MixMonitor() Monitor() Morsecode() NBScat() NoCDR() NoOp() ODBCFinish() ODBC_Commit() ODBC_Rollback() OSPAuth() OSPFinish() OSPLookup() OSPNext() Originate() PJSIPHangup() PJSIPNotify() Page() Park() ParkAndAnnounce() ParkedCall() PauseMonitor() PauseQueueMember() Pickup() PickupChan() PlayTones() Playback() PrivacyManager() Proceeding() Progress() Queue() QueueLog() QueueUpdate() RaiseException() Read() ReadExten() ReceiveFAX() ReceiveMF() ReceiveSF() ReceiveText() Record() Reload() RemoveQueueMember() ResetCDR() RetryDial() Return() Ringing() SIPAddHeader() SIPDtmfMode() SIPRemoveHeader() SIPSendCustomINFO() SLAStation() SLATrunk() SMS() SayAlpha() SayAlphaCase() SayCountedAdj() SayCountedNoun() SayDigits() SayMoney() SayNumber() SayOrdinal() SayPhonetic() SayUnixTime() SendDTMF() SendFAX() SendImage() SendMF() SendSF() SendText() SendURL() Set() SetAMAFlags() Signal() SkelGuessNumber() SoftHangup() SpeechActivateGrammar() SpeechBackground() SpeechCreate() SpeechDeactivateGrammar() SpeechDestroy() SpeechLoadGrammar() SpeechProcessingSound() SpeechStart() SpeechUnloadGrammar() StackPop() Stasis() StatsD() StopMonitor() StopMusicOnHold() StopPlayTones() StoreDTMF() StreamEcho() System() TestClient() TestServer() ToneScan() Transfer() TryExec() TrySystem() UnpauseMonitor() UnpauseQueueMember() UserEvent() VMAuthenticate() VMSayName() Verbose() VoiceMail() VoiceMailMain() VoiceMailPlayMsg() Wait() WaitDigit() WaitExten() WaitForCondition() WaitForNoise() WaitForRing() WaitForSignal() WaitForSilence() WaitForTone() WaitUntil() While() Zapateller()