Asterisk dialplan applications

Overview

Asterisk dialplan application 내용 정리

AddQueueMember

Queue 에 멤버를 추가한다(dynamically).

AddQueueMember(queuename,[interface,[penalty,[options,[membername,[stateinterface]]]]])

• queuename : 멤버를 추가하고자 하는 Queue name.
• interface : 추가하고자 하는 멤버의 interface
• penalty : 추가하고자 하는 멤버의 penalty.
• membername : 추가하고자 하는 멤버의 name.
• stateinterface :

Channel variables

application 실행 이후, 실행 결과와 관련한 다음의 channel variable 을 설정한다.

• AQMSTATUS : The status of the attempt to add a queue member as a text string.

ADDED : 추가됨.

MEMBERALREADY : 이미 멤버가 있음.

NOSUCHQUEUE : 큐를 찾을 수 없음.

Example

[QueueMemberFunctions]
exten => *54,1,Verbose(2,Logging In Queue Member)
  smae => n,Set(MemberChannel=${CHANNEL(channeltype)}/${CHANNEL(peername)})
  same => n,AddQueueMember(support,${MemberChannel})
  same => n,Verbose(1,${AQMSTATUS}) ; ADDED, MEMBERALREADY, NOSUCHQUEUE
  smae => n,Playback(agent-loginok)
  same => n,Hangup()

ADSIProg

지정한 ADSI 스크립트를 phone 으로 로드한다.

ADSIProg([script])

• script : adsi script to use. If not given uses the default script asterisk.adsi

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_ADSIProg

AELSub

Launch subroutine build with AEL.

Execute the named subroutine, defined in AEL, from another dialplan language, such as extensions.conf, Relaltime extensions, or Lua. The purpose of this application is to provide a sane entry point into AEL subroutines, the implementation of which many change from time to time.

AELSub(routine,[args])

• routine : Named subroutine to execute.
• args

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AELSub

AgentLogin

agent login 을 한다.

Login an agent to the system. Any agent authentication is assumed to already be done by dialplan. While logged in, the agent can receive calls and will hear the sound file specified by the config option custome_beep when a new call comes in for the agent. Login failure will continue in the dialplan with AGENT_STATUS set.

Before logging in, you can setup on the real agent channel the CHANNEL(dtmf-features) an agent will have when talking to a caller and you can setup on the channel running this application the CONNECTEDLINE() information the agent will se while waiting for a caller.

AgentLogin(AgentId,[options])

• AgentId
• options

s : silent login. do not announce the login ok segment after agent logged on.

Channel variables

• AGENT_STATUS enumeration values.

INVALID : The specified agent is invalid.

ALREADY_LOGGED_IN : The agent is already logged in.

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AgentLogin

AgentRequest

Request an agent to connect with the channel.

Request an agent to connect with the channel. Failure to find, alert the agent, or acknowledge the call will continue in the dialplan with AGENT_STATUS set.

AgentRequest(AgentId)

• AgentId

Channel variables

• AGENT_STATUS : enumeration values

INVALID : The specified agent is invalid.

NOT_LOGGED_IN : The agent is not available.

BUSY : The agent is on another call.

NOT_CONNECTED : The agent did not connect with the call. The agent most likely did not acknowledge the call.

ERROR : Alerting the agent failed.

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AgentRequest

AGI

Executes an AGI compliant application.

Exectes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol.

AGI(command,arg1,[arg2[,...]])

• command : How AGI should be invoked on the chaneel.
• args: Arguments to pass to the AGI script or server.

arg1

arg2[,arg2...]

The following variants of AGI exist, and are chosen based on the value passed to command.

• AGI : The classic variant of AGI, this will launch the script specified by command as a new process. Communication with the script occurs on stdin and stdout. If the full path to the script is not provided, the astagidir specified in asterisk.conf will be used.
• FastAGIj : Connect Asterisk to a FastAGI server using a TCP connection. The URI to the FastAGI server should be given in the form [scheme]://host.domain[:port][/script/name], where scheme is either agi or hagi. In the case of hagi, an SRV lookup will be performed to try to connect to a list of FastAGI servers. The hostname in the URI must be prefixed with _agi._tcp. prior to the DNS resolution. For example, if you specify the URI hagi://agi.example.com/foo.agi the DNS query would be for _agi._tcp.agi.example.com. You will need to make sure this resolves correctly.
• AsncAGI : Use AMI to control the channel in AGI. AGI commands can be invoked using the AMI action, with a variety of AGI specific events passed back over the AMI connection. AsyncAGI should be invoked by passing agi : async to the command parameter.

