Wed Aug 15 01:25:37 2007

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 8094 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, ast_channel::tech, ast_channel::tech_pvt, and VERBOSE_PREFIX_3.

Referenced by load_module().

08095 {
08096    int res;
08097    char *sdata;
08098    char *opts;
08099    int force =0;
08100    unsigned short callno = PTR_TO_CALLNO(chan->tech_pvt);
08101    if (ast_strlen_zero(data))
08102       data = "default";
08103    sdata = ast_strdupa(data);
08104    opts = strchr(sdata, '|');
08105    if (opts)
08106       *opts='\0';
08107 
08108    if (chan->tech != &iax2_tech) {
08109       ast_log(LOG_NOTICE, "Can't provision a non-IAX device!\n");
08110       return -1;
08111    } 
08112    if (!callno || !iaxs[callno] || !iaxs[callno]->addr.sin_addr.s_addr) {
08113       ast_log(LOG_NOTICE, "Can't provision something with no IP?\n");
08114       return -1;
08115    }
08116    res = iax2_provision(&iaxs[callno]->addr, iaxs[callno]->sockfd, NULL, sdata, force);
08117    if (option_verbose > 2)
08118       ast_verbose(VERBOSE_PREFIX_3 "Provisioned IAXY at '%s' with '%s'= %d\n", 
08119       ast_inet_ntoa(iaxs[callno]->addr.sin_addr),
08120       sdata, res);
08121    return res;
08122 }

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

Definition at line 5394 of file pbx.c.

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

05395 {
05396    int delay = 0;
05397    int res;
05398 
05399    if (chan->_state == AST_STATE_UP)
05400       delay = 0;
05401    else if (!ast_strlen_zero(data))
05402       delay = atoi(data);
05403 
05404    res = ast_answer(chan);
05405    if (res)
05406       return res;
05407 
05408    if (delay)
05409       res = ast_safe_sleep(chan, delay);
05410 
05411    return res;
05412 }

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

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

05624 {
05625    int res = 0;
05626    struct ast_flags flags = {0};
05627    char *parse;
05628    AST_DECLARE_APP_ARGS(args,
05629       AST_APP_ARG(filename);
05630       AST_APP_ARG(options);
05631       AST_APP_ARG(lang);
05632       AST_APP_ARG(context);
05633    );
05634 
05635    if (ast_strlen_zero(data)) {
05636       ast_log(LOG_WARNING, "Background requires an argument (filename)\n");
05637       return -1;
05638    }
05639 
05640    parse = ast_strdupa(data);
05641 
05642    AST_STANDARD_APP_ARGS(args, parse);
05643 
05644    if (ast_strlen_zero(args.lang))
05645       args.lang = (char *)chan->language; /* XXX this is const */
05646 
05647    if (ast_strlen_zero(args.context))
05648       args.context = chan->context;
05649 
05650    if (args.options) {
05651       if (!strcasecmp(args.options, "skip"))
05652          flags.flags = BACKGROUND_SKIP;
05653       else if (!strcasecmp(args.options, "noanswer"))
05654          flags.flags = BACKGROUND_NOANSWER;
05655       else
05656          ast_app_parse_options(background_opts, &flags, NULL, args.options);
05657    }
05658 
05659    /* Answer if need be */
05660    if (chan->_state != AST_STATE_UP) {
05661       if (ast_test_flag(&flags, BACKGROUND_SKIP)) {
05662          return 0;
05663       } else if (!ast_test_flag(&flags, BACKGROUND_NOANSWER)) {
05664          res = ast_answer(chan);
05665       }
05666    }
05667 
05668    if (!res) {
05669       char *back = args.filename;
05670       char *front;
05671       ast_stopstream(chan);      /* Stop anything playing */
05672       /* Stream the list of files */
05673       while (!res && (front = strsep(&back, "&")) ) {
05674          if ( (res = ast_streamfile(chan, front, args.lang)) ) {
05675             ast_log(LOG_WARNING, "ast_streamfile failed on %s for %s\n", chan->name, (char*)data);
05676             res = 0;
05677             break;
05678          }
05679          if (ast_test_flag(&flags, BACKGROUND_PLAYBACK)) {
05680             res = ast_waitstream(chan, "");
05681          } else if (ast_test_flag(&flags, BACKGROUND_MATCHEXTEN)) {
05682             res = ast_waitstream_exten(chan, args.context);
05683          } else {
05684             res = ast_waitstream(chan, AST_DIGIT_ANY);
05685          }
05686          ast_stopstream(chan);
05687       }
05688    }
05689    if (args.context != chan->context && res) {
05690       snprintf(chan->exten, sizeof(chan->exten), "%c", res);
05691       ast_copy_string(chan->context, args.context, sizeof(chan->context));
05692       chan->priority = 0;
05693       res = 0;
05694    }
05695    return res;
05696 }

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

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

