Thu Oct 8 21:56:36 2009

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_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 8823 of file chan_iax2.c.

References iax2_registry::addr, ast_inet_ntoa(), ast_log(), ast_strdupa, ast_strlen_zero(), ast_verbose(), iax2_registry::callno, 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().

08824 {
08825    int res;
08826    char *sdata;
08827    char *opts;
08828    int force =0;
08829    unsigned short callno = PTR_TO_CALLNO(chan->tech_pvt);
08830    if (ast_strlen_zero(data))
08831       data = "default";
08832    sdata = ast_strdupa(data);
08833    opts = strchr(sdata, '|');
08834    if (opts)
08835       *opts='\0';
08836 
08837    if (chan->tech != &iax2_tech) {
08838       ast_log(LOG_NOTICE, "Can't provision a non-IAX device!\n");
08839       return -1;
08840    } 
08841    if (!callno || !iaxs[callno] || !iaxs[callno]->addr.sin_addr.s_addr) {
08842       ast_log(LOG_NOTICE, "Can't provision something with no IP?\n");
08843       return -1;
08844    }
08845    res = iax2_provision(&iaxs[callno]->addr, iaxs[callno]->sockfd, NULL, sdata, force);
08846    if (option_verbose > 2)
08847       ast_verbose(VERBOSE_PREFIX_3 "Provisioned IAXY at '%s' with '%s'= %d\n", 
08848       ast_inet_ntoa(iaxs[callno]->addr.sin_addr),
08849       sdata, res);
08850    return res;
08851 }

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

Definition at line 5445 of file pbx.c.

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

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

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

Definition at line 5678 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().

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

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

Definition at line 5417 of file pbx.c.

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

Referenced by __ast_pbx_run().

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

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

Definition at line 5431 of file pbx.c.

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

Referenced by __ast_pbx_run().

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

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

Definition at line 5558 of file pbx.c.

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

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

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

Goto

Definition at line 5756 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().

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

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

Definition at line 5532 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().

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

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

Definition at line 5502 of file pbx.c.

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

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

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

Definition at line 5399 of file pbx.c.

References AST_CONTROL_PROGRESS, and ast_indicate().

05400 {
05401    ast_indicate(chan, AST_CONTROL_PROGRESS);
05402    return 0;
05403 }

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

Definition at line 5474 of file pbx.c.

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

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

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

Definition at line 5408 of file pbx.c.

References AST_CONTROL_RINGING, and ast_indicate().

05409 {
05410    ast_indicate(chan, AST_CONTROL_RINGING);
05411    return 0;
05412 }

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

Definition at line 5492 of file pbx.c.

References ast_cdr_setamaflags().

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

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

Definition at line 5601 of file pbx.c.

References ast_safe_sleep(), and s.

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

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

Definition at line 5617 of file pbx.c.

References ast_channel::_softhangup, 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_channel::cid, ast_callerid::cid_num, ast_channel::context, ast_channel::exten, LOG_WARNING, option_verbose, parse(), ast_channel::pbx, ast_channel::priority, ast_pbx::rtimeout, set_ext_pri(), VERBOSE_PREFIX_3, and WAITEXTEN_MOH.

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


Generated on Thu Oct 8 21:56:36 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6