Fri Aug 24 02:29:02 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 8424 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().

08425 {
08426    int res;
08427    char *sdata;
08428    char *opts;
08429    int force =0;
08430    unsigned short callno = PTR_TO_CALLNO(chan->tech_pvt);
08431    if (ast_strlen_zero(data))
08432       data = "default";
08433    sdata = ast_strdupa(data);
08434    opts = strchr(sdata, '|');
08435    if (opts)
08436       *opts='\0';
08437 
08438    if (chan->tech != &iax2_tech) {
08439       ast_log(LOG_NOTICE, "Can't provision a non-IAX device!\n");
08440       return -1;
08441    } 
08442    if (!callno || !iaxs[callno] || !iaxs[callno]->addr.sin_addr.s_addr) {
08443       ast_log(LOG_NOTICE, "Can't provision something with no IP?\n");
08444       return -1;
08445    }
08446    res = iax2_provision(&iaxs[callno]->addr, iaxs[callno]->sockfd, NULL, sdata, force);
08447    if (option_verbose > 2)
08448       ast_verbose(VERBOSE_PREFIX_3 "Provisioned IAXY at '%s' with '%s'= %d\n", 
08449       ast_inet_ntoa(iaxs[callno]->addr.sin_addr),
08450       sdata, res);
08451    return res;
08452 }

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

Definition at line 5406 of file pbx.c.

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

05407 {
05408    int delay = 0;
05409    int res;
05410 
05411    if (chan->_state == AST_STATE_UP)
05412       delay = 0;
05413    else if (!ast_strlen_zero(data))
05414       delay = atoi(data);
05415 
05416    res = ast_answer(chan);
05417    if (res)
05418       return res;
05419 
05420    if (delay)
05421       res = ast_safe_sleep(chan, delay);
05422 
05423    return res;
05424 }

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

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

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

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

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

05373 {
05374    ast_indicate(chan, AST_CONTROL_BUSY);
05375    /* Don't change state of an UP channel, just indicate
05376       busy in audio */
05377    if (chan->_state != AST_STATE_UP)
05378       ast_setstate(chan, AST_STATE_BUSY);
05379    if( ast_strlen_zero(data) )
05380       wait_for_hangup(chan, "10");
05381    else
05382       wait_for_hangup(chan, data);
05383    return -1;
05384 }

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

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

05390 {
05391    ast_indicate(chan, AST_CONTROL_CONGESTION);
05392    /* Don't change state of an UP channel, just indicate
05393       congestion in audio */
05394    if (chan->_state != AST_STATE_UP)
05395       ast_setstate(chan, AST_STATE_BUSY);
05396    if( ast_strlen_zero(data) )
05397       wait_for_hangup(chan, "10");
05398    else
05399       wait_for_hangup(chan, data);
05400    return -1;
05401 }

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

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

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

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

Goto

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

05714 {
05715    int res = ast_parseable_goto(chan, data);
05716    if (!res && (option_verbose > 2))
05717       ast_verbose( VERBOSE_PREFIX_3 "Goto (%s,%s,%d)\n", chan->context,chan->exten, chan->priority+1);
05718    return res;
05719 }

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

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

05494 {
05495    int res=0;
05496    char *s, *ts;
05497    struct ast_timing timing;
05498 
05499    if (ast_strlen_zero(data)) {
05500       ast_log(LOG_WARNING, "GotoIfTime requires an argument:\n  <time range>|<days of week>|<days of month>|<months>?[[context|]extension|]priority\n");
05501       return -1;
05502    }
05503 
05504    ts = s = ast_strdupa(data);
05505 
05506    /* Separate the Goto path */
05507    strsep(&ts,"?");
05508 
05509    /* struct ast_include include contained garbage here, fixed by zeroing it on get_timerange */
05510    if (ast_build_timing(&timing, s) && ast_check_timing(&timing))
05511       res = pbx_builtin_goto(chan, ts);
05512    
05513    return res;
05514 }

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

Definition at line 5463 of file pbx.c.

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

05464 {
05465    if (!ast_strlen_zero(data)) {
05466       int cause;
05467       char *endptr;
05468 
05469       if ((cause = ast_str2cause(data)) > -1) {
05470          chan->hangupcause = cause;
05471          return -1;
05472       }
05473       
05474       cause = strtol((const char *) data, &endptr, 10);
05475       if (cause != 0 || (data != endptr)) {
05476          chan->hangupcause = cause;
05477          return -1;
05478       }
05479          
05480       ast_log(LOG_NOTICE, "Invalid cause given to Hangup(): \"%s\"\n", (char *) data);
05481    }
05482 
05483    if (!chan->hangupcause) {
05484       chan->hangupcause = AST_CAUSE_NORMAL_CLEARING;
05485    }
05486 
05487    return -1;
05488 }

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

Definition at line 5354 of file pbx.c.

References AST_CONTROL_PROGRESS, and ast_indicate().

05355 {
05356    ast_indicate(chan, AST_CONTROL_PROGRESS);
05357    return 0;
05358 }

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

Definition at line 5435 of file pbx.c.

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

05436 {
05437    char *args;
05438    struct ast_flags flags = { 0 };
05439 
05440    if (!ast_strlen_zero(data)) {
05441       args = ast_strdupa(data);
05442       ast_app_parse_options(resetcdr_opts, &flags, NULL, args);
05443    }
05444 
05445    ast_cdr_reset(chan->cdr, &flags);
05446 
05447    return 0;
05448 }

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

Definition at line 5363 of file pbx.c.

References AST_CONTROL_RINGING, and ast_indicate().

05364 {
05365    ast_indicate(chan, AST_CONTROL_RINGING);
05366    return 0;
05367 }

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

Definition at line 5453 of file pbx.c.

References ast_cdr_setamaflags().

05454 {
05455    /* Copy the AMA Flags as specified */
05456    ast_cdr_setamaflags(chan, data ? data : "");
05457    return 0;
05458 }

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

Definition at line 5562 of file pbx.c.

References ast_safe_sleep(), and s.

05563 {
05564    double s;
05565    int ms;
05566 
05567    /* Wait for "n" seconds */
05568    if (data && (s = atof(data)) > 0) {
05569       ms = s * 1000.0;
05570       return ast_safe_sleep(chan, ms);
05571    }
05572    return 0;
05573 }

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

Definition at line 5578 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_flags::flags, LOG_WARNING, option_verbose, parse(), set_ext_pri(), timeout, VERBOSE_PREFIX_3, and WAITEXTEN_MOH.

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


Generated on Fri Aug 24 02:29:02 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1