05367 {
05368    ast_indicate(chan, AST_CONTROL_BUSY);
05369    /* Don't change state of an UP channel, just indicate
05370       busy in audio */
05371    if (chan->_state != AST_STATE_UP)
05372       ast_setstate(chan, AST_STATE_BUSY);
05373    wait_for_hangup(chan, data);
05374    return -1;
05375 }

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

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

05381 {
05382    ast_indicate(chan, AST_CONTROL_CONGESTION);
05383    /* Don't change state of an UP channel, just indicate
05384       congestion in audio */
05385    if (chan->_state != AST_STATE_UP)
05386       ast_setstate(chan, AST_STATE_BUSY);
05387    wait_for_hangup(chan, data);
05388    return -1;
05389 }

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

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

05508 {
05509    char *s, *appname;
05510    struct ast_timing timing;
05511    struct ast_app *app;
05512    static const char *usage = "ExecIfTime requires an argument:\n  <time range>|<days of week>|<days of month>|<months>?<appname>[|<appargs>]";
05513 
05514    if (ast_strlen_zero(data)) {
05515       ast_log(LOG_WARNING, "%s\n", usage);
05516       return -1;
05517    }
05518 
05519    appname = ast_strdupa(data);
05520 
05521    s = strsep(&appname,"?");  /* Separate the timerange and application name/data */
05522    if (!appname) {   /* missing application */
05523       ast_log(LOG_WARNING, "%s\n", usage);
05524       return -1;
05525    }
05526 
05527    if (!ast_build_timing(&timing, s)) {
05528       ast_log(LOG_WARNING, "Invalid Time Spec: %s\nCorrect usage: %s\n", s, usage);
05529       return -1;
05530    }
05531 
05532    if (!ast_check_timing(&timing))  /* outside the valid time window, just return */
05533       return 0;
05534 
05535    /* now split appname|appargs */
05536    if ((s = strchr(appname, '|')))
05537       *s++ = '\0';
05538 
05539    if ((app = pbx_findapp(appname))) {
05540       return pbx_exec(chan, app, S_OR(s, ""));
05541    } else {
05542       ast_log(LOG_WARNING, "Cannot locate application %s\n", appname);
05543       return -1;
05544    }
05545 }

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

Goto

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

05702 {
05703    int res = ast_parseable_goto(chan, data);
05704    if (!res && (option_verbose > 2))
05705       ast_verbose( VERBOSE_PREFIX_3 "Goto (%s,%s,%d)\n", chan->context,chan->exten, chan->priority+1);
05706    return res;
05707 }

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

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

05482 {
05483    int res=0;
05484    char *s, *ts;
05485    struct ast_timing timing;
05486 
05487    if (ast_strlen_zero(data)) {
05488       ast_log(LOG_WARNING, "GotoIfTime requires an argument:\n  <time range>|<days of week>|<days of month>|<months>?[[context|]extension|]priority\n");
05489       return -1;
05490    }
05491 
05492    ts = s = ast_strdupa(data);
05493 
05494    /* Separate the Goto path */
05495    strsep(&ts,"?");
05496 
05497    /* struct ast_include include contained garbage here, fixed by zeroing it on get_timerange */
05498    if (ast_build_timing(&timing, s) && ast_check_timing(&timing))
05499       res = pbx_builtin_goto(chan, ts);
05500    
05501    return res;
05502 }

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

Definition at line 5451 of file pbx.c.

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

05452 {
05453    if (!ast_strlen_zero(data)) {
05454       int cause;
05455       char *endptr;
05456 
05457       if ((cause = ast_str2cause(data)) > -1) {
05458          chan->hangupcause = cause;
05459          return -1;
05460       }
05461       
05462       cause = strtol((const char *) data, &endptr, 10);
05463       if (cause != 0 || (data != endptr)) {
05464          chan->hangupcause = cause;
05465          return -1;
05466       }
05467          
05468       ast_log(LOG_NOTICE, "Invalid cause given to Hangup(): \"%s\"\n", (char *) data);
05469    }
05470 
05471    if (!chan->hangupcause) {
05472       chan->hangupcause = AST_CAUSE_NORMAL_CLEARING;
05473    }
05474 
05475    return -1;
05476 }

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

