Mon Mar 31 07:42:56 2008

Asterisk developer's documentation


Module: Dial plan applications

Applications support the dialplan. They register dynamically with ast_register_application() and unregister with ast_unregister_application(). More...


Files

file  app_adsiprog.c
 Program Asterisk ADSI Scripts into phone.
file  app_alarmreceiver.c
 Central Station Alarm receiver for Ademco Contact ID.
file  app_authenticate.c
 Execute arbitrary authenticate commands.
file  app_cdr.c
 Applications connected with CDR engine.
file  app_chanisavail.c
 Check if Channel is Available.
file  app_channelredirect.c
 ChannelRedirect application.
file  app_chanspy.c
 ChanSpy: Listen in on any channel.
file  app_controlplayback.c
 Trivial application to control playback of a sound file.
file  app_cycle.c
 Trivial application to cycle over some users.
file  app_db.c
 Database access functions.
file  app_dial.c
 dial() & retrydial() - Trivial application to dial a channel and send an URL on answer
file  app_dictate.c
 Virtual Dictation Machine Application For Asterisk.
file  app_directed_pickup.c
 Directed Call Pickup Support.
file  app_directory.c
 Provide a directory of extensions.
file  app_disa.c
 DISA -- Direct Inward System Access Application.
file  app_dumpchan.c
 Application to dump channel variables.
file  app_echo.c
 Echo application -- play back what you hear to evaluate latency.
file  app_exec.c
 Exec application.
file  app_externalivr.c
 External IVR application interface.
file  app_festival.c
 Connect to festival.
file  app_flash.c
 App to flash a zap trunk.
file  app_followme.c
 Find-Me Follow-Me application.
file  app_forkcdr.c
 Fork CDR application.
file  app_getcpeid.c
 Get ADSI CPE ID.
file  app_hasnewvoicemail.c
 HasVoicemail application.
file  app_ices.c
 Stream to an icecast server via ICES (see contrib/asterisk-ices.xml).
file  app_image.c
 App to transmit an image.
file  app_ivrdemo.c
 IVR Demo application.
file  app_lookupblacklist.c
 App to lookup the callerid number, and see if it is blacklisted.
file  app_lookupcidname.c
 App to set callerid name from database, based on directory number.
file  app_macro.c
 Dial plan macro Implementation.
file  app_meetme.c
 Meet me conference bridge and Shared Line Appearances.
file  app_milliwatt.c
 Digital Milliwatt Test.
file  app_mixmonitor.c
 MixMonitor() - Record a call and mix the audio during the recording.
file  app_morsecode.c
 Morsecode application.
file  app_mp3.c
 Silly application to play an MP3 file -- uses mpg123.
file  app_nbscat.c
 Silly application to play an NBScat file -- uses nbscat8k.
file  app_osplookup.c
 Open Settlement Protocol (OSP) Applications.
file  app_page.c
 page() - Paging application
file  app_parkandannounce.c
 ParkAndAnnounce application for Asterisk.
file  app_playback.c
 Trivial application to playback a sound file.
file  app_privacy.c
 Block all calls without Caller*ID, require phone # to be entered.
file  app_queue.c
 True call queues with optional send URL on answer.
file  app_random.c
 Random application.
file  app_read.c
 Trivial application to read a variable.
file  app_readfile.c
 ReadFile application -- Reads in a File for you.
file  app_realtime.c
 RealTime App.
file  app_record.c
 Trivial application to record a sound file.
file  app_sayunixtime.c
 SayUnixTime application.
file  app_senddtmf.c
 App to send DTMF digits.
file  app_sendtext.c
 App to transmit a text message.
file  app_setcallerid.c
 App to set callerid.
file  app_setcdruserfield.c
 Applictions connected with CDR engine.
file  app_settransfercapability.c
 App to set the ISDN Transfer Capability.
file  app_skel.c
 Skeleton application.
file  app_sms.c
 SMS application - ETSI ES 201 912 protocol 1 implimentation.
file  app_softhangup.c
 SoftHangup application.
file  app_speech_utils.c
 Speech Recognition Utility Applications.
file  app_stack.c
 Stack applications Gosub, Return, etc.
