AskFast (AskFast Library 1.5.2 API)

java.lang.Object
- com.askfast.askfastapi.AskFast

```
public class AskFast
extends Object
```
A stateless implementation of the dialog handler

Author:

Shravan

Constructor Summary

Constructors
Constructor and Description
`AskFast()`
`AskFast(javax.servlet.http.HttpServletRequest req)`
`AskFast(javax.servlet.http.HttpServletRequest req, String accountID, String refreshToken, Map<String,String> params)`
`AskFast(String url)`
`AskFast(String url, String accountID, String refreshToken, Map<String,String> params)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAnswer(String answer, String next)` Adds an answer corresponding to a question asked
`void`	`addEvent(EventPost.EventType eventType, String callbackURL)` Adds an event callback
`void`	`addMediaProperty(MediaProperty.MediumType mediumType, MediaProperty.MediaPropertyKey propertyKey, String value)` Adds some communication channel specific properties.
`void`	`ask(String ask)` Asks a question of Type `Question.QUESTION_TYPE_OPEN`
`void`	`ask(String ask, String next)` Asks an open question with text as in field: ask and an answer with callback as in field: next
`void`	`ask(String ask, String answerText, String next)` Asks an open question with text as in field: ask and an answer with callback as in field: next and text as in field: answerText
`void`	`askByVoice(String ask, String next)` Creates an open question with media property as audio.
`void`	`conference(String ask, String next)` Sets up a conference.
`void`	`exit(String exitURL)` Ends an existing conversation
`protected String`	`formatURL(String url)`
`String`	`getAccountID()`
`String`	`getASKFAST_JSONRPC()`
`String`	`getASKFAST_KEYSERVER()`
`String`	`getBaseURL()`
`String`	`getBearerToken()`
`Map<String,String>`	`getParams()`
`Question`	`getQuestion()`
`String`	`getQuestionId()`
`String`	`obtainAccessToken()` Deprecated. Recommended use `AskFastRestClient.getAccessToken()` instead
`String`	`outBoundCall(String fromAddress, String senderName, Collection<String> toAddressList, String subject, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` overloaded method for any broadcast outboundcalls with a subject (Everything including an Email)
`String`	`outBoundCall(String fromAddress, String senderName, Map<String,String> toAddressNameMap, Map<String,String> ccAddressNameMap, Map<String,String> bccAddressNameMap, String subject, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` overloaded method for any broadcast outboundcalls with a subject, cc and bcc list (Everything including Email)
`String`	`outBoundCall(String fromAddress, String senderName, Map<String,String> toAddressNameMap, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` overloaded method for any broadcast outboundcalls without a subject (Everything except an Email). Makes it backward compatible
`String`	`outBoundCall(String fromAddress, String senderName, Map<String,String> toAddressNameMap, String subject, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` overloaded method for any broadcast outboundcalls with a subject
`String`	`outBoundCall(String fromAddress, String toAddress, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` Overloaded method for any outboundcalls without a subject (Everything except Email)
`String`	`outBoundCall(String fromAddress, String toAddress, String subject, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)` overloaded method for any outboundcalls with a subject (Everything including Email)
`String`	`outBoundCall(String fromAddress, String senderName, String toAddress, String subject, String url)` Deprecated. Use the one of: `AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String)` `AskFastRestClient.startDialog(String, String, String, String, String)` , `AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String)` , `AskFastRestClient.startEmailDialog(String, String, String, String)` , `AskFastRestClient.startPhoneDialog(String, String)`, `AskFastRestClient.startSMSDialog(String, String, String)`
`void`	`redirect(List<String> addresses, String redirectText, String next, String preconnectURL)` Redirect the control to multiple agents
`void`	`redirect(String to)` Redirect the control to a new agent/url
`void`	`redirect(String to, String redirectText)` Redirect the control to a new agent
`void`	`redirect(String to, String redirectText, String next)` Redirect the control to a new agent
`void`	`redirect(String to, String redirectText, String next, String preconnectURL)` Redirect the control to a new phone.
`void`	`reject()` Reject this conversation.
`String`	`render()` Serializer the question prepared till now.
`void`	`render(javax.servlet.http.HttpServletResponse response)`
`void`	`say(String value)` Creates a comment question if the next parameter is null.
`void`	`say(String value, String next)` Creates a comment question if the next parameter is null.
`void`	`setAccountID(String accountID)` Set the accountId for this instance
`void`	`setASKFAST_JSONRPC(String aSKFAST_JSONRPC)`
`void`	`setASKFAST_KEYSERVER(String aSKFAST_KEYSERVER)`
`void`	`setBaseURL(String baseURL)`
`void`	`setBearerToken(String bearerToken)`
`void`	`setPreferredLanguage(String language)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AskFast
```
public AskFast()
```
  - AskFast
```
public AskFast(javax.servlet.http.HttpServletRequest req)
```
  - AskFast
```
public AskFast(String url)
```
  - AskFast
```
public AskFast(javax.servlet.http.HttpServletRequest req,
       String accountID,
       String refreshToken,
       Map<String,String> params)
