Requires any of the roles: | SystemAdministrator, Manager, Customer |
All Verbs | /reports/sync-phone-numbers |
---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Reports;
namespace Voice.Api.Reports
{
public partial class ReportInfo
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual ReportStatuses Status { get; set; }
public virtual string StatusMessage { get; set; }
public virtual string DateCreated { get; set; }
public virtual string DateUpdated { get; set; }
public virtual string DownloadLink { get; set; }
public virtual string JobId { get; set; }
public virtual string EmailAddressToNotify { get; set; }
public virtual string Server { get; set; }
}
public partial class ReportRequest
: IPost
{
///<summary>
///The account ID this report should be run for
///</summary>
[ApiMember(Description="The account ID this report should be run for")]
public virtual string AccountId { 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")]
public virtual string EmailAddressToNotify { 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")]
public virtual string WebhookUrl { get; set; }
}
public enum ReportStatuses
{
Queued,
Running,
Completed,
Error,
}
public partial class SyncPhoneNumbersReport
: ReportRequest
{
public virtual bool SyncDocumoNumbers { get; set; }
}
}
C# SyncPhoneNumbersReport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /reports/sync-phone-numbers HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
syncDocumoNumbers: False,
accountId: String,
emailAddressToNotify: String,
webhookUrl: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: String, name: String, status: Queued, statusMessage: String, dateCreated: String, dateUpdated: String, downloadLink: String, jobId: String, emailAddressToNotify: String, server: String }