file  app_system.c
 Execute arbitrary system commands.
file  app_talkdetect.c
 Playback a file with audio detect.
file  app_test.c
 Applications to test connection and produce report in text file.
file  app_transfer.c
 Transfer a caller.
file  app_url.c
 App to transmit a URL.
file  app_userevent.c
 UserEvent application -- send manager event.
file  app_verbose.c
 Verbose logging application.
file  app_voicemail.c
 Comedian Mail - Voicemail System.
file  app_waitforring.c
 Wait for Ring Application.
file  app_waitforsilence.c
 Wait for Silence
  • Waits for up to 'x' milliseconds of silence, 'y' times
  • WaitForSilence(500,2) will wait for 1/2 second of silence, twice
  • WaitForSilence(1000,1) will wait for 1 second of silence, once
  • WaitForSilence(300,3,10) will wait for 300ms of silence, 3 times, and return after 10sec
    .

file  app_while.c
 While Loop Implementation.
file  app_zapateller.c
 Playback the special information tone to get rid of telemarketers.
file  app_zapbarge.c
 Zap Barge support.
file  app_zapras.c
 Execute an ISDN RAS.
file  app_zapscan.c
 Zap Scanner.

Functions

static int iax2_prov_app (struct ast_channel *chan, void *data)
static int pbx_builtin_answer (struct ast_channel *, void *)
static int pbx_builtin_background (struct ast_channel *, void *)
static int pbx_builtin_busy (struct ast_channel *, void *)
static int pbx_builtin_congestion (struct ast_channel *, void *)
static int pbx_builtin_execiftime (struct ast_channel *, void *)
static int pbx_builtin_goto (struct ast_channel *, void *)
static int pbx_builtin_gotoiftime (struct ast_channel *, void *)
static int pbx_builtin_hangup (struct ast_channel *, void *)
static int pbx_builtin_progress (struct ast_channel *, void *)
static int pbx_builtin_resetcdr (struct ast_channel *, void *)
static int pbx_builtin_ringing (struct ast_channel *, void *)
static int pbx_builtin_setamaflags (struct ast_channel *, void *)
static int pbx_builtin_wait (struct ast_channel *, void *)
static int pbx_builtin_waitexten (struct ast_channel *, void *)

Detailed Description

Applications support the dialplan. They register dynamically with ast_register_application() and unregister with ast_unregister_application().

Asterisk Dial Plan Applications

See also

Function Documentation

static int iax2_prov_app ( struct ast_channel chan,
void *  data 
) [static]

iax2provision

Definition at line 8586 of file chan_iax2.c.

References ast_inet_ntoa(), ast_log(), ast_strdupa, ast_strlen_zero(), ast_verbose(), iax2_provision(), iax2_tech, iaxs, LOG_NOTICE, option_verbose, PTR_TO_CALLNO, create_addr_info::sockfd, ast_channel::tech, ast_channel::tech_pvt, and VERBOSE_PREFIX_3.

Referenced by load_module().

08587 {
08588    int res;
08589    char *sdata;
08590    char *opts;
08591    int force =0;
08592    unsigned short callno = PTR_TO_CALLNO(chan->tech_pvt);
08593    if (ast_strlen_zero(data))
08594       data = "default";
08595    sdata = ast_strdupa(data);
08596    opts = strchr(sdata, '|');
08597    if (opts)
08598       *opts='\0';
08599 
08600    if (chan->tech != &iax2_tech) {
08601       ast_log(LOG_NOTICE, "Can't provision a non-IAX device!\n");
08602       return -1;
08603    } 
08604    if (!callno || !iaxs[callno] || !iaxs[callno]->addr.sin_addr.s_addr) {
08605       ast_log(LOG_NOTICE, "Can't provision something with no IP?\n");
08606       return -1;
08607    }
08608    res = iax2_provision(&iaxs[callno]->addr, iaxs[callno]->sockfd, NULL, sdata, force);
08609    if (option_verbose > 2)
08610       ast_verbose(VERBOSE_PREFIX_3 "Provisioned IAXY at '%s' with '%s'= %d\n", 
08611       ast_inet_ntoa(iaxs[callno]->addr.sin_addr),
08612       sdata, res);
08613    return res;
08614 }

