| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| All Verbs | /reports/call-center-abandon |
|---|
namespace Voice.Api.Reports
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type ReportStatuses =
| Queued = 0
| Running = 1
| Completed = 2
| Error = 3
[<AllowNullLiteral>]
type ReportInfo() =
member val Id:String = null with get,set
member val Name:String = null with get,set
member val Status:ReportStatuses = new ReportStatuses() with get,set
member val StatusMessage:String = null with get,set
member val DateCreated:String = null with get,set
member val DateUpdated:String = null with get,set
member val DownloadLink:String = null with get,set
member val JobId:String = null with get,set
member val EmailAddressToNotify:String = null with get,set
member val Server:String = null with get,set
[<AllowNullLiteral>]
type ReportRequest() =
interface IPost
///<summary>
///The account ID this report should be run for
///</summary>
[<ApiMember(Description="The account ID this report should be run for")>]
member val AccountId:String = null with get,set
///<summary>
///The email address to notify after the report is run
///</summary>
[<ApiMember(Description="The email address to notify after the report is run")>]
member val EmailAddressToNotify:String = null with get,set
///<summary>
///The webhook to call after the report is complete with the data from the report
///</summary>
[<ApiMember(Description="The webhook to call after the report is complete with the data from the report")>]
member val WebhookUrl:String = null with get,set
[<AllowNullLiteral>]
type CallCenterAbandonReport() =
inherit ReportRequest()
member val StartDate:String = null with get,set
member val EndDate:String = null with get,set
member val TimeZoneId:String = null with get,set
F# 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>