Asterisk Dialplan Commandsbef16.docx

Asterisk Dialplan Commandsbef16.docx

《Asterisk Dialplan Commandsbef16.docx》由会员分享，可在线阅读，更多相关《Asterisk Dialplan Commandsbef16.docx（17页珍藏版）》请在冰豆网上搜索。

AsteriskDialplanCommandsbef16

AsteriskDialplanCommands

HereisalistofallthecommandsthatyoucanuseinyourDialplan（extensions.conf）.YoucanobtainyourAsterisk'slistofavailableapplicationsattheCLIbytyping"showapplications"and"showapplication"inversionsbefore1.6,or"coreshowapplications"and"coreshowapplication"inversionsfrom1.4.

Notes:

∙Analphabeticallistcanbefoundattheendofthispage

∙PleaseonlylistapplicationsintegratedintheAsteriskreleasesorCVSversions,withnotesaboutversionwhereitisincluded.Thirdpartyadd-onsislistedinaseparatesection.

∙Colors:

oGreen-Added/functionalversion

oOrange-Deprecatedversion

oRed-Removed/nolongerinpresentversion

Generalcommands

∙Authenticate:

Authenticateauser.（1.0）

∙VMAuthenticate:

Authenticateauserbasedonvoicemail.conf.（1.2）

∙Bridge:

Connecttwoarbitrarycallers.（1.6）

∙ChannelRedirect:

Redirectanexistingchanneltothedialplan.（1.4）

∙CheckGroup:

Checksifthetotal#ofchannelsexceedsmax.DeprecatedinfavorofGROUP_COUNT.（1.2,1.4）

∙ClearHash:

Clearthekeysfromaspecifiedhashname（1.6）

∙Curl:

AllowsfortheretrievalofexternalURLs.AlsosupportsPOSTing.DeprecatedinfavorofCURL.（1.2,1.4）.

∙DUNDiLookup:

LookupanumberwithDUNDi.DeprecatedinfavorofDUNDILOOKUP.（1.2,1.4）

∙GetGroupCount:

Groupcountforspecifiedgrouporchannelisin.DeprecatedinfavorofGROUP_COUNT（1.2,1.4）

∙GetGroupMatchCount:

Calculatesgroupcountforallgroupsthatmatchpattern.DeprecatedinfavorofGROUP_MATCH_COUNT（1.2,1.4）

∙KeepAlive:

ReturnsAST_PBX_KEEPALIVEvalue（1.6）

∙Log:

AppendtexttotheAsterisklogfile（s）（1.4）

∙Page:

Pagemultipleendpointsatonce.（1.2）

∙AsteriskcmdPickupChan:

Pickuparingingchannel（1.6）

∙SendDTMF:

SendsarbitraryDTMFdigits.（1.0）

∙SendImage:

Sendanimagefile.（1.0）

∙SendText:

Sendclientatextmessage.（1.0）

∙SendURL:

SendaclientaURLtodisplay.（1.0）

∙SetGroup:

Setsthegroupforthecurrentchannel.DeprecatedinfavorofGROUP（1.2,1.4）

∙System:

Executeasystemcommand.（1.0）

∙Transfer:

Transfercallertoremoteextension.（1.0）

∙TrySystem:

Executeasystemcommandwithalways0returned.（1.0）

∙Wait:

Waitsforsometime.（1.0）

∙WaitExten:

Waitsforsometimeforcallertodialanewextension.（1.0）

∙WaitForRing:

WaitforRingApplication.（1.0）

∙WaitMusicOnHold:

Wait,playingMusicOnHold.DeprecatedinfavorofextendedMusicOnHold.（1.6）

Billing

∙ForkCDR:

ForkTheCDRinto2seperateentities.（1.0）

∙NoCDR:

Makesureasteriskdoesn'tsaveCDRforacertaincall.（1.0）

∙ResetCDR:

ResetCDRdata.（1.0）

∙SetAccount:

Setsaccountcode.DeprecatedinfavorofCDR（accountcode）（1.0,1.4）

∙SetAMAflags:

SetthechannelAMAFlagsforbilling.（1.0）

∙SetCDRUserField:

SetCDRUserfield.DeprecatedinfavorofCDR（userfield）（1.4,1.6）

∙AppendCDRUserField:

AppenddatatoCDRUserfield.DeprecatedinfavorofCDR（userfield）（1.4,1.6）

Callmanagement（hangup,answer,dial,etc）

∙AMD:

Answeringmachinedetection.（1.4）

∙Answer:

Answerachannelifringing.（1.0）

∙Busy:

Indicatebusyconditionandwaitforhangup.（1.0）

∙ChanIsAvail:

Checkifchannelisavailable.（1.0）

∙Congestion:

Indicatecongestionandwaitforhangup.（1.0）

∙Dial:

Placeacallandconnecttothecurrentchannel.（1.0）

∙DISA:

DISA（DirectInwardSystemAccess）.（1.0）

∙Hangup:

Unconditionalhangup.（1.0）

∙Originate:

Originateacallandconnecttoaspecifiedextensionorapplication（1.6.2）

∙RetryDial:

Placeacall,retryingonfailureallowingoptionalexitextension.（1.2）

∙Ringing:

Indicateringing.（1.0）

Callerpresentation（ID,Nameetc）

∙CallingPres:

Changethepresentationforthecallerid.（1.2）

∙LookupBlacklist:

LookupCaller*IDname/numberfromblacklistdatabase.DeprecatedinfavorofBLACKLIST（1.4,1.6）

∙LookupCIDName:

LookupCallerIDNamefromlocaldatabase.Deprecatedinfavorof${DB（cidname/${CALLERID（num）}）}.（1.4,1.6）

∙PrivacyManager:

Requirephonenumbertobeentered,ifnoCallerIDsent.（1.0）

∙SetCallerID:

SetCallerID.DeprecatedinfavorofCALLERID.（1.4,1.6）

∙SetCallerPres:

Channelindependentsettingofcallerpresenation.DeprecatedinfavorofCALLERPRES（1.6）

∙SetCIDName:

SetCallerIDName.DeprecatedinfavorofCALLERID.（1.4,1.6）

∙SetCIDNum:

SetonlytheCallerIDnumber（notname）.DeprecatedinfavorofCALLERID.（1.4,1.6）

∙SoftHangup:

Requesthanguponanotherchannel.（1.0）

∙Zapateller:

BlocktelemarketerswithSIT.（1.0）

ADSI

∙ADSIProg:

LoadAsteriskADSIScriptsintophone.（1.0）

∙GetCPEID:

GetADSICPEID.（1.0）

Databasehandling

∙DBdel:

Deleteakeyfromthedatabase.DeprecatedinfavorofDB_DELETE.（1.4,1.6）

∙DBdeltree:

Deleteafamilyorkeytreefromthedatabase.（1.0）

∙DBget:

Retrieveavaluefromthedatabase.DeprecatedinfavorofDB.（1.4,1.6）

∙DBput:

Storeavalueinthedatabase.DeprecatedinfavorofDB.（1.4,1.6）

∙AsteriskcmdODBCFinish:

Cleartheresultsetofasuccessfulmultirowquery（1.6）

∙RealTime:

PopulatevariableswithdetailsfromdatabaseusingRealTime.DeprecatedinfavorofREALTIME.（1.4,1.6）

∙RealTimeUpdate:

UpdateafieldinadatabaseusingRealTime.DeprecatedinfavorofREALTIME.（1.4,1.6）

SeeAsteriskdatabaseformoreinformation.

Applicationintegration

∙AGI:

ExecutesanAGIcompliantapplication.（1.0）

∙DeadAGI:

ExecutesAGIonahung-upchannel.（1.0）

∙EAGI:

ExecutesanAGIcompliantapplicationwithsoundchannels.（1.0）

∙EnumLookup:

LookupnumberinENUM.DeprecatedinfavorofENUMLOOKUP.（1.2,1.4）

∙ExternalIVR:

ExecutesanExternalIVRgenerator.（1.2）

∙JabberSend:

SendatextmessageviaJabber.（1.4）

∙JabberStatus:

Returnpresencestatusofclientortransportasvalues1-7（1.4）

∙Jack:

InterfacetoJACKaudioforaudiomanipulation.（1.6）

∙Read:

ReadDTMFtonesintoavariable.（1.0）

∙AsteriskcmdReadFile:

Readthecontentsofatextfileintoachannelvariable.（1.2）

∙TXTCIDName:

LookupcallernamefromTXTrecord.DeprecatedinfavorofTXTCIDNAME.（1.2,1.4）

∙UserEvent:

Sendanarbitraryeventtothemanagerinterface.（1.0）

Controlflow&timeouts

∙AbsoluteTimeout:

Setabsolutemaximumtimeofcall.DeprecatedinfavorofTIMEOUT（absolute）（1.2,1.4）

∙ContinueWhile:

Restartawhileloop（1.4）

∙DigitTimeout:

Setmaximumtimeoutbetweendigits.DeprecatedinfavorofTIMEOUT（digit）（1.2,1.4+）