static int pbx_builtin_answer ( struct ast_channel ,
void *   
) [static]

Definition at line 5447 of file pbx.c.

References ast_channel::_state, ast_answer(), ast_safe_sleep(), AST_STATE_UP, and ast_strlen_zero().

05448 {
05449    int delay = 0;
05450    int res;
05451 
05452    if (chan->_state == AST_STATE_UP)
05453       delay = 0;
05454    else if (!ast_strlen_zero(data))
05455       delay = atoi(data);
05456 
05457    res = ast_answer(chan);
05458    if (res)
05459       return res;
05460 
05461    if (delay)
05462       res = ast_safe_sleep(chan, delay);
05463 
05464    return res;
05465 }

static int pbx_builtin_background ( struct ast_channel ,
void *   
) [static]

Definition at line 5680 of file pbx.c.

References ast_channel::_state, ast_answer(), AST_APP_ARG, ast_app_parse_options(), AST_DECLARE_APP_ARGS, AST_DIGIT_ANY, ast_log(), AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_stopstream(), ast_strdupa, ast_streamfile(), ast_strlen_zero(), ast_test_flag, ast_waitstream(), ast_waitstream_exten(), BACKGROUND_MATCHEXTEN, BACKGROUND_NOANSWER, BACKGROUND_PLAYBACK, BACKGROUND_SKIP, ast_channel::context, ast_channel::exten, ast_flags::flags, LOG_WARNING, parse(), ast_channel::priority, and strsep().

05681 {
05682    int res = 0;
05683    struct ast_flags flags = {0};
05684    char *parse;
05685    AST_DECLARE_APP_ARGS(args,
05686       AST_APP_ARG(filename);
05687       AST_APP_ARG(options);
05688       AST_APP_ARG(lang);
05689       AST_APP_ARG(context);
05690    );
05691 
05692    if (ast_strlen_zero(data)) {
05693       ast_log(LOG_WARNING, "Background requires an argument (filename)\n");
05694       return -1;
05695    }
05696 
05697    parse = ast_strdupa(data);
05698 
05699    AST_STANDARD_APP_ARGS(args, parse);
05700 
05701    if (ast_strlen_zero(args.lang))
05702       args.lang = (char *)chan->language; /* XXX this is const */
05703 
05704    if (ast_strlen_zero(args.context))
05705       args.context = chan->context;
05706 
05707    if (args.options) {
05708       if (!strcasecmp(args.options, "skip"))
05709          flags.flags = BACKGROUND_SKIP;
05710       else if (!strcasecmp(args.options, "noanswer"))
05711          flags.flags = BACKGROUND_NOANSWER;
05712       else
05713          ast_app_parse_options(background_opts, &flags, NULL, args.options);
05714    }
05715 
05716    /* Answer if need be */
05717    if (chan->_state != AST_STATE_UP) {
05718       if (ast_test_flag(&flags, BACKGROUND_SKIP)) {
05719          return 0;
05720       } else if (!ast_test_flag(&flags, BACKGROUND_NOANSWER)) {
05721          res = ast_answer(chan);
05722       }
05723    }
05724 
05725    if (!res) {
05726       char *back = args.filename;
05727       char *front;
05728       ast_stopstream(chan);      /* Stop anything playing */
05729       /* Stream the list of files */
05730       while (!res && (front = strsep(&back, "&")) ) {
05731          if ( (res = ast_streamfile(chan, front, args.lang)) ) {
05732             ast_log(LOG_WARNING, "ast_streamfile failed on %s for %s\n", chan->name, (char*)data);
05733             res = 0;
05734             break;
05735          }
05736          if (ast_test_flag(&flags, BACKGROUND_PLAYBACK)) {
05737             res = ast_waitstream(chan, "");
05738          } else if (ast_test_flag(&flags, BACKGROUND_MATCHEXTEN)) {
05739             res = ast_waitstream_exten(chan, args.context);
05740          } else {
05741             res = ast_waitstream(chan, AST_DIGIT_ANY);
05742          }
05743          ast_stopstream(chan);
05744       }
05745    }
05746    if (args.context != chan->context && res) {
05747       snprintf(chan->exten, sizeof(chan->exten), "%c", res);
05748       ast_copy_string(chan->context, args.context, sizeof(chan->context));
05749       chan->priority = 0;
05750       res = 0;
05751    }
05752    return res;
05753 }