```
  - AskFast
```
public AskFast(String url,
       String accountID,
       String refreshToken,
       Map<String,String> params)
```
- Method Detail
  - getQuestionId
```
public String getQuestionId()
```
  - getQuestion
```
public Question getQuestion()
```
  - say
```
public void say(String value)
```
    Creates a comment question if the next parameter is null. If not creates a closed question.
    
    Parameters:
    value - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
  - say
```
public void say(String value,
       String next)
```
    Creates a comment question if the next parameter is null. If not creates a closed question.
    
    Parameters:
    value - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
    next - The next URL that must be fetched. This url is added as the answer callback
  - ask
```
public void ask(String ask)
```
    Asks a question of Type Question.QUESTION_TYPE_OPEN
    
    Parameters:
    ask - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
  - askByVoice
```
public void askByVoice(String ask,
              String next)
```
    Creates an open question with media property as audio. This is used to record voice notes. The location of the recorded audio is sent to the next callback argument
    
    Parameters:
    ask - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
    next - The next URL that must be fetched. This url is added as the answer callback
  - ask
```
public void ask(String ask,
       String next)
```
    Asks an open question with text as in field: ask and an answer with callback as in field: next
    
    Parameters:
    ask - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
    next - The next URL that must be fetched. This url is added as the answer callback
  - ask
```
public void ask(String ask,
       String answerText,
       String next)
```
    Asks an open question with text as in field: ask and an answer with callback as in field: next and text as in field: answerText
    
    Parameters:
    ask - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
    answerText - In an open question, this is not very relevant as information specific to an answer can also be added to the ask param
    next - The next URL that must be fetched. This url is added as the answer callback
  - exit
```
public void exit(String exitURL)
```
    Ends an existing conversation
    
    Parameters:
    exitURL - Text or url to be played before exit
  - reject
```
public void reject()
```
    Reject this conversation. Does not start a conversation if rendered as the first question
  - conference
```
public void conference(String ask,
              String next)
```
    Sets up a conference. Either the person called is pushed to a conference, or the the number being called is pushed to a conference
    
    Parameters:
    ask - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains your question or statement
    next - The next URL that must be fetched. This url is added as the answer callback
  - addAnswer
```
public void addAnswer(String answer,
             String next)
```
    Adds an answer corresponding to a question asked
    
    Parameters:
    answer - Either a string value (TTS in case of a phonecall) or a url to an audio file, which explains this answer or statement
    next - The next URL that must be fetched. This url is added as the answer callback
  - redirect
```
public void redirect(String to)
```
    Redirect the control to a new agent/url
    
    Parameters:
    to - You can redirect to a phonenumber, client or another http URL.
  - redirect
```
public void redirect(String to,
            String redirectText)
```
    Redirect the control to a new agent
    
    Parameters:
    to - You can redirect to a phonenumber, client or another http URL.
    redirectText - Either a string value (TTS in case of a phonecall) or a url to an audio file, which is played out before the redirect happens
  - redirect
```
public void redirect(String to,
            String redirectText,
            String next)
