com.askfast.askfastapi

Class AskFastRestClient

java.lang.Object

com.askfast.askfastapi.AskFastRestClient

public class AskFastRestClient
extends Object

A client that gives access to the Ask Fast REST API. An accountId and accessToken are required to access the REST API. If you do not pass an accessToken, make sure to pass a valid refreshToken, as the class tries to retrieve a fresh accessToken at the key server.
This REST client uses Retrofit. Make sure to wrap every call with a try/catch, as an exception could be thrown when the request fails.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENDPOINT
static String	KEYSERVER_PATH

Constructor Summary

Constructors

Constructor and Description
AskFastRestClient(String accountId, String refreshToken) Creates an AskFastRestClient instance.
AskFastRestClient(String accountId, String refreshToken, String accessToken) Creates an AskFastRestClient instance.
AskFastRestClient(String accountId, String refreshToken, String accessToken, String endpoint) Creates an AskFastRestClient instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	buyAdapter(String adapterId) Buy an adapter.
Dialog	createDialog(Dialog dialog) Create a dialog.
String	getAccessToken() Returns the access token.
Set<Adapter>	getAdapters(String type) Returns a set of Adapters, optionally narrowed down by a type.
List<DDRRecord>	getDDRRecords(Collection<String> adapterIds, Collection<String> adapterTypes, String fromAddress, String typeId, String status, Long startTime, Long endTime, String delimitedSessionKeys, Integer offset, Integer limit, Boolean shouldGenerateCosts, Boolean shouldIncludeServiceCosts) Returns a list of DDRRecords based on the give parameters.
Dialog	getDialog(String dialogId) Retrieve a dialog by its id.
Set<Dialog>	getDialogs() Returns the list of dialogs.
Set<Adapter>	getFreeAdapters(String adapterType, String address)
List<Recording>	getRecordings() Get all the recordings of the current accountId
List<Recording>	getRecordings(String accountId) Get all the recordings linked to the specified account.
String	getRefreshToken() Returns the refresh token
void	removeAdapter(String adapterId) Remove an adapter from the logged in account. // TODO: describe more specifically per adapter type
void	removeDialog(String dialogId) Delete a dialog.
Result	startPhoneDialog(String toAddress, String url) Initiate a phone call from a random call adapter.
Result	startPhoneDialog(String toAddress, String adapterId, String url) Initiate a phone call from a given call adapter.
Adapter	updateAdapter(String adapterId, Adapter adapter) Updates the adapter with the given adapterId.
Dialog	updateDialog(String dialogId, Dialog dialog) Update a dialog.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

See Also:

Constant Field Values

KEYSERVER_PATH

public static final String KEYSERVER_PATH

See Also:

Constant Field Values

Constructor Detail

AskFastRestClient

public AskFastRestClient(String accountId,
                 String refreshToken)

Creates an AskFastRestClient instance. The accessToken will be retrieved from the key server using your accountId and refreshToken.

Parameters:

accountId - Your accountId

refreshToken - Your refreshToken

AskFastRestClient

public AskFastRestClient(String accountId,
                 String refreshToken,
                 String accessToken)

Creates an AskFastRestClient instance. Be sure the accessToken is valid, otherwise any request will fail and most likely throw an exception. The accessToken is not automatically refreshed.

Parameters:

accountId - Your accountId

refreshToken - Your refreshToken

accessToken - The access token

AskFastRestClient

public AskFastRestClient(String accountId,
                 String refreshToken,
                 String accessToken,
                 String endpoint)

Creates an AskFastRestClient instance. Be sure the accessToken is valid, otherwise any request will fail and most likely throw an exception. The accessToken is not automatically refreshed.

Parameters:

accountId - Your accountId

refreshToken - Your refreshToken

accessToken - The access token

endpoint - The endpoint, the url of API endpoint you wish to use. (The default is set to: https://api.ask-fast.com)

Method Detail

startPhoneDialog

public Result startPhoneDialog(String toAddress,
                      String url)

Initiate a phone call from a random call adapter.

Parameters:

toAddress - The address which will be called

url - The url used to load the dialog. This can also be a dialogId

Returns:

startPhoneDialog

public Result startPhoneDialog(String toAddress,
                      String adapterId,
                      String url)

Initiate a phone call from a given call adapter.

Parameters:

toAddress - The address which will be called

adapterId - The adapterId to initiate the call from

url - The url used to load the dialog. This can also be a dialogId

Returns:

getAdapters

public Set<Adapter> getAdapters(String type)

Returns a set of Adapters, optionally narrowed down by a type.

Parameters:

type - Optional. Possible values: sms, call, email or ussd

Returns:

A set of Adapters, optionally narrowed down by a type.

updateAdapter

public Adapter updateAdapter(String adapterId,
                    Adapter adapter)

Updates the adapter with the given adapterId.

Parameters:

adapterId - The id of the adapter

adapter - The adapter

Returns:

The updated adapter

buyAdapter

public void buyAdapter(String adapterId)

Buy an adapter. TODO: specify error behaviour: what happens if you can't buy the adapter? what if you're out of credits?

Parameters:

adapterId - The id of the adapter

removeAdapter

public void removeAdapter(String adapterId)

Remove an adapter from the logged in account. // TODO: describe more specifically per adapter type

Parameters:

adapterId - The The id of the adapter

getFreeAdapters

public Set<Adapter> getFreeAdapters(String adapterType,
                           String address)

createDialog

public Dialog createDialog(Dialog dialog)

Create a dialog. The system assigns an id to the dialog.

Parameters:

dialog - The dialog

Returns:

The dialog

getDialogs

public Set<Dialog> getDialogs()

Returns the list of dialogs.

Returns:

The list of dialogs

getDialog

public Dialog getDialog(String dialogId)

Retrieve a dialog by its id.

Parameters:

dialogId - The id of the dialog

Returns:

The dialog

updateDialog

public Dialog updateDialog(String dialogId,
                  Dialog dialog)

Update a dialog.

Parameters:

dialogId - The id of the dialog

dialog - The dialog

Returns:

The updated dialog

removeDialog

public void removeDialog(String dialogId)

Delete a dialog.

Parameters:

dialogId - The The id of the dialog

getRecordings

public List<Recording> getRecordings()

Get all the recordings of the current accountId

Returns:

List of recordings

getRecordings

public List<Recording> getRecordings(String accountId)

Get all the recordings linked to the specified account.

Parameters:

accountId - The accountId to for which all the recordings are recorded.

Returns:

List of recordings

getDDRRecords

public List<DDRRecord> getDDRRecords(Collection<String> adapterIds,
                            Collection<String> adapterTypes,
                            String fromAddress,
                            String typeId,
                            String status,
                            Long startTime,
                            Long endTime,
                            String delimitedSessionKeys,
                            Integer offset,
                            Integer limit,
                            Boolean shouldGenerateCosts,
                            Boolean shouldIncludeServiceCosts)
                              throws Exception

Returns a list of DDRRecords based on the give parameters.

Parameters:

adapterIds -

adapterTypes -

fromAddress -

typeId -

status -

startTime -

endTime -

delimitedSessionKeys -

offset -

limit -

shouldGenerateCosts -

shouldIncludeServiceCosts -

Returns:

Throws:

Exception

getAccessToken

public String getAccessToken()
                      throws Exception

Returns the access token. If the access token is null, it requests the key server to give a fresh token.

Returns:

The access token

Throws:

Exception - Thrown when refreshing the access token if the accountId or refreshToken is null

getRefreshToken

public String getRefreshToken()

Returns the refresh token

Returns:

The refresh token