static int pbx_builtin_busy ( struct ast_channel ,
void *   
) [static]

Definition at line 5413 of file pbx.c.

References ast_channel::_state, AST_CONTROL_BUSY, ast_indicate(), ast_setstate(), AST_STATE_BUSY, AST_STATE_UP, ast_strlen_zero(), and wait_for_hangup().

05414 {
05415    ast_indicate(chan, AST_CONTROL_BUSY);
05416    /* Don't change state of an UP channel, just indicate
05417       busy in audio */
05418    if (chan->_state != AST_STATE_UP)
05419       ast_setstate(chan, AST_STATE_BUSY);
05420    if( ast_strlen_zero(data) )
05421       wait_for_hangup(chan, "10");
05422    else
05423       wait_for_hangup(chan, data);
05424    return -1;
05425 }

static int pbx_builtin_congestion ( struct ast_channel ,
void *   
) [static]

Definition at line 5430 of file pbx.c.

References ast_channel::_state, AST_CONTROL_CONGESTION, ast_indicate(), ast_setstate(), AST_STATE_BUSY, AST_STATE_UP, ast_strlen_zero(), and wait_for_hangup().

05431 {
05432    ast_indicate(chan, AST_CONTROL_CONGESTION);
05433    /* Don't change state of an UP channel, just indicate
05434       congestion in audio */
05435    if (chan->_state != AST_STATE_UP)
05436       ast_setstate(chan, AST_STATE_BUSY);
05437    if( ast_strlen_zero(data) )
05438       wait_for_hangup(chan, "10");
05439    else
05440       wait_for_hangup(chan, data);
05441    return -1;
05442 }

static int pbx_builtin_execiftime ( struct ast_channel ,
void *   
) [static]

Definition at line 5560 of file pbx.c.

References app, ast_build_timing(), ast_check_timing(), ast_log(), ast_strdupa, ast_strlen_zero(), LOG_WARNING, pbx_exec(), pbx_findapp(), s, S_OR, and strsep().

05561 {
05562    char *s, *appname;
05563    struct ast_timing timing;
05564    struct ast_app *app;
05565    static const char *usage = "ExecIfTime requires an argument:\n  <time range>|<days of week>|<days of month>|<months>?<appname>[|<appargs>]";
05566 
05567    if (ast_strlen_zero(data)) {
05568       ast_log(LOG_WARNING, "%s\n", usage);
05569       return -1;
05570    }
05571 
05572    appname = ast_strdupa(data);
05573 
05574    s = strsep(&appname,"?");  /* Separate the timerange and application name/data */
05575    if (!appname) {   /* missing application */
05576       ast_log(LOG_WARNING, "%s\n", usage);
05577       return -1;
05578    }
05579 
05580    if (!ast_build_timing(&timing, s)) {
05581       ast_log(LOG_WARNING, "Invalid Time Spec: %s\nCorrect usage: %s\n", s, usage);
05582       return -1;
05583    }
05584 
05585    if (!ast_check_timing(&timing))  /* outside the valid time window, just return */
05586       return 0;
05587 
05588    /* now split appname|appargs */
05589    if ((s = strchr(appname, '|')))
05590       *s++ = '\0';
05591 
05592    if ((app = pbx_findapp(appname))) {
05593       return pbx_exec(chan, app, S_OR(s, ""));
05594    } else {
05595       ast_log(LOG_WARNING, "Cannot locate application %s\n", appname);
05596       return -1;
05597    }
05598 }

static int pbx_builtin_goto ( struct ast_channel chan,
void *  data 
) [static]

Goto

Definition at line 5758 of file pbx.c.

References ast_parseable_goto(), ast_verbose(), ast_channel::context, ast_channel::exten, option_verbose, ast_channel::priority, and VERBOSE_PREFIX_3.

