com.askfast.util

Interface AskFastRestService

public interface AskFastRestService

Method Summary

Methods

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

Method Detail

startDialog

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

getAdapters

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

getAdapter

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

buyAdapter

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

updateAdapter

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

getFreeAdapters

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

removeAdapter

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

getDialogs

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

getDialog

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

getDialogsByName

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

createDialog

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

updateDialog

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

removeDialog

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

getTTSAccounts

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

getTTSAccount

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

createTTSAccount

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

updateTTSAccount

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

deleteTTSAccount

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

getRecordings

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

getCapableAdapters

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

getDDRRecords

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