Appendix C. Asterisk Manager Socket API Syntax

AbsoluteTimeout Channel Timeout

Sets an absolute timeout in seconds for the specified channel. The call will be ended after the time has elapsed. The following example limits the call on the current channel to 10 minutes:

 Action: AbsoluteTimeout     Channel: SIP/201     Timeout: 600 

ChangeMonitor Channel File

Equivalent of ChangeMonitor( ) .

 Action: ChangeMonitor     Channel: Zap/1-1     File: Zap1-1-incsound 

Command command

Execute the specified dial-plan command. The command must include all arguments necessary for it to work.

GetVar Channel Variable

Gets a variable from the specified channel.

Hangup Channel

Hangs up specified channel. Equivalent to SoftHangup( ) .

IAXpeers

Lists IAX peers. Equivalent of IAX2 show peers CLI command.

ListCommands

Lists available Manager API commands.

Logoff

Closes the connection to the Manager.

MailboxCount Mailbox

Gets the message count for the specified mailbox.

MailboxStatus Mailbox

Gets the message-waiting indication for the specified mailbox.

Monitor Channel

Begins monitoring the specified channel. Equivalent of Monitor( ) .

Originate Channel Context Exten Priority Callerid

Places a call on the specified channel to the specified context, extension, and priority using the specified caller ID.

 Channel: SIP/20     Context: default     Exten: 18005044556     Priority: 1     Callerid: 3125551212 

ParkedCalls

Lists currently parked calls.

Ping

Sends a keep- alive message to the Manager.

Redirect Channel ExtraChannel Exten Context Priority

Connects the call on the specified channel to the specified context, extension, and priority using the specified channel ( ExTRaChannel ) and caller ID.

SetVar Channel Variable Value

Sets the specified channel's named variable to the value supplied.

Status Channel

Provides a status report on the specified channel. Similar to AGI command CHANNEL STATUS.

StopMonitor Channel

Stops monitoring the specified channel. Equivalent of StopMonitor( ) .