Referenced by pbx_builtin_gotoif(), and pbx_builtin_gotoiftime().

05759 {
05760    int res = ast_parseable_goto(chan, data);
05761    if (!res && (option_verbose > 2))
05762       ast_verbose( VERBOSE_PREFIX_3 "Goto (%s,%s,%d)\n", chan->context,chan->exten, chan->priority+1);
05763    return res;
05764 }

static int pbx_builtin_gotoiftime ( struct ast_channel ,
void *   
) [static]

Definition at line 5534 of file pbx.c.

References ast_build_timing(), ast_check_timing(), ast_log(), ast_strdupa, ast_strlen_zero(), LOG_WARNING, pbx_builtin_goto(), s, and strsep().

05535 {
05536    int res=0;
05537    char *s, *ts;
05538    struct ast_timing timing;
05539 
05540    if (ast_strlen_zero(data)) {
05541       ast_log(LOG_WARNING, "GotoIfTime requires an argument:\n  <time range>|<days of week>|<days of month>|<months>?[[context|]extension|]priority\n");
05542       return -1;
05543    }
05544 
05545    ts = s = ast_strdupa(data);
05546 
05547    /* Separate the Goto path */
05548    strsep(&ts,"?");
05549 
05550    /* struct ast_include include contained garbage here, fixed by zeroing it on get_timerange */
05551    if (ast_build_timing(&timing, s) && ast_check_timing(&timing))
05552       res = pbx_builtin_goto(chan, ts);
05553    
05554    return res;
05555 }

static int pbx_builtin_hangup ( struct ast_channel ,
void *   
) [static]

Definition at line 5504 of file pbx.c.

References AST_CAUSE_NORMAL_CLEARING, ast_log(), ast_str2cause(), ast_strlen_zero(), ast_channel::hangupcause, and LOG_NOTICE.

05505 {
05506    if (!ast_strlen_zero(data)) {
05507       int cause;
05508       char *endptr;
05509 
05510       if ((cause = ast_str2cause(data)) > -1) {
05511          chan->hangupcause = cause;
05512          return -1;
05513       }
05514       
05515       cause = strtol((const char *) data, &endptr, 10);
05516       if (cause != 0 || (data != endptr)) {
05517          chan->hangupcause = cause;
05518          return -1;
05519       }
05520          
05521       ast_log(LOG_NOTICE, "Invalid cause given to Hangup(): \"%s\"\n", (char *) data);
05522    }
05523 
05524    if (!chan->hangupcause) {
05525       chan->hangupcause = AST_CAUSE_NORMAL_CLEARING;
05526    }
05527 
05528    return -1;
05529 }

static int pbx_builtin_progress ( struct ast_channel ,
void *   
) [static]

Definition at line 5395 of file pbx.c.

References AST_CONTROL_PROGRESS, and ast_indicate().

05396 {
05397    ast_indicate(chan, AST_CONTROL_PROGRESS);
05398    return 0;
05399 }

static int pbx_builtin_resetcdr ( struct ast_channel ,
void *   
) [static]

Definition at line 5476 of file pbx.c.

References ast_app_parse_options(), ast_cdr_reset(), ast_strdupa, ast_strlen_zero(), ast_channel::cdr, and ast_flags::flags.

05477 {
05478    char *args;
05479    struct ast_flags flags = { 0 };
05480 
05481    if (!ast_strlen_zero(data)) {
05482       args = ast_strdupa(data);
05483       ast_app_parse_options(resetcdr_opts, &flags, NULL, args);
05484    }
05485 
05486    ast_cdr_reset(chan->cdr, &flags);
05487 
05488    return 0;
05489 }

static int pbx_builtin_ringing ( struct ast_channel ,
void *   
) [static]

Definition at line 5404 of file pbx.c.

References AST_CONTROL_RINGING, and ast_indicate().

05405 {
05406    ast_indicate(chan, AST_CONTROL_RINGING);
05407    return 0;
05408 }

static int pbx_builtin_setamaflags ( struct ast_channel ,
void *   
) [static]

Definition at line 5494 of file pbx.c.