```
    Redirect the control to a new agent
    
    Parameters:
    to - You can redirect to a phonenumber, client or another http URL.
    redirectText - Either a string value (TTS in case of a phonecall) or a url to an audio file, which is played out before the redirect happens
    next - The next URL that must be fetched. This url is added as the answer callback
  - redirect
```
public void redirect(String to,
            String redirectText,
            String next,
            String preconnectURL)
```
    Redirect the control to a new phone.
    
    Parameters:
    to - You can redirect to a phonenumber, client or another http URL.
    redirectText - Either a string value (TTS in case of a phonecall) or a url to an audio file, which is played out before the redirect happens
    next - The next URL that must be fetched. This url is added as the answer callback
    preconnectURL - this url is used to execute a question at the callee side before connecting him to the caller. E.g. Now the callee can pick the phone, listen to a menu, then connect the call. This is useful only with special calling adapters.
  - redirect
```
public void redirect(List<String> addresses,
            String redirectText,
            String next,
            String preconnectURL)
```
    Redirect the control to multiple agents
    
    Parameters:
    addresses - Redirect the phone call to all these addresses
    redirectText - Either a string value (TTS in case of a phonecall) or a url to an audio file, which is played out before the redirect happens
    next - The next URL that must be fetched. This url is added as the answer callback
    preconnectURL - this url is used to execute a question at the callee side before connecting him to the caller. E.g. Now the callee can pick the phone, listen to a menu, then connect the call. This is useful only with special calling adapters.
  - render
```
public String render()
```
    Serializer the question prepared till now.
    
    Returns:
    Question JSON
  - outBoundCall
```
@Deprecated
public String outBoundCall(String fromAddress,
                             String toAddress,
                             String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    Overloaded method for any outboundcalls without a subject (Everything except Email)
    
    Parameters:
    fromAddress - address of the sender
    toAddress - address of the receiver
    url - GET request on this URL has the question
    
    Returns:
    Address and SessionKey, if the call is successful, if not the reason is given
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String toAddress,
                  String subject,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    overloaded method for any outboundcalls with a subject (Everything including Email)
    
    Parameters:
    fromAddress - address of the sender
    toAddress - address of the receiver
    subject - Subject is relevant to email conversations only
    url - GET request on this URL has the question
    
    Returns:
    Address and SessionKey, if the call is successful, if not the reason is given
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String senderName,
                  String toAddress,
                  String subject,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    
    Parameters:
    fromAddress - address of the sender
    senderName - The alternative senderId
    toAddress - address of the receiver
    subject - Subject is relevant to email conversations only
    url - GET request on this URL has the question
    
    Returns:
    Address and SessionKey, if the call is successful, if not the reason is given
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String senderName,
                  Collection<String> toAddressList,
                  String subject,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    overloaded method for any broadcast outboundcalls with a subject (Everything including an Email)
    
    Parameters:
    fromAddress - address of the sender
    senderName - name of the sender (userful for sending emails)
    toAddressList - collection of all recipient addresses
    subject - subject of the email
    url - question url
    
    Returns:
    Address and SessionKey, if the call is successful, if not the reason is given
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String senderName,
                  Map<String,String> toAddressNameMap,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    overloaded method for any broadcast outboundcalls without a subject (Everything except an Email). Makes it backward compatible
    
    Parameters:
    fromAddress - address of the sender
    senderName - name of the sender (userful for sending emails)
    toAddressNameMap - map containing all recipient address for a Broadcast call
    url - GET request on this URL has the question
    
    Returns:
    result of this outBound
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String senderName,
                  Map<String,String> toAddressNameMap,
                  String subject,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    overloaded method for any broadcast outboundcalls with a subject
    
    Parameters:
    fromAddress - address of the sender
    senderName - name of the sender (userful for sending emails)
    toAddressNameMap - map containing all recipient address for a Broadcast call
    subject - subject used in case this is an outbound email
    url - GET request on this URL has the question
    
    Returns:
    result of this outBound
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - outBoundCall
```
public String outBoundCall(String fromAddress,
                  String senderName,
                  Map<String,String> toAddressNameMap,
                  Map<String,String> ccAddressNameMap,
                  Map<String,String> bccAddressNameMap,
                  String subject,
                  String url)
                    throws Exception
```
    Deprecated. Use the one of: AskFastRestClient.startDialog(String, com.askfast.model.AdapterType, String, String, String) AskFastRestClient.startDialog(String, String, String, String, String) , AskFastRestClient.startDialog(Map, Map, Map, com.askfast.model.AdapterType, String, String, String, String) , AskFastRestClient.startEmailDialog(String, String, String, String) , AskFastRestClient.startPhoneDialog(String, String), AskFastRestClient.startSMSDialog(String, String, String)
    overloaded method for any broadcast outboundcalls with a subject, cc and bcc list (Everything including Email)
    
    Parameters:
    fromAddress - address of the sender
    senderName - name of the sender (userful for sending emails)
    toAddressNameMap - map containing all recipient address for a Broadcast call
    ccAddressNameMap - map containing all cc recipient address for a Broadcast call
    bccAddressNameMap - map containing all bcc recipient address for a Broadcast call
    subject - subject used in case this is an outbound email
    url - GET request on this URL has the question
    
    Returns:
    result of this outBound
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - addEvent
```
public void addEvent(EventPost.EventType eventType,
            String callbackURL)
```
    Adds an event callback
    
    Parameters:
    eventType - Type of the event
    callbackURL - The callback to which EventPost is POSTed to
  - addMediaProperty
```
public void addMediaProperty(MediaProperty.MediumType mediumType,
                    MediaProperty.MediaPropertyKey propertyKey,
                    String value)
```
    Adds some communication channel specific properties. E.g. TIMEOUT for phonecalls etc
    
    Parameters:
    mediumType - The type of the communication channel
    propertyKey - The type of the property added
    value - The value of the property added
  - obtainAccessToken
```
public String obtainAccessToken()
                         throws Exception
```
    Deprecated. Recommended use AskFastRestClient.getAccessToken() instead
    
    Returns:
    The accessToken by connecting to the ASK-Fast backend
    
    Throws:
    
    Exception - 403 Authorization Exceptions
  - setAccountID
```
public void setAccountID(String accountID)
```
    Set the accountId for this instance
    
    Parameters:
    accountID - The accountId of user
  - getAccountID
```
public String getAccountID()
```
  - getBearerToken
```
public String getBearerToken()
```
  - setBearerToken
```
public void setBearerToken(String bearerToken)
```
  - setPreferredLanguage
```
public void setPreferredLanguage(String language)
```
  - render
```
public void render(javax.servlet.http.HttpServletResponse response)
            throws IOException
```
    Throws:
    
    IOException
  - getParams
```
public Map<String,String> getParams()
```
  - formatURL
```
protected String formatURL(String url)
```
  - getBaseURL
```
public String getBaseURL()
```
  - setBaseURL
```
public void setBaseURL(String baseURL)
```
  - getASKFAST_JSONRPC
```
public String getASKFAST_JSONRPC()
```
  - setASKFAST_JSONRPC
```
public void setASKFAST_JSONRPC(String aSKFAST_JSONRPC)
```
  - getASKFAST_KEYSERVER
```
public String getASKFAST_KEYSERVER()
```
  - setASKFAST_KEYSERVER
```
public void setASKFAST_KEYSERVER(String aSKFAST_KEYSERVER)
```

Class AskFast

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AskFast

AskFast

AskFast

AskFast

AskFast

Method Detail

getQuestionId

getQuestion

say

say

ask

askByVoice

ask

ask

exit

reject

conference

addAnswer

redirect

redirect

redirect

redirect

redirect

render

outBoundCall

outBoundCall

outBoundCall

outBoundCall

outBoundCall

outBoundCall

outBoundCall

addEvent

addMediaProperty

obtainAccessToken

setAccountID

getAccountID

getBearerToken

setBearerToken

setPreferredLanguage

render

getParams

formatURL

getBaseURL

setBaseURL

getASKFAST_JSONRPC

setASKFAST_JSONRPC

getASKFAST_KEYSERVER

setASKFAST_KEYSERVER