Search....

LOGIN | REGISTER

Home QuickLinks BusinessVOIP ResidentialVOIP SIP CallCenterSoftware

WholesaleVOIP Forums

View Discussion(0) History

AsteriskDetailedVariableList
BusinessPBXSolutions
Provider SolutionDetails

BecomeanITSP
Now!
Becomeaserious
competitorinVoIP
Immediately
FULLConsultancy, Details
Installation,Training&
Support
SellHostedIPPBXs,Biz
Lines,CallCentre
TurnkeyProvisioningat
yourdatacenter

3CXSoftwarePBX
forWindows,Linux
andtheCloud
OpenStandards
SoftwareSolution Details
EasytoInstalland
Manage
AutoConfiguresPhones
&Trunks
Android,iOS,Windows
&Macclients

*RatesshowndonotincludeE911chargesorgovernmentmandatedtaxes.
Providersofferingunlimitedcallingplansmayhaverestrictions.Read
providerstermsandconditionscarefullybeforebuying.
Asteriskstandardchannelvariables

Thereareanumberofvariablesthataredefinedorread
byAsterisk.Hereisalistofthem.Moreinformationis
availableineachapplication'shelptext.Allthesevariables
areinUPPERCASEonly.

Todisplayallchannelvariableusethiscommand:

DumpChan([<min_verbose_level>])

Variablesmarkedwitha*arebuiltinfunctionsandcan'tbeset,
onlyreadinthedialplan.Writestosuchvariablesaresilently
ignored.

${ACCOUNTCODE}*Accountcode(ifspecified)(Deprecateduse${CDR(accountcode)})
${BLINDTRANSFER}Thenameofthechannelontheothersideofablindtransfer
${BRIDGEPEER}Bridgedpeer
${CALLERANI}*CallerANI(PRIchannels)(Deprecateduse${CALLERID(ani)})
${CALLERID}*CallerID(Deprecateduse${CALLERID(all)})
${CALLERIDNAME}*CallerIDNameonly(Deprecateduse${CALLERID(name)})
${CALLERIDNUM}*CallerIDNumberonly(Deprecateduse${CALLERID(num)})
${CALLINGANI2}*CallerANI2(PRIchannels)
${CALLINGPRES}*CallerIDpresentationforincomingcalls(PRIchannels)
${CALLINGTNS}*TransitNetworkSelector(PRIchannels)
${CALLINGTON}*CallerTypeofNumber(PRIchannels)
${CHANNEL}*Currentchannelname
${CONTEXT}*Currentcontext
${DATETIME}*Currentdatetimeintheformat:DDMMYYYYHH:MM:SS(Deprecateduse
${STRFTIME(${EPOCH},,%d%m%Y%H:%M:%S)})
${DB_RESULT}ResultvalueofDB_EXISTS()dialplanfunction
${DNID}*DialedNumberIdentifier(Deprecateduse${CALLERID(dnid)})
${EPOCH}*Currentunixstyleepoch
${EXTEN}*Currentextension
${ENV(VAR)}EnvironmentalvariableVAR
${GOTO_ON_BLINDXFR}Transfertothespecifiedcontext/extension/priority
afterablindtransfer(use^charactersinplaceof
|toseparatecontext/extension/prioritywhensetting
thisvariablefromthedialplan)
${HANGUPCAUSE}*Asteriskcauseofhangup(inbound/outbound)
${HINT}*Channelhintsforthisextension
${HINTNAME}*SuggestedCaller*IDnameforthisextension
${INVALID_EXTEN}Theinvalidcalledextension(usedinthe"i"extension)
${LANGUAGE}*Currentlanguage(Deprecateduse${LANGUAGE()})
${LEN(VAR)}*StringlengthofVAR(integer)
${PRIORITY}*Currentpriorityinthedialplan
${PRIREDIRECTREASON}ReasonforredirectonPRI,ifacallwasdirected
${RDNIS}*RedirectedDialNumberIDService(Deprecateduse${CALLERID(rdnis)})
${TIMESTAMP}*Currentdatetimeintheformat:YYYYMMDDHHMMSS(Deprecateduse
${STRFTIME(${EPOCH},,%Y%m%d%H%M%S)})
${TRANSFER_CONTEXT}Contextfortransferredcalls
${FORWARD_CONTEXT}Contextforforwardedcalls
${UNIQUEID}*Currentcalluniqueidentifier
${SYSTEMNAME}*valueofthesystemnameoptionofasterisk.conf~/pp~