References ast_cdr_setamaflags().

05495 {
05496    /* Copy the AMA Flags as specified */
05497    ast_cdr_setamaflags(chan, data ? data : "");
05498    return 0;
05499 }

static int pbx_builtin_wait ( struct ast_channel ,
void *   
) [static]

Definition at line 5603 of file pbx.c.

References ast_safe_sleep(), and s.

05604 {
05605    double s;
05606    int ms;
05607 
05608    /* Wait for "n" seconds */
05609    if (data && (s = atof(data)) > 0) {
05610       ms = s * 1000.0;
05611       return ast_safe_sleep(chan, ms);
05612    }
05613    return 0;
05614 }

static int pbx_builtin_waitexten ( struct ast_channel ,
void *   
) [static]

Definition at line 5619 of file pbx.c.

References AST_APP_ARG, ast_app_parse_options(), AST_CONTROL_HOLD, AST_CONTROL_UNHOLD, AST_DECLARE_APP_ARGS, ast_exists_extension(), ast_indicate(), ast_indicate_data(), ast_log(), AST_SOFTHANGUP_TIMEOUT, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_verbose(), ast_waitfordigit(), ast_flags::flags, LOG_WARNING, option_verbose, parse(), set_ext_pri(), timeout, VERBOSE_PREFIX_3, and WAITEXTEN_MOH.

05620 {
05621    int ms, res;
05622    double sec;
05623    struct ast_flags flags = {0};
05624    char *opts[1] = { NULL };
05625    char *parse;
05626    AST_DECLARE_APP_ARGS(args,
05627       AST_APP_ARG(timeout);
05628       AST_APP_ARG(options);
05629    );
05630 
05631    if (!ast_strlen_zero(data)) {
05632       parse = ast_strdupa(data);
05633       AST_STANDARD_APP_ARGS(args, parse);
05634    } else
05635       memset(&args, 0, sizeof(args));
05636 
05637    if (args.options)
05638       ast_app_parse_options(waitexten_opts, &flags, opts, args.options);
05639    
05640    if (ast_test_flag(&flags, WAITEXTEN_MOH) && !opts[0] ) {
05641       ast_log(LOG_WARNING, "The 'm' option has been specified for WaitExten without a class.\n"); 
05642    } else if (ast_test_flag(&flags, WAITEXTEN_MOH))
05643       ast_indicate_data(chan, AST_CONTROL_HOLD, opts[0], strlen(opts[0]));
05644 
05645    /* Wait for "n" seconds */
05646    if (args.timeout && (sec = atof(args.timeout)) > 0.0)
05647       ms = 1000 * sec;
05648    else if (chan->pbx)
05649       ms = chan->pbx->rtimeout * 1000;
05650    else
05651       ms = 10000;
05652    res = ast_waitfordigit(chan, ms);
05653    if (!res) {
05654       if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 1, chan->cid.cid_num)) {
05655          if (option_verbose > 2)
05656             ast_verbose(VERBOSE_PREFIX_3 "Timeout on %s, continuing...\n", chan->name);
05657       } else if (chan->_softhangup == AST_SOFTHANGUP_TIMEOUT) {
05658          if (option_verbose > 2)
05659             ast_verbose(VERBOSE_PREFIX_3 "Call timeout on %s, checking for 'T'\n", chan->name);
05660          res = -1;
05661       } else if (ast_exists_extension(chan, chan->context, "t", 1, chan->cid.cid_num)) {
05662          if (option_verbose > 2)
05663             ast_verbose(VERBOSE_PREFIX_3 "Timeout on %s, going to 't'\n", chan->name);
05664          set_ext_pri(chan, "t", 0); /* 0 will become 1, next time through the loop */
05665       } else {
05666          ast_log(LOG_WARNING, "Timeout but no rule 't' in context '%s'\n", chan->context);
05667          res = -1;
05668       }
05669    }
05670 
05671    if (ast_test_flag(&flags, WAITEXTEN_MOH))
05672       ast_indicate(chan, AST_CONTROL_UNHOLD);
05673 
05674    return res;
05675 }


Generated on Mon Mar 31 07:42:56 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.1