∙EndWhile:

EndAWhileLoop.（1.2）

∙Exec:

Executedialplanapplication.（1.0）

∙ExecIf:

Conditionalexec.（1.2）

∙ExecIfTime:

Executesdialplanapplicationconditionallybasedoncurrenttime.（1.2）

∙ExitWhile:

EndaWhileloop.（1.2）

∙Gosub:

Jumptoasubroutineandreturn.（1.2）

∙GosubIf:

Conditionaljumptoasubroutineandreturn（1.2）

∙Goto:

Gotoaparticularpriority,extension,orcontext.（1.0）

∙GotoIf:

Conditionalgoto.（1.0）

∙GotoIfTime:

Conditionalgotooncurrenttime.（1.0）

∙Macro:

MacroImplementation.DeprecatedinfavorofGosub/Return.（1.6）

∙MacroExclusive:

Onlyonechannelatatimemaycallthismacro,allothershavetowait（1.4）ReplacedbydialplanfunctionsLOCK（）,TRYLOCK（）,andUNLOCK（）（1.6）

∙MacroExit:

Exitthemacroasifithadfullycompleted（1.4）DeprecatedinfavorofReturn（1.6）

∙AsteriskcmdMacroIf:

ConditionalMacroImplementation.DeprecatedinfavorofGosubIf（1.6）

∙NoOp:

Nooperation.Fordebugging,seeVerboseorLog.（1.0）

∙Random:

jumptoaspecifiedlocationbasedonarandomprobability.DeprecatedinfavorofGotoIf（$[${RAND（1,100）}>]?

）（1.4,1.6）

∙ResponseTimeout:

Setmaximumtimeoutawaitingresponse.DeprecatedinfavorofTIMEOUT（response）（1.2,1.4）

∙Return:

ReturnfromaGosuborGosubIf.（1.2）

∙StackPop:

Removeareturnaddresswithoutreturning.（1.2）

∙While:

StartAWhileLoop.（1.2）

String&variablemanipulation

∙Cut:

Splitastringonaspecifieddelimiter.DeprecatedinfavorofCUT.（1.2,1.4）

∙ImportVar:

Setvariabletovalue.（1.2）

∙Math:

Perform（rathersimple）calculations.DeprecatedinfavorofMATH.（1.2,1.4）

∙SetGlobalVar:

Setvariabletovalue.DeprecatedinfavorofAsteriskfuncglobal.（1.2,1.4）

∙MSet:

Setchannelvariable（s）orfunctionvalue（s）（1.6）

∙Set:

Setchannelvariable（s）orfunctionvalue（s）.（1.0）

∙DumpChan:

DumpInfoAboutTheCallingChannel.（1.0）

Sounds:

Playback

∙Background:

Playasoundfilewhilewaitinganextension.（1.0）

∙BackgroundDetect:

Backgroundafilewithtalkdetect.（1.0）

∙ControlPlayback:

Playasoundfilewithfastforward,rewindandexitcontrols.（1.0）

∙DateTime:

Saythedateand/ortime.SameasSayUnixTime.（1.0）

∙Echo:

Echoaudioreadbacktotheuser.（1.0）

∙Festival:

SaytextwiththeFestivalvoicesynthesizer.（1.0）

∙Milliwatt:

GenerateaConstant1000Hztoneat0dbm（mu-law）（1.0）

∙MP3Player:

PlayanMP3soundfileorstream.（1.0）

∙MusicOnHold:

PlayMusicOnHoldindefinitely.（1.0）

∙Playback:

Playasoundfile.（1.0）

∙Playtones:

Playatonelistwhileexecutingothercommands.（1.0）

∙AsteriskcmdProceeding:

Indicateproceeding（1.6）

∙Progress:

Playearlyaudiotothecallerbeforeansweringtheline.（1.0）

∙SayUnixTime:

Saythedateand/ortime.（1.0）

∙SayAlpha:

SayAlpha.（1.0）

∙SayDigits:

SayDigits.（1.0）

∙SayNumber:

SayNumber.（1.0）

∙SayPhonetic:

SayPhonetic.（1.0）

∙SetMusicOnHold:

SetdefaultMusicOnHoldclass.DeprecatedinfavorofCHANNEL（musicclass）（1.6）

∙SetLanguage:

Changelanguagesettingforsoundplayback.DeprecatedinfavorofLANGUAGE.（1.2,1.4）

∙StopPlaytones:

Stopplayingatonelist.（1.0）

SeeAsterisksoundfilesformoreinformation.

Sounds:

Record