com.askfast.askfastapi

Class AskFast

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, AskFast askFast) adds an answer by linking the questionid of the askFast parameter as the callbackURL.
void	addAnswer(String answer, String next) adds an answer corresponding to a question asked
void	addEvent(EventPost.EventType eventType, String callbackURL)
void	addMediaProperty(MediaProperty.MediumType mediumType, MediaProperty.MediaPropertyKey propertyKey, String value)
void	ask(String ask) asks a question
void	ask(String ask, AskFast askFast)
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 this conversation
String	getAccountID()
String	getASKFAST_JSONRPC()
String	getASKFAST_KEYSERVER()
String	getBaseURL()
String	getBearerToken()
Map<String,String>	getParams()
Question	getQuestion()
String	getQuestionId()
String	obtainAccessToken()
String	outBoundCall(String fromAddress, String senderName, Collection<String> toAddressList, String subject, String url) 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) 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) overloaded method for any broadcast outboundcalls without a subject (Everything except an Email).
String	outBoundCall(String fromAddress, String senderName, Map<String,String> toAddressNameMap, String subject, String url) overloaded method for any broadcast outboundcalls with a subject
String	outBoundCall(String fromAddress, String toAddress, String url) overloaded method for any outboundcalls without a subject (Everything except Email)
String	outBoundCall(String fromAddress, String toAddress, String subject, String url) overloaded method for any outboundcalls with a subject (Everything including Email)
String	outBoundCall(String fromAddress, String senderName, String toAddress, String subject, String url)
void	redirect(String to) redirect the control to a new agent
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.
String	render()
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)
void	setAccountID(String accountID)
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 -

say

public void say(String value,
       String next)

ask

public void ask(String ask)

asks a question

Parameters:

ask -

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 -

next -

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 -

next -

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 -

next -

exit

public void exit(String exitURL)

Ends this conversation

Parameters:

Text - or url to be played before exit

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:

Text - or url to be played before exit

ask

public void ask(String ask,
       AskFast askFast)

addAnswer

public void addAnswer(String answer,
             String next)

adds an answer corresponding to a question asked

Parameters:

answerText -

next -

addAnswer

public void addAnswer(String answer,
             AskFast askFast)

adds an answer by linking the questionid of the askFast parameter as the callbackURL.
Typically used with a Dialog Object (collection of questions are linked to eachother )

Parameters:

answer -

askFast - this is linked to the callback of the answer

redirect

public void redirect(String to)

redirect the control to a new agent

redirect

public void redirect(String to,
            String redirectText)

redirect the control to a new agent

Parameters:

redirectText - : can be the text directly or a HTTP based url which contains the text

redirect

public void redirect(String to,
            String redirectText,
            String next)

redirect the control to a new agent

Parameters:

redirectText - : can be the text directly or a HTTP based url which contains the text

next - : the URL where the question for the redirection agent is available

redirect

public void redirect(String to,
            String redirectText,
            String next,
            String preconnectURL)

redirect the control to a new phone.

Parameters:

to - redirect the phone control to this address

plays - this redirectText or url when the control is being redirected.

next - the URL where the question for the redirection agent is available

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

outBoundCall

public String outBoundCall(String fromAddress,
                  String toAddress,
                  String url)
                    throws Exception

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

Throws:

Exception

outBoundCall

public String outBoundCall(String fromAddress,
                  String toAddress,
                  String subject,
                  String url)
                    throws Exception

overloaded method for any outboundcalls with a subject (Everything including Email)

Parameters:

fromAddress - address of the sender

toAddress - address of the receiver

url - GET request on this URL has the question

Throws:

Exception

outBoundCall

public String outBoundCall(String fromAddress,
                  String senderName,
                  String toAddress,
                  String subject,
                  String url)
                    throws Exception

Throws:

Exception

outBoundCall

public String outBoundCall(String fromAddress,
                  String senderName,
                  Collection<String> toAddressList,
                  String subject,
                  String url)
                    throws Exception

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:

Throws:

Exception

outBoundCall

public String outBoundCall(String fromAddress,
                  String senderName,
                  Map<String,String> toAddressNameMap,
                  String url)
                    throws Exception

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

outBoundCall

public String outBoundCall(String fromAddress,
                  String senderName,
                  Map<String,String> toAddressNameMap,
                  String subject,
                  String url)
                    throws Exception

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

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

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

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

addEvent

public void addEvent(EventPost.EventType eventType,
            String callbackURL)

addMediaProperty

public void addMediaProperty(MediaProperty.MediumType mediumType,
                    MediaProperty.MediaPropertyKey propertyKey,
                    String value)

setAccountID

public void setAccountID(String accountID)

obtainAccessToken

public String obtainAccessToken()
                         throws Exception

Throws:

Exception

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

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)