Applicationreturnvalues

InAsterisk1.2,manyapplicationsreturntheresultinavariable
insteadof,asinAsterisk1.0,changingthedialplanpriority(+101).
Forthevariousstatusvalues,seeeachapplication'shelptext.

${AGISTATUS}*agi()
${AQMSTATUS}*addqueuemember()
${AVAILSTATUS}*chanisavail()
${CHECKGROUPSTATUS}*checkgroup()
${CHECKMD5STATUS}*checkmd5()
${CPLAYBACKSTATUS}*controlplayback()
${DIALSTATUS}*dial()seealso${HANGUPCAUSE}
${DBGETSTATUS}*dbget()
${ENUMSTATUS}*enumlookup()
${HASVMSTATUS}*hasnewvoicemail()
${LOOKUPBLSTATUS}*lookupblacklist()
${OSPAUTHSTATUS}*ospauth()
${OSPLOOKUPSTATUS}*osplookup()
${OSPNEXTSTATUS}*ospnext()
${OSPFINISHSTATUS}*ospfinish()
${PARKEDAT}*parkandannounce()
${PLAYBACKSTATUS}*playback()
${PQMSTATUS}*pausequeuemember()
${PRIVACYMGRSTATUS}*privacymanager()
${QUEUESTATUS}*queue()
${RQMSTATUS}*removequeuemember()
${SENDIMAGESTATUS}*sendimage()
${SENDTEXTSTATUS}*sendtext()
${SENDURLSTATUS}*sendurl()
${SYSTEMSTATUS}*system()
${TRANSFERSTATUS}*transfer()
${TXTCIDNAMESTATUS}*txtcidname()
${UPQMSTATUS}*unpausequeuemember()
${VMSTATUS}*voicmail()
${VMBOXEXISTSSTATUS}*vmboxexists()
${WAITSTATUS}*waitforsilence()

Variousapplicationvariables

${CURL}*Resultingpagecontentforcurl()
${ENUM}*ResultofapplicationEnumLookup
${EXITCONTEXT}ContexttoexittoinIVRmenu(appbackground())
orintheRetryDial()application
${MONITOR}*Setto"TRUE"ifthechannelis/hasbeenmonitored(appmonitor())
${MONITOR_EXEC}Applicationtoexecuteaftermonitoringacall
${MONITOR_EXEC_ARGS}Argumentstoapplication
${MONITOR_FILENAME}Fileformonitoring(recording)callsinqueue
${QUEUE_PRIO}Queuepriority
${QUEUE_MAX_PENALTY}Maximummemberpenaltyallowedtoanswercaller
${QUEUESTATUS}Statusofthecall,oneof:
(TIMEOUT|FULL|JOINEMPTY|LEAVEEMPTY|JOINUNAVAIL|LEAVEUNAVAIL)
${RECORDED_FILE}*Recordedfileinrecord()
${TALK_DETECTED}*Resultfromtalkdetect()
${TOUCH_MONITOR}ThefilenamebasetousewithTouchMonitor(autorecord)
${TOUCH_MONITOR_FORMAT}TheaudioformattousewithTouchMonitor(autorecord)
${TOUCH_MONITOR_OUTPUT}*RecordedfilefromTouchMonitor(autorecord)
${TXTCIDNAME}*ResultofapplicationTXTCIDName
${VPB_GETDTMF}chan_vpb

TheMeetMeConferenceBridgeusesthefollowingvariables:

${MEETME_RECORDINGFILE}Nameoffileforrecordingaconferencewith
the"r"option
${MEETME_RECORDINGFORMAT}Formatoffiletoberecorded
${MEETME_EXIT_CONTEXT}Contextforexitoutofmeetmemeeting
${MEETME_AGI_BACKGROUND}AGIscriptforMeetme(zaponly)
${MEETMESECS}*NumberofsecondsauserparticipatedinaMeetMeconference

TheVoiceMail()applicationusesthefollowingvariables:

${VM_CATEGORY}*Setsvoicemailcategory
${VM_NAME}*Fullnameinvoicemail
${VM_MAILBOX}*MailboxNumber
${VM_DUR}*Voicemailduration
${VM_MSGNUM}*Numberofvoicemailmessageinmailbox
${VM_CALLERID}*VoicemailCallerID(Personleavingvm)
${VM_CIDNAME}*VoicemailCallerIDName
${VM_CIDNUM}*VoicemailCallerIDNumber
${VM_DATE}*VoicemailDate
${VM_MESSAGEFILE}*Pathtomessageleftbycaller

