Package com.bytedesk.call.esl.client.dptools

Class Execute

java.lang.Object
com.bytedesk.call.esl.client.dptools.Execute
public class Execute extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) String
    _uuid
     
    (package private) IModEslApi
    api
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Execute(IModEslApi api, String uuid)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    answer()
    Answers an incoming call or session.
    String
    ApiCommand(String command, String args)
     
    void
    attAnswer(String channelUrl)
    Make an attended transfer.
    void
    bindMetaApp(String key, String leg, String flags, String application, String params)
     
    void
    breakChannel(boolean all)
    Cancels currently running application on the given UUID.
    void
    bridge(String endpoint)
    Provides the ability to bridge two endpoints.
    void
    bridgeExport(String key, String value, boolean local)
    Export a channel variable across a bridge.
    void
    chat(String proto, String from, String to, String message)
    Send a text message to a IM client.
    void
    cngPlc()
    cng plc is just an app that says to perform plc on any lost packets and execute on originate.
    void
    conference(String name)
    Start or join a conference
    void
    conference(String name, String profile)
    Start or join a conference
    void
    conference(String name, String profile, String pin)
    Start or join a conference
    void
    conference(String name, String profile, String pin, String flags)
    Start or join a conference
    void
    deflect(String endpoint)
    Deflect sends a Refer to the client.
    void
    delayEcho(long ms)
    Places the calling channel in delayed loopback mode.
    void
    detectSpeech(String args)
    Implements speech recognition.
    void
    displaceSession(String path)
    Displace file.
    void
    displaceSession(String path, String flags)
    Displace file.
    void
    displaceSession(String path, String flags, long timeLimitMillis)
    Displace file.
    void
    eavesdrop(String uuid)
    Provides the ability to spy on a channel.
    void
    eavesdrop(String uuid, boolean enableDTMF)
    Provides the ability to spy on a channel.
    void
    eavesdrop(String uuid, boolean enableDTMF, String groupId)
    Provides the ability to spy on a channel.
    void
    eavesdrop(String uuid, boolean enableDTMF, String groupId, String failedWav)
    Provides the ability to spy on a channel.
    void
    eavesdrop(String uuid, boolean enableDTMF, String groupId, String failedWav, String newChannelWav)
    Provides the ability to spy on a channel.
    void
    eavesdrop(String uuid, boolean enableDTMF, String groupId, String failedWav, String newChannelWav, String idleWav)
    Provides the ability to spy on a channel.
    void
    echo()
    Places the calling channel in loopback mode.
    void
    endlessPlayback(String file)
    This application is used to play a file endlessly and the playing cannot be stopped externally.
    void
    eval(String string)
    Eval can be used to execute an internal API or simply log some text to the console.
    void
    event(String event)
    Event application can be used to fire aribtrary events.
    void
    executeExtension(String extension)
    execute an extension from within another extension with this dialplan application.
    void
    executeExtension(String extension, String dialplan)
    execute an extension from within another extension with this dialplan application.
    void
    executeExtension(String extension, String dialplan, String context)
    execute an extension from within another extension with this dialplan application.
    void
    export(String key, String value, boolean local)
    Exports a channel variable from the A leg to the B leg.
    void
    faxDetect(String context, String ext)
    When a fax is detected, the call will be routed to the ext in the context
    void
    flushDTMF()
    Flushes DTMFs received on a channel.
    void
    gentones(String tone)
    Generate TGML tones.
    void
    gentones(String tone, int loops)
    Generate TGML tones.
    void
    group(String action, String groupName, String url)
    adds/deletes groups to/from the db(internal db or ODBC) and allows calls to these groups in conjunction with the bridge-application.
    void
    hangup()
    Hangs up a channel, with an optional reason supplied.
    void
    hangup(String reason)
    Hangs up a channel, with an optional reason supplied.
    void
    info()
    Dumps channel information to console.
    void
    info(String level)
    Dumps channel information to console.
    void
    intercept(String uuid, boolean bleg)
    Allows one channel to bridge itself to the a or b leg of another call.
    void
    log(String message)
    Logs a string of text to the console
    void
    log(String level, String message)
    Logs a string of text to the console
    void
    mkdir(String path)
    Creates a directory.
    private boolean
    nn(Object obj)
     
    void
    park()
    Places a channel "on hold" in the switch, instead of in the phone.
    void
    phrase(String macroName, String data)
    Speak a phrase of text using a predefined phrase macro.
    void
    pickup(String group)
    Permits proper answering of multiple simultaneous calls to the same pickup group.
    String
    playAndDetectSpeech(String file, String engine, String grammer)
    Play while doing speech recognition.
    String
    playAndDetectSpeech(String file, String engine, String grammer, String params)
    Play while doing speech recognition.
    String
    playAndGetDigits(int min, int max, int tries, int timeout, String terminator, String file, String invalidFile, String regexp, int digitTimeout)
    Play a prompt and get digits.
    void
    playback(String file)
    Plays a sound file on the current channel.
    void
    playback(String file, String data)
    Plays a sound file on the current channel.
    private void
    playbackControl(String cmd)
     
    void
    playbackPause()
    Manage the audio being played into a channel from a sound file
    void
    playbackRestart()
    Manage the audio being played into a channel from a sound file
    void
    playbackSeek(int samples)
    Manage the audio being played into a channel from a sound file
    void
    playbackSpeed(int step)
    Manage the audio being played into a channel from a sound file
    void
    playbackTruncate()
    Manage the audio being played into a channel from a sound file
    void
    playbackVolume(int step)
    Manage the audio being played into a channel from a sound file
    void
    preAnswer()
    equivalent to a SIP status code 183 with SDP.
    void
    presence(String user, boolean in, String rpid, String message)
    Sends an event of either type PRESENCE_IN or PRESENCE_OUT.
    void
    privacy(String type)
    Set caller privacy on calls.
    void
    queueDTMF(String digits)
    Send DTMF digits after a bridge is successful from the session using the method(s) configured on the endpoint in use. use the character w for a .5 second delay and the character W for a 1 second delay.
    void
    queueDTMF(String digits, int durationsMillis)
    Send DTMF digits after a bridge is successful from the session using the method(s) configured on the endpoint in use. use the character w for a .5 second delay and the character W for a 1 second delay.
    String
    read(int min, int max, String soundFile, long timeout, String terminators)
    Read DTMF (touch-tone) digits.
    void
    record(String file)
    Record is used for recording messages, like in a voicemail system.
    void
    record(String file, boolean append, boolean wateResources, int timeLimitSeconds, int silenceThreshold, int silenceHits, String recordTile, String recordCopyright, String recordSoftware, String recordArtist, String recordComment, String recordDate, int recordRate)
    Record is used for recording messages, like in a voicemail system.
    private void
    record(String action, String file, int optionalTimeLimitSeconds, int optionalSilenceThreshold, int optionalSilenceHits, boolean wateResources, boolean append, String optionalRecordTile, String optionalRecordCopyright, String optionalRecordSoftware, String optionalRecordArtist, String optionalRecordComment, String optionalRecordDate, int optionalRecordRate)
     
    void
    recordSession(String file)
    Records an entire phone call or session.
    void
    recordSession(String file, boolean append, boolean wateResources, int timeLimitSeconds, int silenceThreshold, int silenceHits, String recordTile, String recordCopyright, String recordSoftware, String recordArtist, String recordComment, String recordDate, int recordRate)
    Records an entire phone call or session.
    void
    redirect(String endpoint)
    Can redirect a channel to another endpoint, you must take care to not redirect incompatible channels, as that wont have the desired effect.
    void
    respond(String code)
    Send SIP session respond code to the SIP device.
    void
    ringReady()
    This causes an 180 Ringing to be sent to the originator.
    void
    say(String moduleName, String text, String sayType, String sayMethod)
    The say application will use the pre-recorded sound files to read or say various things like dates, times, digits, etc.
    void
    say(String moduleName, String text, String sayType, String sayMethod, String gender)
    The say application will use the pre-recorded sound files to read or say various things like dates, times, digits, etc.
    void
    schedBroadcast(long seconds, boolean interval, String path, String leg)
    Schedule future broadcast.
    void
    schedHangup(long seconds, boolean interval)
    The sched_hangup application allows you to schedule a hangup action for a call, basically to limit call duration.
    void
    schedHangup(long seconds, boolean interval, String cause)
    The sched_hangup application allows you to schedule a hangup action for a call, basically to limit call duration.
    void
    schedTransfer(long seconds, boolean interval, String extension)
    Schedule a transfer in the future.
    void
    schedTransfer(long seconds, boolean interval, String extension, String dialPlan)
    Schedule a transfer in the future.
    void
    schedTransfer(long seconds, boolean interval, String extension, String dialPlan, String context)
    Schedule a transfer in the future.
    void
    sendDiplay(String message)
    Sends an info packet with a sipfrag.
    void
    sendDTMF(String digits)
    Send DTMF digits from the session using the method(s) configured on the endpoint in use.
    void
    sendDTMF(String digits, int durationMillis)
    Send DTMF digits from the session using the method(s) configured on the endpoint in use.
    private CommandResponse
    sendExeMesg(String app)
     
    private CommandResponse
    sendExeMesg(String app, String args)
     
    void
    set(String key, String value)
    Set a channel variable for the channel calling the application.
    void
    speak(String engine, String voice, String message)
     
    void
    transfer(String destinationNumber)
    Immediately transfer the calling channel to a new context.
    void
    transfer(String destinationNumber, String dialplan)
    Immediately transfer the calling channel to a new context.
    void
    transfer(String destinationNumber, String dialplan, String context)
    Immediately transfer the calling channel to a new context.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait