com.askfast.askfastapi

Class AskFast

java.lang.Object

com.askfast.askfastapi.AskFast

public class AskFast
extends java.lang.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, java.lang.String accountID, java.lang.String refreshToken, java.util.Map<java.lang.String,java.lang.String> params)
AskFast(java.lang.String url)
AskFast(java.lang.String url, java.lang.String accountID, java.lang.String refreshToken, java.util.Map<java.lang.String,java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
void	addAnswer(java.lang.String answer, java.lang.String next) Adds an answer corresponding to a question asked
void	addEvent(EventPost.EventType eventType, java.lang.String callbackURL) Adds an event callback
void	addMediaProperty(MediaProperty.MediumType mediumType, MediaProperty.MediaPropertyKey propertyKey, java.lang.String value) Adds some communication channel specific properties.
void	ask(java.lang.String ask) Asks a question of Type Question.QUESTION_TYPE_OPEN
void	ask(java.lang.String ask, java.lang.String next) Asks an open question with text as in field: ask and an answer with callback as in field: next
void	ask(java.lang.String ask, java.lang.String answerText, java.lang.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(java.lang.String ask, java.lang.String next) Creates an open question with media property as audio.
void	conference(java.lang.String ask, java.lang.String next) Sets up a conference.
void	exit(java.lang.String exitURL) Ends an existing conversation
protected java.lang.String	formatURL(java.lang.String url)
java.lang.String	getAccountID()
java.lang.String	getBaseURL()
java.lang.String	getBearerToken()
java.util.Map<java.lang.String,java.lang.String>	getParams()
Question	getQuestion()
java.lang.String	getQuestionId()
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String senderName, java.util.Collection<java.lang.String> toAddressList, java.lang.String subject, java.lang.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)
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String senderName, java.util.Map<java.lang.String,java.lang.String> toAddressNameMap, java.util.Map<java.lang.String,java.lang.String> ccAddressNameMap, java.util.Map<java.lang.String,java.lang.String> bccAddressNameMap, java.lang.String subject, java.lang.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)
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String senderName, java.util.Map<java.lang.String,java.lang.String> toAddressNameMap, java.lang.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
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String senderName, java.util.Map<java.lang.String,java.lang.String> toAddressNameMap, java.lang.String subject, java.lang.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
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String toAddress, java.lang.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)
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String toAddress, java.lang.String subject, java.lang.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)
java.lang.String	outBoundCall(java.lang.String fromAddress, java.lang.String senderName, java.lang.String toAddress, java.lang.String subject, java.lang.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(java.util.List<java.lang.String> addresses, java.lang.String redirectText, java.lang.String next, java.lang.String preconnectURL) Redirect the control to multiple agents
void	redirect(java.lang.String to) Redirect the control to a new agent/url
void	redirect(java.lang.String to, java.lang.String redirectText) Redirect the control to a new agent
void	redirect(java.lang.String to, java.lang.String redirectText, java.lang.String next) Redirect the control to a new agent
void	redirect(java.lang.String to, java.lang.String redirectText, java.lang.String next, java.lang.String preconnectURL) Redirect the control to a new phone.
void	reject() Reject this conversation.
java.lang.String	render() Serializer the question prepared till now.
void	render(javax.servlet.http.HttpServletResponse response)
void	say(java.lang.String value) Creates a comment question if the next parameter is null.
void	say(java.lang.String value, java.lang.String next) Creates a comment question if the next parameter is null.
void	setAccountID(java.lang.String accountID) Set the accountId for this instance
void	setBaseURL(java.lang.String baseURL)
void	setBearerToken(java.lang.String bearerToken)
void	setPreferredLanguage(java.lang.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(java.lang.String url)

AskFast

public AskFast(javax.servlet.http.HttpServletRequest req,
               java.lang.String accountID,
               java.lang.String refreshToken,
               java.util.Map<java.lang.String,java.lang.String> params)

AskFast

public AskFast(java.lang.String url,
               java.lang.String accountID,
               java.lang.String refreshToken,
               java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

getQuestionId

public java.lang.String getQuestionId()

getQuestion

public Question getQuestion()

say

public void say(java.lang.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(java.lang.String value,
                java.lang.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(java.lang.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(java.lang.String ask,
                       java.lang.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(java.lang.String ask,
                java.lang.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(java.lang.String ask,
                java.lang.String answerText,
                java.lang.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(java.lang.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(java.lang.String ask,
                       java.lang.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(java.lang.String answer,
                      java.lang.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(java.lang.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(java.lang.String to,
                     java.lang.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(java.lang.String to,
                     java.lang.String redirectText,
                     java.lang.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(java.lang.String to,
                     java.lang.String redirectText,
                     java.lang.String next,
                     java.lang.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(java.util.List<java.lang.String> addresses,
                     java.lang.String redirectText,
                     java.lang.String next,
                     java.lang.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 java.lang.String render()

Serializer the question prepared till now.

Returns:

Question JSON

outBoundCall

@Deprecated
public java.lang.String outBoundCall(java.lang.String fromAddress,
                                                 java.lang.String toAddress,
                                                 java.lang.String url)
                                          throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String toAddress,
                                     java.lang.String subject,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String senderName,
                                     java.lang.String toAddress,
                                     java.lang.String subject,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String senderName,
                                     java.util.Collection<java.lang.String> toAddressList,
                                     java.lang.String subject,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String senderName,
                                     java.util.Map<java.lang.String,java.lang.String> toAddressNameMap,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String senderName,
                                     java.util.Map<java.lang.String,java.lang.String> toAddressNameMap,
                                     java.lang.String subject,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

outBoundCall

public java.lang.String outBoundCall(java.lang.String fromAddress,
                                     java.lang.String senderName,
                                     java.util.Map<java.lang.String,java.lang.String> toAddressNameMap,
                                     java.util.Map<java.lang.String,java.lang.String> ccAddressNameMap,
                                     java.util.Map<java.lang.String,java.lang.String> bccAddressNameMap,
                                     java.lang.String subject,
                                     java.lang.String url)
                              throws java.lang.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:

java.lang.Exception - 403 Authorization Exceptions

addEvent

public void addEvent(EventPost.EventType eventType,
                     java.lang.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,
                             java.lang.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

setAccountID

public void setAccountID(java.lang.String accountID)

Set the accountId for this instance

Parameters:

accountID - The accountId of user

getAccountID

public java.lang.String getAccountID()

getBearerToken

public java.lang.String getBearerToken()

setBearerToken

public void setBearerToken(java.lang.String bearerToken)

setPreferredLanguage

public void setPreferredLanguage(java.lang.String language)

render

public void render(javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException

Throws:

java.io.IOException

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

formatURL

protected java.lang.String formatURL(java.lang.String url)

getBaseURL

public java.lang.String getBaseURL()

setBaseURL

public void setBaseURL(java.lang.String baseURL)