Channel variables

• AGISTATUS : The status of the attempt to the run the AGI script text string.

SUCCESS

FAULURE

NOTFOUND

HANGUP

Example

• AGI invocation examples

; Start the AGI script /tmp/my-cool-script.sh, passing it the contents
; of the channel variable FOO
same => n,AGI(/tmp/my-cool-script.sh,${FOO})
 
; Start the AGI script my-cool-script.sh located in the astagidir
; directory, specified in asterisk.conf
same => n,AGI(my-cool-script.sh)
 
; Connect to the FastAGI server located at 127.0.0.1 and start the script
; awesome-script
same => n,AGI(agi://127.0.0.1/awesome-script)
 
; Start AsyncAGI
same => n,AGI(agi:async)

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AGI

AlarmReceiver

Provide support for receiving alarm reports from a burglar or fire alarm panel.

This application should be called whenever there is an alarm calling int to dump its events. The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up. Once the panel hang up, the application will run the system command specified by the eventcmd setting in alarmreceiver.conf and pipe the events to the standard input of the application. The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgemnet tones.

AlarmReceiver()

Channel variables

• ALARMRECEIVER_CALL_LIMIT : Maximum call time, in milliseconds.

If set, this variable causes application to exit after the specified time.

• ALARMRECEIVER_RETRIES_LIMIT : Maximum number of retries per call.

If set, this variable causes application to exit after the specified number of messages.

Configuration

/etc/asterisk/alarmreceiver.conf

;
; alarmreceiver.conf
;
; Sample configuration file for the Asterisk alarm receiver application.
;


[general]

;
; Specify a timestamp format for the metadata section of the event files
; Default is %a %b %d, %Y @ %H:%M:%S %Z

timestampformat = %a %b %d, %Y @ %H:%M:%S %Z

;
; Specify a command to execute when the caller hangs up
;
; Default is none
;

;eventcmd = yourprogram -yourargs ...

;
; Specify a spool directory for the event files. This setting is required
; if you want the app to be useful. Event files written to the spool
; directory will be of the template event-XXXXXX, where XXXXXX is a random
; and unique alphanumeric string.
;
; Default is none, and the events will be dropped on the floor.
;

eventspooldir = /tmp

;
; The alarmreceiver app can either log the events one-at-a-time to individual
; files in the spool directory, or it can store them until the caller
; disconnects and write them all to one file.
;
; The default setting for logindividualevents is no.
;

logindividualevents = no

;
; The timeout for receiving the first DTMF digit is adjustable from 1000 msec.
; to 10000 msec. The default is 2000 msec. Note: if you wish to test the
; receiver by entering digits manually, set this to a reasonable time out
; like 10000 milliseconds.

fdtimeout = 2000

;
; The timeout for receiving subsequent DTMF digits is adjustable from
; 110 msec. to 4000 msec. The default is 200 msec. Note: if you wish to test
; the receiver by entering digits manually, set this to a reasonable time out
; like 4000 milliseconds.
;

sdtimeout = 200

;
; Wait for the connection to settle post-answer. Adjustable from 500 msec. to 10000 msec.
; The default is 1250 msec.
;

answait = 1250

; When logging individual events it may be desirable to skip grouping of metadata

;no_group_meta = yes

;
; The loudness of the ACK and Kissoff tones is adjustable from 100 to 8192.
; The default is 8192. This shouldn't need to be messed with, but is included
; just in case there are problems with signal levels.
;

loudness = 8192

;
; The db-family setting allows the user to capture statistics on the number of
; calls, and the errors the alarm receiver sees. The default is for no
; db-family name to be defined and the database logging to be turned off.
;

;db-family = yourfamily:

;
; End of alarmreceiver.conf
;

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AlarmReceiver

AMD

연결된 콜의 Answering machine(자동 응답기)여부를 분석한다.

AMD([initialSilence,[greeting,[afterGreetingSilence,[totalAnalysis Time,[miniumWordLength,[betweenWordSilence,[maximumNumberOfWords,[silenceThreshold,[maximumWordLength]]]]]]]]])

• initialSilence - Is maximum initial silence duration before greeting. If this is exceeded set as MACHINE
• greeting - is the maximum length of a greeting. If this is exceeded set as MACHINE
• afterGreetingSilence - Is the silence after detecting a greeting. If this is exceeded set as HUMAN
• totalAnalysis Time - Is the maximum time allowed for the algorithm to decide HUMAN or MACHINE
• miniumWordLength - Is the minimum duration of Voice considered to be a word
• betweenWordSilence - Is the minimum duration of silence after a word to consider the audio that follows to be a new word
• maximumNumberOfWords - Is the maximum number of words in a greeting. If this is exceeded set as MACHINE
• silenceThreshold - How long do we consider silence
• maximumWordLength - Is the maximum duration of a word to accept. If exceeded set as MACHINE

Channel variables

분석된 내용은 아래의 channel variable 에 설정된다.

• AMDSTATUS - 자동응답기 분석 결과

MACHINE - 자동응답기

HUMAN - 사람

NOTSURE - 분석 불가

HANGUP - 콜 종료됨.

• AMDCAUSE - 분석된 결과에 대한 자세한 사유를 설명한다.

TOOLONG - Total Time.

INITIALSILENCE - Silence Duration - Initial Silence.

HUMAN - Silence Duration - afterGreetingSilence.

LONGGREETING - Voice Duration - Greeting.

MAXWORDLENGTH - Word Count - maximum number of words.

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_AMD
• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_WaitForSilence
• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Application_WaitForNoise

RemoveQueueMeber

Queue 에서 멤버를 삭제한다(dynamically).

RemoveQueueMember(queuename,[interface])

• queuename : Queue name.
• interface : 삭제하고자 하는 멤버의 interface.

Channel variables

application 실행 이후, 실행 결과와 관련한 다음의 channel variable 을 설정한다.

• RQMSTATUS - The status of the attempt to remove a queue member as a text string.

REMOVED : 삭제됨.

NOTINQUEUE : Queue 에 해당 멤버가 없음.

NOSUCHQUEUE : Queue 를 찾을 수 없음.

NOTDYNAMIC : Dynamic 멤버가 아님.

Example

exten => *56,1,Verbose(2,Logging Out Queue Member)
  same => n,Set(MemberChannel=${CHANNEL(channeltype)}/${CHANNEL(peername)})
  same => n,RemoveQueueMember(support,${MemberChannel})
  same => n,Verbose(1,${RQMSTATUS}) ; REMOVED, NOTINQUEUE, NOSUCHQUEUE, NOTDYNAMIC
  same => n,Playback(agent-loggedoff)
  same => n,Hangup()

PauseQueueMember

지정한 멤버를 pause 한다.

PauseQueueMember([queuename,interface,[options,[reason]]])

• queuename :
• interface :
• options :
• reason : Is used to add extra information to the appropriate queue_log entries and manager events.

Channel variables

명령어 실행 후, 다음의 Channel variable 이 설정된다.

• PQMSTATUS - The status of the attempt to pause a queue member as a text string.

PAUSED : Pause 성공.

NOTFOUND : 지정한 Queue/Member를 찾을 수 없음.

Example

exten => *72,1,Verbose(2,Pause Queue Member)
  same => n,Set(MemberChannel=${CHANNEL(channeltype)}/${CHANNEL(peername)})
  same => n,PauseQueueMember(support,${MemberChannel})
  same => n,Verbose(1,${PQMSTATUS}); PAUSED, NOTFOUND
  same => n,Playback(dictate/paused)
  same => n,Hangup()

UnpauseQueueMember

지정한 멤버를 unpause 한다.

UnpauseQueueMember([queuename,interface,[options,[reason]]])

• queuename :
• interface :
• options :
• reason : Is used to add extra information to the appropriate queue_log entries and manager events.

Channel variables

명령어 실행 후, 다음의 Channel variable 이 설정된다.

• UPQMSTATUS : The status of the attempt to unpause a queue member as a text string.

UNPAUSED : unpaused 됨.

NOTFOUND : 지정한 Queue/Member 를 찾을 수 없음.

Example

exten => *87,1,Verbose(2,Unpause Queue Member)
  same => n,Set(MemberChannel=${CHANNEL(channeltype)}/${CHANNEL(peername)})
  same => n,UnpauseQueueMember(support,${MemberChannel})
  same => n,Verbose(1,${UPQMSTATUS}); UNPAUSED, NOTFOUND
  same => n,Playback(agent-loginok)
  same => n,Hangup()

Queue

In addition to transferring the call, a call may be parked and then picked up by another user.

This application will return to the dialplan if the queue does not exist, or any of the join options cause the caller to not enter the queue.

This application does not automatically answer and should be preceeded by an application such as Answer(), Progress(), or Ringing().

Queue(queuename,[options,[URL,[announceoverride,[timeout,[AGI,[macro,[gosub,[rule,[position]]]]]]]]])

• queuename
• options
  • C - Mark all calls as "answered elsewhere" when cancelled.
  • c - Continue in the dialplan if the callee hangs up.
  • d - data-quality (modem) call (minimum delay).
  • F - When the caller hangs up, transfer the called member to the specified destination and start execution at that location.
    • context
    • exten
    • priority
  • F - When the caller hangs up, transfer the called member to the next priority of the current extension and start execution at that location.
  • h - Allow callee to hang up by pressing *.
  • H - Allow caller to hang up by pressing *.
  • n - No retries on the timeout; will exit this application and go to the next step.
  • i - Ignore call forward requests from queue members and do nothing when they are requested.
  • I - Asterisk will ignore any connected line update requests or any redirecting party update requests it may receive on this dial attempt.
  • r - Ring instead of playing MOH. Periodic Announcements are still made, if applicable.
  • R - Ring instead of playing MOH when a member channel is actually ringing.
  • t - Allow the called user to transfer the calling user.
  • T - Allow the calling user to transfer the call.
  • w - Allow the called user to write the conversation to disk via Monitor.
  • W - Allow the calling user to write the conversation to disk via Monitor.
  • k - Allow the called party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
  • K - Allow the calling party to enable parking of the call by sending the DTMF sequence defined for call parking in features.conf.
  • x - Allow the called user to write the conversation to disk via MixMonitor.
  • X - Allow the calling user to write the conversation to disk via MixMonitor.
• URL - URL will be sent to the called party if the channel supports it.
• announceoverride
• timeout - Will cause the queue to fail out after a specified number of seconds, checked between each queues.conf timeout and retry cycle.
• AGI - Will setup an AGI script to be executed on the calling party's channel once they are connected to a queue member.
• macro - Will run a macro on the called party's channel (the queue member) once the parties are connected.
• gosub - Will run a gosub on the called party's channel (the queue member) once the parties are connected.
• rule - Will cause the queue's defaultrule to be overridden by the rule specified.
• position - Attempt to enter the caller into the queue at the numerical position specified. 1 would attempt to enter the caller at the head of the queue, and 3 would attempt to place the caller third in the queue.

Channel variables

명령어 실행 후, 다음의 Channel variable 이 설정된다.

• QUEUESTATUS - The status of the call as a text string.

TIMEOUT

FULL

JOINEMPTY

LEAVEEMPTY

JOINUNAVAIL

LEAVEUNAVAIL

CONTINUE

NoOp

Do Nothing (No Operation).

This application does nothing. However, it is useful for debugging purposes.

This method can be used to see the evaluations of variables or functions without having any effect.

Syntax

NoOp([text])

• text - Any text provided can be viewed at the Asterisk CLI.

Park

Call 을 Parking 한다.

Park([parking_lot_name][,options])

• parking_lot_name - Call 이 parking 되는 parking lot 을 지정한다. parking lot 은 다음의 순서에 의해 지정된다.

parking_lot_name 에 지정된 값

${PARKINGLOT} variable

CHANNEL(parkinglot) function(channel driver 에 의해 미리 지정되어 있을 수도 있다).

Default parking lot.

• options - parked 되는 콜에 대해 여러가지 옵션을 설정한다.

r: Parking 되는 콜에 MOH(Music on hold) 대신 Ringing 을 보낸다.

R: Parking 되는 장소(번호)를 Random 하게 지정한다.

s: Parking 되는 장소(번호)에 silence announcement 를 보낸다

c([[context,]extension,]priority): 만약 Parking 된 콜이 timeout 된 경우, 여기에 지정된 dialplan 으로 옮겨진다.

t(duration): 지정된 parking lot 에 설정된 timeout 대신, 여기에 설정된 duration 값을 timeout 으로 사용한다.

ParkedCall

Parked 된 콜을 가져온다.

ParkedCall([parking_lot_name,[parking_space]])

• parking_lot_name - Parked 된 콜을 가져올 Parking lot name 을 지정한다. parking lot 은 다음의 순서에 의해 지정된다.

parking_lot_name 에 지정된 값.

${PARKINGLOT} variable

CHANNEL(parkinglot) function(channel driver 에 의해 미리 지정되어 있을 수도 있다).

Default parking lot.

• parking_space - 지정된 parking lot 의 space 번호. 만약 지정하지 않는 다면, 가장 첫번째 parked call 을 가져온다.

ParkAndAnnounce

Call 을 parking 하고, default parking 메시지 대신, 지정된 안내 메시지를 play 한다.

ParkAndAnnounce([parking_lot_name,[options,announce:[announce1[:...]],]]dial)

• parking_lot_name - Call 이 parking 되는 parking lot 을 지정한다. parking lot 은 다음의 순서에 의해 지정된다.

parking_lot_name 에 지정된 값.

${PARKINGLOT} variable

CHANNEL(parkinglot) function(channel driver 에 의해 미리 지정되어 있을 수도 있다).

Default parking lot.

• options - parked 되는 콜에 대해 여러가지 옵션을 설정한다.

r: Parking 되는 콜에 MOH(Music on hold) 대신 Ringing 을 보낸다.

R: Parking 되는 장소(번호)를 Random 하게 지정한다.

s: Parking 되는 장소(번호)에 silence announcement 를 보낸다

c([[context,]extension,]priority): 만약 Parking 된 콜이 timeout 된 경우, 여기에 지정된 dialplan 으로 옮겨진다.

t(duration): 지정된 parking lot 에 설정된 timeout 대신, 여기에 설정된 duration 값을 timeout 으로 사용한다.

• announce_template - 콜론(:)으로 나뉘어진 파일들 목록이다. 기본 콜이 parking 될 때 나오는 default parking lot announce message(say_digits) 를 대체한다.

announce1[,announce1...]

• dial - The app_dial style resource to call to make the announcement. Console/dsp calls the console.

Playback

녹음된 파일을 재생한다.

별도의 옵션이 지정되어 있지 않다면, 자동적으로 Answer 를 수행한 후, 파일을 재생한다. 만약 지정된 파일에 문제가 있다면 실패한다.

Playback(filename&[filename2[&...]],[options])

• filenames

filename

filename2[,filename2...]

• options : 각각의 옵션들은 콤마(,) 로 구분된다.

skip : 콜이 Answer 되지 않았다면 play 하지 않는다.

noanswer : Answer 를 하지않고, play 한다. noanswer 옵션을 사용할 경우, playback 이전에 반드시 Answer 가 되어있어야 한다.

Channel variables

명령 실행 후, 다음의 Channel variable 이 설정된다.

• PLAYBACKSTATUS : playback 시도에 대한 결과값이 저장된다.

SUCCESS: 성공

FAILED: 실패

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_Playback - Asterisk 13 Application_Playback

SIPAddHeader

outbound call 에 SIP header 를 추가한다.

Non-standard header 를 추가할 시, X-header 를 사용해야 한다. i.e X-Asterisk-Accountcode:contents

SIPAddHeader(Header:Content)

• Header: Header 이름.
• Content: Header 내용.

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Application_SIPAddHeader

Monitor

Channel 을 모니터링한다.

주로 channel 을 모니터링 시작하고자 할 때 사용한다. 지정된 채널의 input/output voice packet 들이 StopMonitor 혹은 hangup 이 될 때 까지 파일에 저장된다. 기본값으로 파일들은 /var/spool/asterisk/monitor 디렉토리에 저장된다.

이미 monitoring 중이거나 저장 파일을 열 수 없을 때 1, 나머지 경우 0 을 리턴한다.

Monitor(file_format:[urlbase],[fname_base,[options]]])

