Requires any of the roles: | SystemAdministrator, Manager, Customer |
All Verbs | /reports/call-center-abandon |
---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class CallCenterAbandonReport : ReportRequest()
{
open var startDate:String? = null
open var endDate:String? = null
open var timeZoneId:String? = null
}
open class ReportRequest : IPost
{
/**
* The account ID this report should be run for
*/
@ApiMember(Description="The account ID this report should be run for")
open var accountId:String? = null
/**
* The email address to notify after the report is run
*/
@ApiMember(Description="The email address to notify after the report is run")
open var emailAddressToNotify:String? = null
/**
* The webhook to call after the report is complete with the data from the report
*/
@ApiMember(Description="The webhook to call after the report is complete with the data from the report")
open var webhookUrl:String? = null
}
open class ReportInfo
{
open var id:String? = null
open var name:String? = null
open var status:ReportStatuses? = null
open var statusMessage:String? = null
open var dateCreated:String? = null
open var dateUpdated:String? = null
open var downloadLink:String? = null
open var jobId:String? = null
open var emailAddressToNotify:String? = null
open var server:String? = null
}
enum class ReportStatuses
{
Queued,
Running,
Completed,
Error,
}
Kotlin CallCenterAbandonReport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /reports/call-center-abandon HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CallCenterAbandonReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports">
<AccountId>String</AccountId>
<EmailAddressToNotify>String</EmailAddressToNotify>
<WebhookUrl>String</WebhookUrl>
<EndDate>String</EndDate>
<StartDate>String</StartDate>
<TimeZoneId>String</TimeZoneId>
</CallCenterAbandonReport>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports"> <DateCreated>String</DateCreated> <DateUpdated>String</DateUpdated> <DownloadLink>String</DownloadLink> <EmailAddressToNotify>String</EmailAddressToNotify> <Id>String</Id> <JobId>String</JobId> <Name>String</Name> <Server>String</Server> <Status>Queued</Status> <StatusMessage>String</StatusMessage> </ReportInfo>