Manager Commands Documentation

The manager.conf file controls the socket manager command interface to Asterisk.

Location: /etc/asterisk/manager.conf

Notes

File Example

;
; Asterisk Call Management support
;
[general]
enabled = yes
; The documented value 'port' does not work. Bug! Default is 5038
portno = 5138
bindaddr = 0.0.0.0

[chris]
secret = password
;deny=0.0.0.0/0.0.0.0
permit=66.116.94.0/255.255.255.0
read = system,call,log,verbose,command,agent,user
write = system,call,log,verbose,command,agent,user
 

Commands (from http://www.voip-info.org/wiki-Asterisk+manager+API)

Action: Command
Parameters: Command (Asterisk CLI command, not an application command)

Action: ExtensionState
Parameters: Exten, Context, ActionID

Action: Hangup
Parameters: Channel

Action: Logoff
Parameters: None

Action: MailboxCount
Parameters: Mailbox, ActionID

Action: MailboxStatus
Parameters: Mailbox, ActionID

Action: Originate
Parameters: Channel, Exten, Context, Priority, Timeout, CallerID, Variable, Account, Application, Data

Action: Ping
Parameters: None

Action: Redirect
Parameters: Channel, ExtraChannel, Exten, Context, Priority

Action: Status
Parameters: ActionID

Action: Timeout
Parameters: Channel, Timeout

Command Notes:

The ActionID parameter is arbitrary and optional. It is simply returned. See sample session above.

Sample session (via telnet) (Values sent in bold):

TELNET machine 5038

Asterisk Call Manager/1.0
Action: Login
Username: admin
Secret: pass
<linefeed>

Response: Success
Message: Authentication accepted

Action: Command
Command: extensions reload
<linefeed>

Response: Follows
--END COMMAND--

Dial extension 1VOIP00000-1-205 and when it answers launch it into
the [managertest] context, passing data

Action: Originate
Channel: SIP/1VOIP00000-1-205
Exten: 999
Priority: 1
Context: managertest
Timeout: 10000
Variable: acctcode=1VOIP00000-1|dialphone=7143236371


Response: Success

Action: MailboxStatus
Mailbox: 2022

Response: Success
Message: Mailbox Status
Mailbox: 2022
Waiting: 0

Action: MailboxStatus
Mailbox: 2022
ActionID: 00001

Response: Success
ActionID: 00001
Message: Mailbox Status
Mailbox: 2022
Waiting: 0

Action: Command
Command: show manager connected

Response: Follows
Username IP Address
chris 66.116.94.66
--END COMMAND--

Action: Logoff

Response: Goodbye
Message: Thanks for all the fish.

 

And then this stuff just magically comes flying on by...

ASTERISK STUFF NOT DRIVEN BY CALLS

Event: PeerStatus
Peer: SIP/1VOIP00000-1-205
PeerStatus: Unregistered
Cause: Expired

Event: PeerStatus
Peer: SIP/1VOIP00000-1-221
PeerStatus: Registered

Event: Registry
Channel: SIP
Domain: a462sQpmFp7LWlcw.sip.gafachi.com
Status: Registered

DIAL OUT

Event: Newchannel
Channel: SIP/1VOIP00000-1-205-b5a7
State: Ring
CallerID: Demo 5 <205>
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-from-extension
Extension: 3236371
Priority: 1
Application: AGI
AppData: VectusSetAcctFromChannel.agi
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-from-extension
Extension: 3236371
Priority: 2
Application: AGI
AppData: VectusConvertNumToURL.agi
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-from-extension
Extension: 3236371
Priority: 3
Application: NoOp
AppData: ACCOUNTCODE=1VOIP00000-1| URL=0phone:7143236371| CHANNEL=SIP/1VOIP00000-1-205-b5a7
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-from-extension
Extension: 3236371
Priority: 4
Application: Macro
AppData: setoutboundagent
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: macro-setoutboundagent
Extension: s
Priority: 1
Application: Cut
AppData: Agent=CHANNEL||1-3
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: macro-setoutboundagent
Extension: s
Priority: 2
Application: SetGroup
AppData: SIP/1VOIP00000-1-205
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: macro-setoutboundagent
Extension: s
Priority: 3
Application: NoOp
AppData: ##### Setting SIP/1VOIP00000-1-205 IN USE
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-from-extension
Extension: 3236371
Priority: 5
Application: Goto
AppData: perl-route-call|0phone:7143236371|1
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-route-call
Extension: 0phone:7143236371
Priority: 1
Application: SetVar
AppData: SOUNDFILES=
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-route-call
Extension: 0phone:7143236371
Priority: 2
Application: AGI
AppData: VectusInitAndGoto.agi
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-route-call
Extension: 0phone:7143236371
Priority: 1110
Application: Goto
AppData: perl-dial-out-direct|17143236371|1
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 1
Application: AppendCDRUserField
AppData: tn=17143236371|cid=205|
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 2
Application: SetVar
AppData: Extension=perl-dial-out-direct-17143236371
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 3
Application: AGI
AppData: VectusSetCid.agi|1VOIP00000-1|SIP/1VOIP00000-1-205-b5a7
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 4
Application: SetCallerID
AppData: VOIP_L1 <7143988751>
Uniqueid: 1113252598.45

Event: Newcallerid
Channel: SIP/1VOIP00000-1-205-b5a7
CallerID: VOIP_L1 <7143988751>
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 5
Application: NoOp
AppData: Caller ID VOIP_L1 <7143988751> NEWCHANNEL:SIP/809517143236371@konfer-out
Uniqueid: 1113252598.45

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: 17143236371
Priority: 6
Application: Dial
AppData: SIP/809517143236371@konfer-out
Uniqueid: 1113252598.45

Event: Newchannel
Channel: SIP/konfer-out-c0e3
State: Down
CallerID: <unknown>
Uniqueid: 1113252599.46

ANSWER

Event: Newchannel
Channel: SIP/konfer-out-c0e3
State: Up
CallerID: VOIP_L1 <7143988751>
Uniqueid: 1113252599.46

Event: Newstate
Channel: SIP/1VOIP00000-1-205-b5a7
State: Up
CallerID: VOIP_L1 <7143988751>
Uniqueid: 1113252598.45

Event: Link
Channel1: SIP/1VOIP00000-1-205-b5a7
Channel2: SIP/konfer-out-c0e3
Uniqueid1: 1113252598.45
Uniqueid2: 1113252599.46

HANG UP

Event: Unlink
Channel1: SIP/1VOIP00000-1-205-b5a7
Channel2: SIP/konfer-out-c0e3
Uniqueid1: 1113252598.45
Uniqueid2: 1113252599.46

Event: Hangup
Channel: SIP/konfer-out-c0e3
Uniqueid: 1113252599.46
Cause: 16

Event: Newexten
Channel: SIP/1VOIP00000-1-205-b5a7
Context: perl-dial-out-direct
Extension: h
Priority: 1
Application: NoOp
AppData: Hangup [perl-dial-out-direct]
Uniqueid: 1113252598.45

Event: Hangup
Channel: SIP/1VOIP00000-1-205-b5a7
Uniqueid: 1113252598.45
Cause: 16


DIAL EXTENSION

Event: Newchannel
Channel: SIP/1VOIP00000-1-205-3f6a
State: Ring
CallerID: Demo 5 <205>
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-from-extension
Extension: 221
Priority: 1
Application: AGI
AppData: VectusSetAcctFromChannel.agi
Uniqueid: 1113252821.50

Event: PeerStatus
Peer: SIP/1VOIP00000-1-221
PeerStatus: Registered

Event: PeerStatus
Peer: SIP/1VOIP00000-1-220
PeerStatus: Registered

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-from-extension
Extension: 221
Priority: 2
Application: AGI
AppData: VectusConvertNumToURL.agi
Uniqueid: 1113252821.50

Event: PeerStatus
Peer: SIP/1VOIP00000-1-205
PeerStatus: Registered

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-from-extension
Extension: 221
Priority: 3
Application: NoOp
AppData: ACCOUNTCODE=1VOIP00000-1| URL=0exten:1VOIP00000-1-221| CHANNEL=SIP/1VOIP00000-1-205-3f6a
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-from-extension
Extension: 221
Priority: 4
Application: Macro
AppData: setoutboundagent
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: macro-setoutboundagent
Extension: s
Priority: 1
Application: Cut
AppData: Agent=CHANNEL||1-3
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: macro-setoutboundagent
Extension: s
Priority: 2
Application: SetGroup
AppData: SIP/1VOIP00000-1-205
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: macro-setoutboundagent
Extension: s
Priority: 3
Application: NoOp
AppData: ##### Setting SIP/1VOIP00000-1-205 IN USE
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-from-extension
Extension: 221
Priority: 5
Application: Goto
AppData: perl-route-call|0exten:1VOIP00000-1-221|1
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: 0exten:1VOIP00000-1-221
Priority: 1
Application: SetVar
AppData: SOUNDFILES=
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: 0exten:1VOIP00000-1-221
Priority: 2
Application: AGI
AppData: VectusInitAndGoto.agi
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: 0exten:1VOIP00000-1-221
Priority: 3
Application: SetVar
AppData: CHUNK=
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: 0exten:1VOIP00000-1-221
Priority: 4
Application: AGI
AppData: VectusGetNextChunk.agi|SOUNDFILES
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: 0exten:1VOIP00000-1-221
Priority: 5
Application: GotoIf
AppData: 1?_X.|50
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: _X.
Priority: 50
Application: SetVar
AppData: USETARGETINFO=
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: _X.
Priority: 51
Application: NoOp
AppData: -------- JUMPING TO 3000 --------"
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: _X.
Priority: 52
Application: NoOp
AppData: VMBOX=221
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: _X.
Priority: 53
Application: GotoIf
AppData: X3000=X?100:3000
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-route-call
Extension: _X.
Priority: 3000
Application: Goto
AppData: perl-dial-target|1VOIP00000-1-221|1
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-dial-target
Extension: 1VOIP00000-1-221
Priority: 1
Application: AGI
AppData: VectusGetDialTarget.agi
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-dial-target
Extension: 1VOIP00000-1-221
Priority: 2
Application: NoOp
AppData:
Uniqueid: 1113252821.50

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-dial-target
Extension: 1VOIP00000-1-221
Priority: 3
Application: Dial
AppData: SIP/1VOIP00000-1-221|10|M(setagentgroup)tr
Uniqueid: 1113252821.50

Event: Newchannel
Channel: SIP/1VOIP00000-1-221-6f43
State: Down
CallerID: <unknown>
Uniqueid: 1113252822.51

Event: Newchannel
Channel: SIP/1VOIP00000-1-221-6f43
State: Ringing
CallerID: Demo 5 <205>
Uniqueid: 1113252822.51

HANG UP

Event: Hangup
Channel: SIP/1VOIP00000-1-221-6f43
Uniqueid: 1113252822.51
Cause: 16

Event: Newexten
Channel: SIP/1VOIP00000-1-205-3f6a
Context: perl-dial-target
Extension: h
Priority: 1
Application: NoOp
AppData: Hangup [perl-dial-target]
Uniqueid: 1113252821.50

Event: Hangup
Channel: SIP/1VOIP00000-1-205-3f6a
Uniqueid: 1113252821.50
Cause: 0