com.askfast.util

Interface AskFastRestService

public interface AskFastRestService

Method Summary

Modifier and Type	Method and Description
retrofit.client.Response	buyAdapter(java.lang.String adapterId)
Dialog	createDialog(Dialog dialog)
TTSUser	createTTSAccount(TTSUser ttsUser)
void	deleteTTSAccount(java.lang.String ttsAccountId)
Adapter	getAdapter(java.lang.String adapterId)
java.util.List<Adapter>	getAdapters(java.lang.String type, boolean owned)
java.util.List<Adapter>	getCapableAdapters(java.lang.String type)
java.util.List<DDRRecord>	getDDRRecords(java.lang.String delimitedAdapterIds, java.lang.String delimitedAdapterTypes, java.lang.String fromAddress, java.lang.String typeId, java.lang.String status, java.lang.Long startTime, java.lang.Long endTime, java.lang.String delimitedSessionKeys, java.lang.Integer offset, java.lang.Integer limit, java.lang.Boolean shouldGenerateCosts, java.lang.Boolean shouldIncludeServiceCosts) Returns a list of DDRRecords based on the give parameters.
RestResponse	getDDRRecordsCount(java.lang.String delimitedAdapterIds, java.lang.String delimitedAdapterTypes, java.lang.String fromAddress, java.lang.String typeId, java.lang.String status, java.lang.Long startTime, java.lang.Long endTime, java.lang.String delimitedSessionKeys, java.lang.Integer offset) A faster fetch of the aggregation of all quantities in the DDRRecord.getQuantity() based on the filtering criteria given
Dialog	getDialog(java.lang.String dialogId)
java.util.Set<Dialog>	getDialogs()
java.util.Set<Dialog>	getDialogsByName(java.lang.String name)
java.util.Set<Adapter>	getFreeAdapters(java.lang.String adapterType, java.lang.String address)
java.util.List<Recording>	getRecordings(java.lang.String accountId)
TTSUser	getTTSAccount(java.lang.String ttsAccountId)
java.util.List<TTSUser>	getTTSAccounts()
RestResponse	modifyCall(ModifyCall modifyCall)
retrofit.client.Response	removeAdapter(java.lang.String adapterId)
retrofit.client.Response	removeDialog(java.lang.String dialogId)
Result	startDialog(DialogRequest req)
Adapter	updateAdapter(java.lang.String adapterId, Adapter adapter)
Dialog	updateDialog(java.lang.String dialogId, Dialog dialog)
TTSUser	updateTTSAccount(java.lang.String ttsAccountId, TTSUser ttsUser)

Method Detail

startDialog

@POST(value="/startDialog")
Result startDialog(@Body
                                               DialogRequest req)

getAdapters

@GET(value="/adapter")
java.util.List<Adapter> getAdapters(@Query(value="type")
                                                           java.lang.String type,
                                                           @Query(value="owned")
                                                           boolean owned)

getAdapter

@GET(value="/adapter/{adapterId}")
Adapter getAdapter(@Path(value="adapterId")
                                                      java.lang.String adapterId)

buyAdapter

@POST(value="/adapter/{adapterId}")
retrofit.client.Response buyAdapter(@Path(value="adapterId")
                                                                        java.lang.String adapterId)

updateAdapter

@PUT(value="/adapter/{adapterId}")
Adapter updateAdapter(@Path(value="adapterId")
                                                         java.lang.String adapterId,
                                                         @Body
                                                         Adapter adapter)

getFreeAdapters

@GET(value="/free_adapters")
java.util.Set<Adapter> getFreeAdapters(@Query(value="adapterType")
                                                                    java.lang.String adapterType,
                                                                    @Query(value="address")
                                                                    java.lang.String address)

removeAdapter

@DELETE(value="/adapter/{adapterId}")
retrofit.client.Response removeAdapter(@Path(value="adapterId")
                                                                             java.lang.String adapterId)

getDialogs

@GET(value="/dialog")
java.util.Set<Dialog> getDialogs()

getDialog

@GET(value="/dialog/{dialogId}")
Dialog getDialog(@Path(value="dialogId")
                                                  java.lang.String dialogId)

getDialogsByName

@GET(value="/dialog/getByName")
java.util.Set<Dialog> getDialogsByName(@Query(value="name")
                                                                       java.lang.String name)

createDialog

@POST(value="/dialog")
Dialog createDialog(@Body
                                           Dialog dialog)

updateDialog

@PUT(value="/dialog/{dialogId}")
Dialog updateDialog(@Path(value="dialogId")
                                                     java.lang.String dialogId,
                                                     @Body
                                                     Dialog dialog)

removeDialog

@DELETE(value="/dialog/{dialogId}")
retrofit.client.Response removeDialog(@Path(value="dialogId")
                                                                          java.lang.String dialogId)

getTTSAccounts

@GET(value="/tts")
java.util.List<TTSUser> getTTSAccounts()

getTTSAccount

