Upgrade 3CX to v18 and get it hosted free!
Home | Asterisk | Asterisk cmd UserEvent

Asterisk cmd UserEvent

Author image
Posted by , on October 20, 2004

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. To split body text to several lines | character could be used in Asterisk 1.4. There’s no way to do multiple lines in Asterisk 1.2. 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.

In Asterisk 1.4, the format of the event is :
Event: UserEvent
Privilege: <privilege (user,all for example)>
UserEvent: <specified event name>
[body]

Return value

Always returns 0.

Example

UserEvent(ASTDB|Family: dnd)
UserEvent(ASTDB|Family: dnd|State: on) in 1.4
UserEvent(ASTDB,Family: dnd,State: on) in 1.6

See also

Asterisk | Applications | Functions | Variables | Expressions | Asterisk FAQ

Related Posts:

Asterisk func strreplace
July 26, 2017
Synopsis Replace instances of a substring within a string with another string. Description Searches for all instances of the <find-string> in provided var...
asterisk cli command queue show
January 18, 2016
Synopsis show the queue current status Syntax: Asterisk 1.4 or later: queue show [<queue name>] Note: the queue name is not necessary. If queue name is nu...
Asterisk cmd Directory
May 12, 2005
Asterisk Directory Command Synopsis Provide directory of voicemail extensions Syntax Directory(vm-context[|dial-context[|options]]) - 1.4 Directory(vm-context[,...
Asterisk sip dtmfmode
September 9, 2005
DTMFmode for SIP client configuration Syntax dtmfmode=inband Choices are inband, rfc2833, info or auto inband: This send tones as inband audio within the voice ...
Asterisk func device_State
July 9, 2009
DEVICE_STATE(device) –Original page content moved from DEVSTATE() wiki page Synopsis Get or Set a device state Introduced in Asterisk 1.6 as DEVICE_STATE(...
Asterisk cmd MusicOnHold
May 19, 2005
Synopsis Play Music On Hold indefinitely. Description MusicOnHold([class]) Plays hold music specified by class. If omitted, the default music source for the cha...
Asterisk manager Example: Command
August 25, 2005
Execute an Asterisk CLI command in an Asterisk manager session The Asterisk CLI is accessible through the manager API. All of the CLI commands can be passed thr...
Asterisk CDR csv conversion mysql
March 16, 2005
I hope this can help others, so this is it.Use it at your own risk. I have test it on 3 separate systems without any problem. Take care to edit the following fi...
Asterisk PBX functions
August 6, 2005
Implementing common PBX functions with Asterisk Some PBX functions in Asterisk are implemented as applications or are supported by a combination of applications...
Asterisk cmd ChanSpy
July 26, 2005
ChanSpy Synopsis Listen in on a call, or whisper into a conversation. Useful in a call center to monitor agents on the phone. Description This adds the ability ...
Get 3CX - Absolutely Free!
Link up your team and customers Phone System Live Chat Video Conferencing

Hosted or Self-managed. Up to 10 users free forever. No credit card. Try risk free.

3CX
A 3CX Account with that email already exists. You will be redirected to the Customer Portal to sign in or reset your password if you've forgotten it.
Verify your Email

Check your inbox!

We’ve sent you an email. Click on the button in the email body to verify your email address – (if you can not find it, check your spam folder).

Upon verification you will be directed to the 3CX setup wizard.