Web Controllers Mobile API Controller Class Reference
Prerequisite: In order to call methods in this API, you must generate an API Token Id (a.k.a. appTokenId parameter in method calls). You can generate (or regenerate) API Token Ids by following the steps below:
- Log in as an administrator to the Qubicles Manager interface.
- Hover over your name, "Hi, <Your Name>", in the top navigation bar to display the account information popup.
- Click the "Data" or "FTP" tab to view your current API Token Id. If one doesn't exist or you would like to regenerate a new token (which revokes any previous tokens granted), simply click "Regenerate".
Base Host for All API Calls
https://manager.qubicles.io/MobileApi
Example: https://manager.qubicles.io/MobileApi/GetUsers?userId=1234&appTokenId=fadsfdasf
Date format:
MM/DD/YYY HH:MM:SS
Report Type:
day_by_halfhour
day_by_hour
week_by_day_sun_to_sat
month_by_day
month_by_week
year_by_month
custom_range
Public Member Functions
JsonResult GetCampaignsAndQueues (string userId, string appTokenId)
Returns a list of all campaigns and ACD queues.
JsonResult GetLiveChatQueues (string userId, string appTokenId)
Returns a list of all live chat queues.
JsonResult GetDIDs (string userId, string appTokenId)
Returns a list of all local and toll-free DIDs in the system.
JsonResult GetDispositions (string userId, string appTokenId)
Returns a list of all dispositions in the system.
JsonResult GetUsers (string userId, string appTokenId)
Returns a list of all users in the system.
JsonResult GetRealtimeStats (string userId, string campaignIds, string groupIds, string appTokenId)
Returns a combination of JSON arrays containing real-time call, agent, and time information.
JsonResult Monitor (string userId, string sessionID, string serverIP, string userPhone, string agentID, string appTokenId)
Send a request to blind-monitor an agent's session. Values for the following parameters can be retrieved by sending a call to GetRealtimeStats
JsonResult Barge (string userId, string sessionID, string serverIP, string userPhone, string agentID, string appTokenId)
Similar to the Monitor command, except the caller on the receiving end of the userPhone will be able to actively participate in the call and heard by both parties. Values for the following parameters can be retrieved by sending a call to GetRealtimeStats
JsonResult GetLists (string userId, string campaignIds, string appTokenId)
Returns a JSON formatted array of dialing lists currently in the system.
JsonResult CreateList (string name, string description, string callerId, string campaignId, string resetTimes, string active, string userId, string appTokenId) Create a new dialing list.
JsonResult CopyCustomFields (int sourceListId, int destinationListId, string userId, string appTokenId)
Copies the custom field definitions from an existing list to the destination list specified.
JsonResult StartList (string userId, int listId, string appTokenId)
Sets an inactive list in an active state. If there are any dialable leads in the system and other rules are met (e.g. recycling rules, campaign hours of operations, available agents, etc), this will begin dialing the records in the list.
JsonResult StopList (string userId, int listId, string appTokenId)
Sets an active list to an inactive state. Dialing operations (if any) will be stopped immediately (any currently active calls will continue to be processed).
JsonResult GetRecordings (string userId, string startDate, string endDate, string campaignId, string appTokenId)
Searches the quality assurance system for all call recordings within the specified date range, for the given campaign/ACD queue.
ActionResult StreamRecording (string userId, long recordingId, string appTokenId)
Given a recording Id, streams or immediately downloads the recording's audio file.
ContentResult ReportACDDetail (string startDate, string endDate, string users, string campaignIds, string queueIds, string tzOffset, string userId, string reportType, string appTokenId)Executes the ACD Detail report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentActivitySummary (string startDate, string endDate, string users, string campaignIds, string tzOffset, string userId, string appTokenId)Executes the Agent Activity Summary report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentAuxDetail (string startDate, string endDate, string reportType, string users, string campaignIds, string tzOffset, string userId, string appTokenId)Executes the Agent Aux Detail report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentPerformanceDetailOB (string startDate, string endDate, string reportType, string users, string campaignIds, string queueIds, string tzOffset, string userId, string appTokenId) Executes the Agent Performance Detail report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentPerformanceDetail (string startDate, string endDate, string reportType, string users, string campaignIds, string queueIds, string tzOffset, string userId, string appTokenId) Executes the Agent Performance Detail report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentLog (string startDate, string endDate, string users, string campaignIds, string tzOffset, string userId, string appTokenId)Executes the Agent Log report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentStaffTime (string startDate, string endDate, string users, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Agent Staff Time report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportAgentDisposition (string campaignIds, string startDate, string endDate, string users, string tzOffset, string userId, string appTokenId)
Executes the Agent Disposition report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportCampaignDNC (string campaignIds, string userId, string appTokenId)
Executes the Campaign DNC report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportCallDetailRecordsInbound (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Inbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all inbound call-related billing activity.
ContentResult ReportCallDetailRecordsOutbound (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Outbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all outbound call-related billing activity.
ContentResult ReportCallDetailRecordsCombined (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Inbound&Outbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all call-related billing activity.
ContentResult ReportCallDetailUsage (string startDate, string endDate, string reportType, string users, string campaignIds, string queueIds, string tzOffset, string userId, string appTokenId) Executes the Call Detail Usage report using the filters specified as parameters and returns raw output as comma-separated values. This report is a summarized view of the Call Detail Records (Inbound&Outbound) reports.
ContentResult ReportLiveChatLog (string startDate, string endDate, string chatQueueIds, string tzOffset, string userId, string appTokenId)
Executes the Live Chat Log report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportInteractionDetail (string startDate, string endDate, string listIds, string dispositionIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Interaction Detail report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportExportLeads (string startDate, string endDate, string listIds, string dispositionIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Export Leads report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportInteractionDetailLog (string startDate, string endDate, string listIds, string dispositionIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Interaction Detail Log report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportSystemCallLog (string startDate, string endDate, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the System Call Log report using the filters specified as parameters and returns raw output as comma-separated values
ContentResult ReportLeadDetail (string startDate, string endDate, string listIds, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Lead Detail report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportDispositionSummary (string startDate, string endDate, string listIds, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId) Executes the Disposition Summary report using the filters specified as parameters and returns raw output as comma-separated values.
ContentResult ReportFlashSummary (string startDate, string endDate, string listIds, string tzOffset, string userId, string appTokenId)
Executes the outbound-specific Flash Summary report using the filters specified as parameters and returns raw output as comma-separated values.
Member Function
JsonResult Web.Controllers.MobileApiController.Barge (string userId, string sessionID, string serverIP, string userPhone, string agentID, string appTokenId)
Similar to the Monitor command, except the caller on the receiving end of the userPhone will be able to actively participate in the call and heard by both parties. Values for the following parameters can be retrieved by sending a call to GetRealtimeStats:
SessionId
ServerIP
AgentId
Parameters:
| userId | User id with permission/access to call this API |
| sessionID | Currently logged in session ID of the agent that is being monitored. Call GetRealtimeStats and parse its LiveAgents JSON array to retrieve this information. |
| serverIP | IP address of server call is currently on. Used to send the request for monitoring to the correct telephony server. Call GetRealtimeStats and parse its LiveAgents JSON array to retrieve this information. |
| userPhone | Station Extension (Stations App) or wired/wireless phone number to connect the live monitoring session to. |
| agentID | User Id of the agent that is being monitored. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult FC2.Web.Controllers.MobileApiController.CopyCustomFields (int sourceListId, int destinationListId, string userId, string appTokenId)
Copies the custom field definitions from an existing list to the destination list specified.
Returns:
Returns 'true' if successful, or 'false' otherwise.
Parameters:
| sourceListId | The list Id for an existing list with custom fields definitions to be copied to the destination list. |
| destinationListId | The destination list Id to copy custom fields. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult FC2.Web.Controllers.MobileApiController.CreateList (string name, string description, string callerId, string campaignId, string resetTimes, string active, string userId, string appTokenId)
Create a new dialing list.
Returns:
Returns the list Id for the newly created list.
Parameters:
| name | Specifies the name of the list. |
| description | Specifies a friendly description. |
| campaignId | Caller Id displayed when calling records from this list. Overrides the campaign's Caller Id setting, if any |
| resetTimes | A comma-separated list of times (in GMT) this list should be automatically reset by the system. |
| active | Specifies whether this list is currently running. Possible values are 'Y' for yes or 'N' for no. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetCampaignsAndQueues (string userId, string appTokenId)
Returns a list of all campaigns and ACD queues.
Returns:
A JSON formatted array of campaigns and queues. Each result in the array contains a JSON object representation of a campaign or ACD queue and includes the following fields:
Id: internal system ID of campaign/queue. Can be used to supply other API methods that requires a campaign or queue's Id
DisplayName: the friendly name of the campaign/queue as entered by the creator
Type: Whether the campaign-type is an 'ACDQueue' or 'Campaign'.
Parameters:
| userId | User id of user with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetDIDs (string userId, string appTokenId)
Returns a list of all local and toll-free DIDs in the system.
Returns:
A JSON formatted array of DIDs. Each result in the array contains a JSON object representation of a DID and includes the following fields:
Id: internal system ID of the DID. Can be used to supply other API methods that requires a DID Id.
DIDName: the friendly name of the DID as entered by the creator.
DIDNumber: the actual DID.
Route: the current routing method for this DID.
Active: Whether the DID is currently active.
Parameters:
| userId | User id of user with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult FC2.Web.Controllers.MobileApiController.GetDispositions (string userId, string appTokenId)
Returns a list of all dispositions in the system.
Returns:
A JSON formatted array of dispositions. Each result in the array contains a JSON object representation of a disposition and includes the following fields:
Id: internal system ID of the disposition. Can be used to supply other API methods that requires a disposition Id. This Id is only unique within the scope of its campaign, not across campaigns.
Name: the friendly name of the disposition as entered by the creator.
CampaignId: the campaign this disposition currently belongs to.
QueueId: the ACD queue this disposition is associated with if any.
Parameters:
| userId | User id of user with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetLists (string userId, string campaignIds, string appTokenId)
Returns a JSON formatted array of dialing lists currently in the system.
Returns:
An array of DialingList JSON objects containing the following fields:
list_id: internal Id for this list. Can be used to access other API methods, such as posting realtime leads into the system
list_name: the friendly name for the list
list_lastcalldate: the date/time (GMT) this list was dialed
active: whether the list is currently active
population: the total records currently in the list
penetration_percentage: the percentage of records in the list that were called (not in a New Lead state)
net_records: total records in the list minus the leads penetrated (not in a New Lead state)
amd_percentage: the percentage of records in the list that were answering machines
na_percentage: the percentage of records in the list that were no answers
nr_percentage: the percentage of records in the list that haven't been called (in a New Lead state)
Parameters:
| userId | User id with permission/access to call this API. |
| campaignIds | Command separated list of campaign Ids |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetLiveChatQueues (string userId, string appTokenId)
Returns a list of all live chat queues.
Returns:
A JSON formatted array of live chat queues. Each result in the array contains a JSON object representation of a live chat queue and includes the following fields:
Id: internal system ID of live chat queue. Can be used to supply other API methods that requires a live chat queue's Id
DisplayName: the friendly name of the chat queue as entered by the creator
Type: The type of live chat queue. Always returns 'LiveChatQueue'
Parameters:
| userId | User id of user with permission/access to call this API. |
| campaignIds | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetRealtimeStats (string userId, string campaignIds, string groupIds, string appTokenId)
Returns a combination of JSON arrays containing real-time call, agent, and time information.
Returns:
This method return several JSON arrays. The parent JSON properties contain general information such as calls offered, calls answered, calls abandoned, total calls in queue, total dialable leads, total agents logged in, total agents on an active call, total agents in wrap, total sales, etc.
The first JSON array following this general information is LiveAgents, which contains a JSON object for each agent currently logged in and their current status, user Id, Session ID (a required parameter for the Monitor API See also:Monitor), current customer's phone number, their currently logged in campaign, assigned ACD Queues, total calls/sales handled for the day, and total time in current state.
The next JSON array following the LiveAgents JSON array results is the CurrentCallsInQueue results. This array contains a JSON object for each call currently in queue, and includes information such as the phone number, ACD Queue, total time in queue, and queue routing priority.
The subsequent JSON array is called LiveChats and contains a JSON array of live chat objects, including the Chat Queue, visitor's name, current status of chat (whether chatting, waiting, etc), current agent chatting with visitor (if any), and total chat time.
This API method returns information in real-time, up to the second the queries in the method are executed.
Parameters:
| userId | User id of user with permission/access to call this API. |
| campaignIds | A comma-delimited list of campaign Ids to query real-time stats for. |
| groupIds | A comma-delimited list of ACD Queue Ids to query real-time stats for. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetRecordings (string userId, string startDate, string endDate, string campaignId, string appTokenId)
Searchs the quality assurance system for all call recordings within the specified date range, for the given campaign/ACD queue.
Returns:
A JSON array containing Recording objects, including start date/time, end date/time, campaign, call duration, agent name and Id, disposition, caller phone number, and path to recording file.
Parameters:
| userId | User id with permission/access to call this API. |
| startDate | Start date for required range. |
| endDate | End date for required range. |
| campaignId | Id of campaign or ACD queue used to filter recordings. Must be a single Id (e.g. cannot send a comma-delimited list of campaign Ids). |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.GetUsers (string userId, string appTokenId)
Returns a list of all users in the system.
Returns:
A JSON formatted array of Users. Each result in the array contains a JSON object representation of a User and includes the following fields:
UserId: internal User ID of the user. Can be used to supply other API methods that requires a User Id
UserName: the User Name (used to log into the system) for the user
FullName: the user's full name
Role: the current role for this User
Active: Whether the User is currently active.
Parameters:
| userId | User id of user with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.Monitor (string userId, string sessionID, string serverIP, string userPhone, string agentID, string appTokenId)
Send a request to blind-monitor an agent's session. Values for the following parameters can be retrieved by sending a call to GetRealtimeStats:
SessionId
ServerIP
AgentId
Parameters:
| userId | User id with permission/access to call this API. |
| sessionID | Currently logged in Session Id of agent being monitored. Call GetRealtimeStats and parse its LiveAgents JSON array to retrieve this information. |
| serverIP | IP address of server call is currently on. Used to send the request for monitoring to the correct telephony server. Call GetRealtimeStats and parse its LiveAgents JSON array to retrieve this information. |
| userPhone | Station Extension (Stations App) or wired/wireless phone number to connect the live monitoring session to. |
| agentID | User Id of agent that is being monitored. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.StartList (string userId, int listId, string appTokenId)
Sets an inactive list in an active state. If there are any dialable leads in the system and other rules are met (e.g. recycling rules, campaign hours of operations, available agents, etc), this will begin dialing the records in the list.
If this list was previously archived by the system for lack of activity, this method will automatically retrieve those records and place them in its active leads database. This is the result of an automatic lead management archive mechanism used to maintain an efficient active leads database.
Returns:
Returns 'true' if the operation succeeded, or 'false' otherwise
Parameters:
| userId | User id with permission/access to call this API. |
| listId | Id of list to start. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
JsonResult Web.Controllers.MobileApiController.StopList (string userId, int listId, string appTokenId)
Sets an active list to an inactive state. Dialing operations (if any) will be stopped immediately (any currently active calls will continue to be processed).
Returns:
Returns 'true' if the operation succeeded, or 'false' otherwise.
Parameters:
| userId | User id with permission/access to call this API. |
| listId | Id of list to start. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ActionResult Web.Controllers.MobileApiController.StreamRecording (string userId, long recordingId, string appTokenId)
Given a recording Id, streams or immediately downloads the recording's audio file.
Returns:
An HTTP response with its content-type header set to 'audio/wav'.
Parameters:
| userId | User id with permission/access to call this API. |
| recordingId | Id of recording to stream or download |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentActivitySummary (string startDate, string endDate, string users, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Agent Activity Summary report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Agent activity in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentAuxDetail (string startDate, string endDate, string reportType, string users, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Agent Aux Detail report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Agent aux time data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| reportType | Sets the tabular layout format of the output. Possible values are: day_by_halfhour, day_by_hour, week_by_day_sun_to_sat, month_by_day, month_by_week, year_by_month, custom_range |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userID | User id with permission/access to call this API. |
| appTokenID | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentDisposition (string startDate, string endDate, string users, string tzOffset, string userId, string appTokenId)
Executes the Agent Disposition report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Agent disposition summary data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentLog (string startDate, string endDate, string users, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Agent Log report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Detailed agent log data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentPerformanceDetail (string startDate, string endDate, string reportType, string users, string campaignIds, string queueIds, string tzOffset, string userId, string appTokenId)
Executes the Agent Performance Detail report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Agent performance data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| reportType | Sets the tabular layout format of the output. Possible values are: day_by_halfhour, day_by_hour, week_by_day_sun_to_sat, month_by_day, month_by_week, year_by_month, custom_range |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| campaignIds | A comma-separated list of campaign Ids. |
| queueIds | A comma-separated list of queue Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportAgentStaffTime (string startDate, string endDate, string users, string tzOffset, string userId, string appTokenId)
Executes the Agent Staff Time report using the filters specified as parameters and returns raw output as comma-separated values
Returns: Agent staff time data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportCallDetailRecordsCombined (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Inbound&Outbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all call-related billing activity.
Returns: All call detail records for the date range specified in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportCallDetailRecordsInbound (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Inbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all inbound call-related billing activity.
Returns: Inbound-specific call detail records in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportCallDetailRecordsOutbound (string startDate, string endDate, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Records (Outbound) report using the filters specified as parameters and returns raw output as comma-separated values. This report is the source of all outbound call-related billing activity.
Returns: Outbound-specific call detail records in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportCallDetailUsage (string startDate, string endDate, string reportType, string users, string campaignIds, string queueIds, string tzOffset, string userId, string appTokenId)
Executes the Call Detail Usage report using the filters specified as parameters and returns raw output as comma-separated values. This report is a summarized view of the Call Detail Records (Inbound&Outbound) reports.
Returns: Call Detail summary data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| reportType | Sets the tabular layout format of the output. Possible values are: day_by_halfhour, day_by_hour, week_by_day_sun_to_sat, month_by_day, month_by_week, year_by_month, custom_range |
| users | A comma-separated list of user names (not to be confused with the internally-generated numerical user Ids) |
| campaignsIds | A comma-separated list of campaign Ids. |
| queueIds | A comma-separated list of queue Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportCampaignDNC (string campaignIds, string userId, string appTokenId)
Executes the Campaign DNC report using the filters specified as parameters and returns raw output as comma-separated values
Returns: All Do Not Call (DNC) phone numbers for the specified campaigns in raw comma-separated values (CSV) format
Parameters:
| campaignIds | A comma-separated list of campaign Ids. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportDispositionSummary (string startDate, string endDate, string listIds, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Disposition Summary report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Disposition Summary report data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| listIds | A comma-separated list of list Ids. |
| queueIds | A comma-separated list of queue Ids. |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportFlashSummary (string startDate, string endDate, string listIds, string tzOffset, string userId, string appTokenId)
Executes the outbound-specific Flash Summary report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Flash Summary report data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| listIds | A comma-separated list of list Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportInteractionDetail (string startDate, string endDate, string listIds, string dispositionIds, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Interaction Detail report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Interaction Detail report data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| listIds | A comma-separated list of list Ids. |
| dispositionIds | (Optional) A comma-separated list of disposition Ids. If provided, returns only the records that match these dispositions |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportInteractionDetailLog (string startDate, string endDate, string listIds, string dispositionIds, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Interaction Detail Log report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Interaction Detail Log report data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| listIds | A comma-separated list of list Ids. |
| dispositionIds | (Optional) A comma-separated list of disposition Ids. If provided, returns only the records that match these dispositions |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportLeadDetail (string startDate, string endDate, string listIds, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the Lead Detail report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Lead Detail report data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| listIds | A comma-separated list of list Ids. |
| queueIds | A comma-separated list of queue Ids. |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportLiveChatLog (string startDate, string endDate, string chatQueueIds, string tzOffset, string userId, string appTokenId)
Executes the Live Chat Log report using the filters specified as parameters and returns raw output as comma-separated values.
Returns: Live chat detailed data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| chatQueueIds | A comma-separated list of live chat queue Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |
ContentResult FC2.Web.Controllers.MobileApiController.ReportSystemCallLog (string startDate, string endDate, string queueIds, string campaignIds, string tzOffset, string userId, string appTokenId)
Executes the System Call Log report using the filters specified as parameters and returns raw output as comma-separated values
Returns: System Call data in raw comma-separated values (CSV) format
Parameters:
| startDate | The start date for the data requested. |
| endDate | The end date for the data requested. |
| queueIds | A comma-separated list of list Ids. |
| campaignIds | A comma-separated list of campaign Ids. |
| tzOffset | Since all information is stored in GMT, use the Time Zone Offset parameter to represent the data in your desired time zone. |
| userId | User id with permission/access to call this API. |
| appTokenId | App token identifier for API. Generated by an admin in the manager interface. |