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 manager API

---

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