• file_format

file_format: optional, if not set, defaults to wav

• fname_base: 설정할 경우, 설정한 filename 으로 파일이 생성된다.
• options

m : when the recording ends mix the two leg files into one and delete the two leg files. If the variable MONITOR_EXEC is set, the application referenced in it will be executed instead of soxmix/sox and the raw leg files will NOT be deleted automatically. soxmix/sox or MONITOR_EXEC is handed 3 arguments, the two leg files and a target mixed file name which is the same as the leg file names only without the in/out designator. If MONITOR_EXEC_ARGS is set, the contents will be passed on as additional arguments to MONITOR_EXEC. Both MONITOR_EXEC and the Mix flag can be set from the administrator interface.

b : Don't begin recording unless a call is bridged to another channel.

i : Skip recording of input stream (disables m option).

o : Skip recording of output stream (disables m option).

See also

• https://wiki.asterisk.org/wiki/display/AST/Application_Monitor

StopMonitor

Channel 의 모니터링을 중단한다.

만약 모니터링을 하지 않는 중이었어도 아무 영향을 주지 않는다.

StopMonitor()

See also

• https://wiki.asterisk.org/wiki/display/AST/Application_StopMonitor

See also

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+13+Dialplan+Applications - Asterisk 13 Dialplan Applications
• https://wiki.asterisk.org/wiki/display/AST/Asterisk+14+Dialplan+Applications - Asterisk 14 Dialplan Applications