Definition at line 5348 of file pbx.c.

References AST_CONTROL_PROGRESS, and ast_indicate().

05349 {
05350    ast_indicate(chan, AST_CONTROL_PROGRESS);
05351    return 0;
05352 }

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

Definition at line 5423 of file pbx.c.

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

05424 {
05425    char *args;
05426    struct ast_flags flags = { 0 };
05427 
05428    if (!ast_strlen_zero(data)) {
05429       args = ast_strdupa(data);
05430       ast_app_parse_options(resetcdr_opts, &flags, NULL, args);
05431    }
05432 
05433    ast_cdr_reset(chan->cdr, &flags);
05434 
05435    return 0;
05436 }

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

Definition at line 5357 of file pbx.c.

References AST_CONTROL_RINGING, and ast_indicate().

05358 {
05359    ast_indicate(chan, AST_CONTROL_RINGING);
05360    return 0;
05361 }

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

Definition at line 5441 of file pbx.c.

References ast_cdr_setamaflags().

05442 {
05443    /* Copy the AMA Flags as specified */
05444    ast_cdr_setamaflags(chan, data ? data : "");
05445    return 0;
05446 }

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

Definition at line 5550 of file pbx.c.

References ast_safe_sleep(), and s.

05551 {
05552    double s;
05553    int ms;
05554 
05555    /* Wait for "n" seconds */
05556    if (data && (s = atof(data)) > 0) {
05557       ms = s * 1000.0;
05558       return ast_safe_sleep(chan, ms);
05559    }
05560    return 0;
05561 }

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

Definition at line 5566 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_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.

05567 {
05568    int ms, res;
05569    double sec;
05570    struct ast_flags flags = {0};
05571    char *opts[1] = { NULL };
05572    char *parse;
05573    AST_DECLARE_APP_ARGS(args,
05574       AST_APP_ARG(timeout);
05575       AST_APP_ARG(options);
05576    );
05577 
05578    if (!ast_strlen_zero(data)) {
05579       parse = ast_strdupa(data);
05580       AST_STANDARD_APP_ARGS(args, parse);
05581    } else
05582       memset(&args, 0, sizeof(args));
05583 
05584    if (args.options)
05585       ast_app_parse_options(waitexten_opts, &flags, opts, args.options);
05586    
05587    if (ast_test_flag(&flags, WAITEXTEN_MOH) && !opts[0] ) {
05588       ast_log(LOG_WARNING, "The 'm' option has been specified for WaitExten without a class.\n"); 
05589    } else if (ast_test_flag(&flags, WAITEXTEN_MOH))
05590       ast_indicate_data(chan, AST_CONTROL_HOLD, opts[0], strlen(opts[0]));
05591 
05592    /* Wait for "n" seconds */
05593    if (args.timeout && (sec = atof(args.timeout)) > 0.0)
05594       ms = 1000 * sec;
05595    else if (chan->pbx)
05596       ms = chan->pbx->rtimeout * 1000;
05597    else
05598       ms = 10000;
05599    res = ast_waitfordigit(chan, ms);
05600    if (!res) {
05601       if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 1, chan->cid.cid_num)) {
05602          if (option_verbose > 2)
05603             ast_verbose(VERBOSE_PREFIX_3 "Timeout on %s, continuing...\n", chan->name);
05604       } else if (ast_exists_extension(chan, chan->context, "t", 1, chan->cid.cid_num)) {
05605          if (option_verbose > 2)
05606             ast_verbose(VERBOSE_PREFIX_3 "Timeout on %s, going to 't'\n", chan->name);
05607          set_ext_pri(chan, "t", 0); /* XXX is the 0 correct ? */
05608       } else {
05609          ast_log(LOG_WARNING, "Timeout but no rule 't' in context '%s'\n", chan->context);
05610          res = -1;
05611       }
05612    }
05613 
05614    if (ast_test_flag(&flags, WAITEXTEN_MOH))
05615       ast_indicate(chan, AST_CONTROL_UNHOLD);
05616 
05617    return res;
05618 }


Generated on Wed Aug 15 01:25:37 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.3