TheVMAuthenticate()applicationusesthefollowingvariables:

${AUTH_MAILBOX}*Authenticatedmailbox
${AUTH_CONTEXT}*Authenticatedmailboxcontext

DUNDiLookup()usesthefollowingvariables

${DUNDTECH}*TheTechnologyoftheresultfromacalltoDUNDiLookup()
${DUNDDEST}*TheDestinationoftheresultfromacalltoDUNDiLookup()

TheZaptelchannelsetsthefollowingvariables:

${ANI2}*TheANI2Codeprovidedbythenetworkontheincomingcall.(ie,Code29identifiescallasa
Prison/InmateCall)Seealso:NANPAANIIIDigitsAssignments
${CALLTYPE}*Typeofcall(Speech,Digital,etc)
${CALLEDTON}*DialplanforcallednumberonPRI/BRIcalls(17=international,33=national,65=local,
73=private,0=unknown).Note:thisisamisnomer,TON!=dialplan.
${CALLINGSUBADDR}*CalledPRISubaddress
${FAXEXTEN}*Theextensioncalledbeforebeingredirectedto"fax"
${PRIREDIRECTREASON}*Reasonforredirect,ifacallwasdirected
${SMDI_VM_TYPE}*WhenancallisreceivedwithanSMDImessage,the'type'
ofmessage'b'or'u'

TheSIPchannelusesthefollowingvariables:

${SIPCALLID}*SIPCallID:headerverbatim(forloggingorCDRmatching)
${SIPDOMAIN}*SIPdestinationdomainofaninboundcall(ifappropriate)
${SIPUSERAGENT}*SIPuseragent(THISDOESNTWORKIN1.8(+?),IDONTKNOWIFANYOFTHESE
WORKEXCEPTFORSIPURI)
${SIPURI}*SIPuri
${SIP_CODEC}SettheSIPcodecforacall
${SIP_URI_OPTIONS}*additionaloptionstoaddtotheURIforanoutgoingcall
${RTPAUDIOQOS}RTCPQoSreportfortheaudioofthiscall
${RTPVIDEOQOS}RTCPQoSreportforthevideoofthiscall

TheAgentchannelusesthefollowingvariables:
${AGENTMAXLOGINTRIES}Setthemaximumnumberoffailedlogins
${AGENTUPDATECDR}WhethertoupdatetheCDRrecordwithAgentchanneldata
${AGENTGOODBYE}Soundfiletousefor"GoodBye"whenagentlogsout
${AGENTACKCALL}Whethertheagentshouldacknowledgetheincomingcall
${AGENTAUTOLOGOFF}Autologgingoffforanagent
${AGENTWRAPUPTIME}Settingthetimeforwrapupbetweenincomingcalls
${AGENTNUMBER}*Agentnumber(username)setatlogin
${AGENTSTATUS}*Statusoflogin(fail|on|off)
${AGENTEXTEN}*Extensionforloggedinagent

TheDial()applicationusesthefollowingvariables:

${DIALEDPEERNAME}*Dialedpeername
${DIALEDPEERNUMBER}*Dialedpeernumber
${DIALEDTIME}*Timeforthecall(seconds)
${ANSWEREDTIME}*Timefromdialtoanswer(seconds)
${DIALSTATUS}*Statusofthecall,oneof:
(CHANUNAVAIL|CONGESTION|BUSY|NOANSWER
|ANSWER|CANCEL|DONTCALL|TORTURE)
${DYNAMIC_FEATURES}*Thelistoffeatures(fromthe[applicationmap]sectionof
features.conf)toactivateduringthecall,withfeature
namesseparatedby'#'characters
${LIMIT_PLAYAUDIO_CALLER}Soundfileforcalllimits
${LIMIT_PLAYAUDIO_CALLEE}Soundfileforcalllimits
${LIMIT_WARNING_FILE}Soundfileforcalllimits
${LIMIT_TIMEOUT_FILE}Soundfileforcalllimits
${LIMIT_CONNECT_FILE}Soundfileforcalllimits
${OUTBOUND_GROUP}Defaultgroupsforpeerchannels(asinSetGroup)
See"showapplicationdial"formoreinformation

Thechanisavail()applicationsetsthefollowingvariables:

${AVAILCHAN}*thenameoftheavailablechannelifonewasfound
${AVAILORIGCHAN}*thecanonicalchannelnamethatwasusedtocreatethechannel
${AVAILSTATUS}*Statusofrequestedchannel

Whenusingmacrosinthedialplan,thesevariablesareavailable

${MACRO_EXTEN}*Thecallingextensions
${MACRO_CONTEXT}*Thecallingcontext
${MACRO_PRIORITY}*Thecallingpriority
${MACRO_OFFSET}Offsettoaddtopriorityatreturnfrommacro

TheChanSpy()applicationusesthefollowingvariables:

${SPYGROUP}*A':'(colon)separatedlistofgroupnames.
(Tobesetonspiedonchannelandmatchedagainsttheg(grp)option)

IfyoucompilewithOSPsupport,thesevariablesareused:

${OSPINHANDLE}OSPhandleofin_boundcall
${OSPINTIMELIMIT}Durationlimitforin_boundcall
${OSPOUTHANDLE}OSPhandleofout_boundcall
${OSPTECH}OSPtechnology
${OSPDEST}OSPdestination
${OSPCALLING}OSPcallingnumber
${OSPOUTTOKEN}OSPtokentouseforout_boundcall
${OSPOUTTIMELIMIT}Durationlimitforout_boundcall
${OSPRESULTS}Numberofremaineddestinations

CallFileextensionvariables:

${REASON}Thereasonwhyanautodialoutcallfailed

CDRVariables

Ifthechannelhasacdr,thatcdrrecordhasit'sownsetofvariableswhich
canbeaccessedjustlikechannelvariables.Thefollowingbuiltinvariables
areavailableand,unlessspecified,readonly.

${CDR(clid)}CallerID
${CDR(src)}Source
${CDR(dst)}Destination
${CDR(dcontext)}Destinationcontext
${CDR(channel)}Channelname
${CDR(dstchannel)}Destinationchannel
${CDR(lastapp)}Lastappexecuted
${CDR(lastdata)}Lastapp'sarguments
${CDR(start)}Timethecallstarted.
 ${CDR(answer)}Timethecallwasanswered.
${CDR(end)}Timethecallended.
${CDR(duration)}Durationofthecall.
${CDR(billsec)}Durationofthecallonceitwasanswered.
${CDR(disposition)}ANSWERED,NOANSWER,BUSY
${CDR(amaflags)}DOCUMENTATION,BILL,IGNOREetc
${CDR(accountcode)}Thechannel'saccountcode(readwrite).
${CDR(uniqueid)}Thechannel'suniqueid.
${CDR(userfield)}Thechannelsusesspecifiedfield(readwrite).

Inaddition,youcansetyourownextravariableswithatraditional
Set(CDR(var)=val)toanythingyouwant.

NOTESomeCDRvalues(eg:duration&billsec)can'tbeaccesseduntilthecallhasterminated.Asof
91617,thosevalueswillbecalculatedondemandifrequested.Untilthatmakesitintoastablerelease,you
cansetendbeforehexten=yesincdr.conf,andthenusethe"hangup"contexttowrapupyourcall.

Certainfunctionalvariablesmaybeaccessedwith${foo(<args>)}.Alist
ofthesefunctionalvariablesmaybefoundbytyping"showfunctions"
attheAsteriskCLI.

Createdby:komnieve,Lastmodification:Sat07ofDec,2013(16:15)bynoctel

Linkstothispage...

Pleaseupdatethispagewithnewinformation,justloginandclickonthe"Edit"or"Discussion"tab.Geta
freeloginhere:RegisterThanks!FindusonGoogle+

PageChanges | Comments

Featured

BUSINESSVOIP
RESIDENTIALVOIP

LASTMODIFPAGES
1.IPPBX
2.VoIPHardware
3.HostedPBX
4.VoIPProvidersinVirginia
5.VoIPProvidersinAlaska
6.VoIPProvidersinUtah
7.voipinfo.org
8.ThirdlaneMultiTenant
PBX
9.ThirdlaneBusinessPBX
10.ThirdLane
ShowMore

VOIPSPEEDTEST

GETHELP

Askaquestion
VOIPgatewaycomparisons
byarlestercFri03ofMar,
2017

Re:WhydoeseveryonesayI
can't?
bypetikeFri24ofFeb,2017
Re:WhydoeseveryonesayI
can't?
bybutchmobileThu23of
Feb,2017

ViewMore...

TermsofService|PrivacyPolicy
20032017VOIPInfo.orgLLC

Poweredbybitweaver