@GET(value="/tts/{ttsAccountId}")
TTSUser getTTSAccount(@Path(value="ttsAccountId")
                                                        java.lang.String ttsAccountId)

createTTSAccount

@POST(value="/tts")
TTSUser createTTSAccount(@Body
                                             TTSUser ttsUser)

updateTTSAccount

@PUT(value="/tts/{ttsAccountId}")
TTSUser updateTTSAccount(@Path(value="ttsAccountId")
                                                           java.lang.String ttsAccountId,
                                                           @Body
                                                           TTSUser ttsUser)

deleteTTSAccount

@DELETE(value="/tts/{ttsAccountId}")
void deleteTTSAccount(@Path(value="ttsAccountId")
                                                           java.lang.String ttsAccountId)

getRecordings

@GET(value="/account/{accountId}/recording")
java.util.List<Recording> getRecordings(@Path(value="accountId")
                                                                                     java.lang.String accountId)

getCapableAdapters

@GET(value="/adapter/search")
java.util.List<Adapter> getCapableAdapters(@Query(value="type")
                                                                         java.lang.String type)

getDDRRecords

@GET(value="/ddr")
java.util.List<DDRRecord> getDDRRecords(@Query(value="adapterIds")
                                                           java.lang.String delimitedAdapterIds,
                                                           @Query(value="adapterTypes")
                                                           java.lang.String delimitedAdapterTypes,
                                                           @Query(value="fromAddress")
                                                           java.lang.String fromAddress,
                                                           @Query(value="typeId")
                                                           java.lang.String typeId,
                                                           @Query(value="status")
                                                           java.lang.String status,
                                                           @Query(value="startTime")
                                                           java.lang.Long startTime,
                                                           @Query(value="endTime")
                                                           java.lang.Long endTime,
                                                           @Query(value="sessionKeys")
                                                           java.lang.String delimitedSessionKeys,
                                                           @Query(value="offset")
                                                           java.lang.Integer offset,
                                                           @Query(value="limit")
                                                           java.lang.Integer limit,
                                                           @Query(value="shouldGenerateCosts")
                                                           java.lang.Boolean shouldGenerateCosts,
                                                           @Query(value="shouldIncludeServiceCosts")
                                                           java.lang.Boolean shouldIncludeServiceCosts)

Returns a list of DDRRecords based on the give parameters.

Parameters:

delimitedAdapterIds - The list of adapterIds for which ddrRecords must be fetched

delimitedAdapterTypes - Fetch ddrRecords based on the channel used

fromAddress - Fetch ddrRecords based on the fromAddress

typeId - Fetch ddrRecords based on the type of cost attached. E.g. incoming, outgoing, tts processing etc

status - Fetch ddrRecords based on the status of the communication

startTime - Fetch ddrRecords based on a date range

endTime - Fetch ddrRecords based on a date range

delimitedSessionKeys - Fetch ddrRecords based on the sessionKeys generated per communication address.

offset - Skip the given number of ddrRecords

limit - Limit the fetch

shouldGenerateCosts - Force recalculating the costs for the communication or event

shouldIncludeServiceCosts - Force recalculating the service costs for the communication or event

Returns:

A collection of ddrRecords

getDDRRecordsCount

@GET(value="/ddr/count")
RestResponse getDDRRecordsCount(@Query(value="adapterIds")
                                                         java.lang.String delimitedAdapterIds,
                                                         @Query(value="adapterTypes")
                                                         java.lang.String delimitedAdapterTypes,
                                                         @Query(value="fromAddress")
                                                         java.lang.String fromAddress,
                                                         @Query(value="typeId")
                                                         java.lang.String typeId,
                                                         @Query(value="status")
                                                         java.lang.String status,
                                                         @Query(value="startTime")
                                                         java.lang.Long startTime,
                                                         @Query(value="endTime")
                                                         java.lang.Long endTime,
                                                         @Query(value="sessionKeys")
                                                         java.lang.String delimitedSessionKeys,
                                                         @Query(value="offset")
                                                         java.lang.Integer offset)

A faster fetch of the aggregation of all quantities in the DDRRecord.getQuantity() based on the filtering criteria given

Parameters:

delimitedAdapterIds - The list of adapterIds for which ddrRecords must be fetched

delimitedAdapterTypes - Fetch ddrRecords based on the channel used

fromAddress - Fetch ddrRecords based on the fromAddress

typeId - Fetch ddrRecords based on the type of cost attached. E.g. incoming, outgoing, tts processing etc

status - Fetch ddrRecords based on the status of the communication

startTime - Fetch ddrRecords based on a date range

endTime - Fetch ddrRecords based on a date range

delimitedSessionKeys - Fetch ddrRecords based on the sessionKeys generated per communication address.

offset - Skip the given number of ddrRecords

Returns:

Total number of ddrs fetched for the filter passed

modifyCall

@POST(value="/modifyDialog")
RestResponse modifyCall(@Body
                                                     ModifyCall modifyCall)

Parameters:

modifyCall - A modifyCall object containing sessionId and new url.

Returns:

String Success or Failed reason.