U-Z
From AstriPedia
- Index U-Z of Asterisk Applications
Contents |
UnpauseQueueMember
Synopsis
Unpauses a queue member
Description
UnpauseQueueMember([queuename]|interface[|options]):
Unpauses (resumes calls to) a queue member. This is the counterpart to PauseQueueMember and operates exactly the same way, except it unpauses instead of pausing the given interface. The option string may contain zero or more of the following characters:
'j' -- jump to +101 priority when appropriate.
This application sets the following channel variable upon completion:
UPQMSTATUS The status of the attempt to unpause a queue
member as a text string, one of
UNPAUSED | NOTFOUND
Example: UnpauseQueueMember(|SIP/3000)
UserEvent
Synopsis
Send an arbitrary event to the manager interface
Description
UserEvent(eventname[|body]):
Sends an arbitrary event to the manager interface, with an optional body representing additional arguments. The format of the event will be:
Event: UserEvent<specified event name> Channel: <channel name> Uniqueid: <call uniqueid> [body]
If the body is not specified, only Event, Channel, and Uniqueid fields will be present. Returns 0.
Verbose
Synopsis
Send arbitrary text to verbose output
Description
Verbose([<level>|]<message>) level must be an integer value. If not specified, defaults to 0.
VMAuthenticate
Synopsis
Authenticate with Voicemail passwords
Description
VMAuthenticate([mailbox][@context][|options]):
This application behaves the same way as the Authenticate application, but the passwords are taken from voicemail.conf. If the mailbox is specified, only that mailbox's password will be considered valid. If the mailbox is not specified, the channel variable AUTH_MAILBOX will be set with the authenticated mailbox. Options: s - Skip playing the initial prompts.
VoiceMail
Synopsis
Leave a Voicemail message
Description
VoiceMail(mailbox[@context][&mailbox[@context]][...][|options]):
This application allows the calling party to leave a message for the specified list of mailboxes. When multiple mailboxes are specified, the greeting will be taken from the first mailbox specified. Dialplan execution will stop if the specified mailbox does not exist.
The Voicemail application will exit if any of the following DTMF digits are received:
0 - Jump to the 'o' extension in the current dialplan context.
* - Jump to the 'a' extension in the current dialplan context.
This application will set the following channel variable upon completion:
VMSTATUS - This indicates the status of the execution of the VoiceMail
application. The possible values are:
SUCCESS | USEREXIT | FAILED
Options:
b - Play the 'busy' greeting to the calling party.
g(#) - Use the specified amount of gain when recording the voicemail
message. The units are whole-number decibels (dB).
s - Skip the playback of instructions for leaving a message to the
calling party.
u - Play the 'unavailable greeting.
j - Jump to priority n+101 if the mailbox is not found or some other
error occurs.
VoiceMailMain
Synopsis
Check Voicemail messages
Description
VoiceMailMain([mailbox][@context][|options]):
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.
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).
s - Skip checking the passcode for the mailbox.
Wait
Synopsis
Waits for some time
Description
Wait(seconds):
This application waits for a specified number of seconds. Then, dialplan execution will continue at the next priority. Note that the seconds can be passed with fractions of a second. For example, '1.5' will ask the application to wait for 1.5 seconds.
WaitExten
Synopsis
Waits for an extension to be entered
Description
WaitExten([seconds][|options]):
This application waits for the user to enter a new extension for a specified number of seconds. Note that the seconds can be passed with fractions of a second. For example, '1.5' will ask the application to wait for 1.5 seconds.
Options:
m[(x)] - Provide music on hold to the caller while waiting for an extension.
Optionally, specify the class for music on hold within parenthesis.
WaitForRing
Synopsis
Wait for Ring Application
Description
WaitForRing(timeout) Returns 0 after waiting at least timeout seconds. and only after the next ring has completed. Returns 0 on success or -1 on hangup
WaitForSilence
Synopsis
Waits for a specified amount of silence
Description
WaitForSilence(x[|y]) Wait for Silence:
Waits for up to 'x' milliseconds of silence, 'y' times or 1 if omitted Set the channel variable WAITSTATUS with to one of these values:SILENCE - if silence of x ms was detectedTIMEOUT - if silence of x ms was not detected.
Examples:
- WaitForSilence(500|2) will wait for 1/2 second of silence, twice - WaitForSilence(1000) will wait for 1 second of silence, once
WaitMusicOnHold
Synopsis
Wait, playing Music On Hold
Description
WaitMusicOnHold(delay):
Plays hold music specified number of seconds. Returns 0 when done, or -1 on hangup. If no hold music is available, the delay will still occur with no sound.
While
Synopsis
Start A While Loop
Description
Usage:
While(<expr>) Start a While Loop. Execution will return to this point when
EndWhile is called until expr is no longer true.
Zapateller
Synopsis
Block telemarketers with SIT
Description
Zapateller(options):
Generates special information tone to block telemarketers from calling you.
Options is a pipe-delimited list of options.
The following options are available:
'answer' causes the line to be answered before playing the tone,
'nocallerid' causes Zapateller to only play the tone if there
is no callerid information available.
Options should be separated by | characters
ZapBarge
Synopsis
Barge in (monitor) Zap channel
Description
ZapBarge([channel]):
Barges in on a specified zap channel or prompts if one is not specified. Returns -1 when caller user hangs up and is independent of the state of the channel being monitored.
ZapRAS
Synopsis
Executes Zaptel ISDN RAS application
Description
ZapRAS(args):
Executes a RAS server using pppd on the given channel. The channel must be a clear channel (i.e. PRI source) and a Zaptel channel to be able to use this function (No modem emulation is included). Your pppd must be patched to be zaptel aware. Arguments should be separated by | characters.
ZapScan
Synopsis
Scan Zap channels to monitor calls
Description
ZapScan([group]) allows a call center manager to monitor Zap channels in a convenient way.
Use '#' to select the next channel and use '*' to exit Limit scanning to a channel GROUP by setting the option group argument.
