Mon Nov 24 15:34:52 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_dahdibarge.c
 Zap Barge support.
file  app_dahdiras.c
 Execute an ISDN RAS.
file  app_dahdiscan.c
 Zap Scanner.
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 DAHDI 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.

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 8829 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().

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

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

Definition at line 5442 of file pbx.c.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Goto

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

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

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

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

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

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

Definition at line 5499 of file pbx.c.

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

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

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

Definition at line 5396 of file pbx.c.

References AST_CONTROL_PROGRESS, and ast_indicate().

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

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

Definition at line 5471 of file pbx.c.

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

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

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

Definition at line 5405 of file pbx.c.

References AST_CONTROL_RINGING, and ast_indicate().

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

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

Definition at line 5489 of file pbx.c.

References ast_cdr_setamaflags().

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

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

Definition at line 5598 of file pbx.c.

References ast_safe_sleep(), and s.

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

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

Definition at line 5614 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(), VERBOSE_PREFIX_3, and WAITEXTEN_MOH.

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


Generated on Mon Nov 24 15:34:52 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7