Evo Voice

<back to all web services

ListFiles

Query for files

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Files;
using Voice.Api;
using Voice.Api.Customers;
using Voice.Api.Accounts;

namespace Voice.Api
{
    public partial class EntityInfo
    {
        ///<summary>
        ///The ID of the object
        ///</summary>
        [ApiMember(Description="The ID of the object")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The date the object was created
        ///</summary>
        [ApiMember(Description="The date the object was created")]
        public virtual string DateCreated { get; set; }

        ///<summary>
        ///The date the object was last modified
        ///</summary>
        [ApiMember(Description="The date the object was last modified")]
        public virtual string DateLastModified { get; set; }

        ///<summary>
        ///The user that created this object
        ///</summary>
        [ApiMember(Description="The user that created this object")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///The user that last modified this object
        ///</summary>
        [ApiMember(Description="The user that last modified this object")]
        public virtual string LastModifiedBy { get; set; }
    }

    public partial class ListRequest<T>
        : IGet
    {
        ///<summary>
        ///The page of data to retrieve
        ///</summary>
        [ApiMember(Description="The page of data to retrieve")]
        public virtual int Page { get; set; }

        ///<summary>
        ///If you want all objects to be returned. This should be used with care
        ///</summary>
        [ApiMember(Description="If you want all objects to be returned. This should be used with care")]
        public virtual bool All { get; set; }

        ///<summary>
        ///The number per page to retrieve
        ///</summary>
        [ApiMember(Description="The number per page to retrieve")]
        public virtual int CountPerPage { get; set; }

        ///<summary>
        ///Specific IDs
        ///</summary>
        [ApiMember(Description="Specific IDs")]
        public virtual List<string> SpecificIds { get; set; }

        ///<summary>
        ///Specify a sort field
        ///</summary>
        [ApiMember(Description="Specify a sort field")]
        public virtual string SortField { get; set; }

        ///<summary>
        ///Specify a sort order
        ///</summary>
        [ApiMember(Description="Specify a sort order")]
        public virtual SortOrders SortOrder { get; set; }

        ///<summary>
        ///Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
        ///</summary>
        [ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")]
        public virtual bool SimplifiedPaging { get; set; }
    }

    public partial class ListResponse<T>
    {
        ///<summary>
        ///The items
        ///</summary>
        [ApiMember(Description="The items")]
        public virtual List<AccountInfo> Items { get; set; }

        ///<summary>
        ///The total number of items
        ///</summary>
        [ApiMember(Description="The total number of items")]
        public virtual int TotalCount { get; set; }

        ///<summary>
        ///The total number of pages
        ///</summary>
        [ApiMember(Description="The total number of pages")]
        public virtual int TotalPages { get; set; }

        ///<summary>
        ///Are there more pages of items? Used with simplified paging
        ///</summary>
        [ApiMember(Description="Are there more pages of items? Used with simplified paging")]
        public virtual bool HasMorePages { get; set; }
    }

    public enum SortOrders
    {
        Ascend,
        Descend,
    }

}

namespace Voice.Api.Accounts
{
    public partial class AccountInfo
        : EntityInfo
    {
        ///<summary>
        ///The name of this account
        ///</summary>
        [ApiMember(Description="The name of this account")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The ID of this account's parent
        ///</summary>
        [ApiMember(Description="The ID of this account's parent")]
        public virtual string ParentAccountId { get; set; }

        ///<summary>
        ///The twilio account SID
        ///</summary>
        [ApiMember(Description="The twilio account SID")]
        public virtual string TwilioAccountSid { get; set; }

        ///<summary>
        ///The ancestors of this account. Useful for breadcrumbs
        ///</summary>
        [ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")]
        public virtual List<string> AncestorIds { get; set; }

        ///<summary>
        ///The max number of phone numbers this account can have
        ///</summary>
        [ApiMember(Description="The max number of phone numbers this account can have")]
        public virtual int MaxPhoneNumbers { get; set; }

        ///<summary>
        ///This account is BYOA
        ///</summary>
        [ApiMember(Description="This account is BYOA")]
        public virtual bool IsBYOA { get; set; }

        ///<summary>
        ///TrustHub Profile Sid
        ///</summary>
        [ApiMember(Description="TrustHub Profile Sid")]
        public virtual string TrustHubProfileSid { get; set; }

        ///<summary>
        ///The ID of the logo file
        ///</summary>
        [ApiMember(Description="The ID of the logo file")]
        public virtual string LogoId { get; set; }

        ///<summary>
        ///The URI of the logo file
        ///</summary>
        [ApiMember(Description="The URI of the logo file")]
        public virtual string LogoUri { get; set; }

        ///<summary>
        ///The billing settings for this account
        ///</summary>
        [ApiMember(Description="The billing settings for this account")]
        public virtual BillingSettings BillingSettings { get; set; }
    }

    public partial class BillingItem
    {
        public virtual double BaseCost { get; set; }
        public virtual double RawUnitMultiplier { get; set; }
        public virtual double UnitCost { get; set; }
        public virtual int Allowance { get; set; }
    }

    public partial class BillingSettings
    {
        public virtual BillingItem Base { get; set; }
        public virtual BillingItem LocalNumbers { get; set; }
        public virtual BillingItem TollFreeNumbers { get; set; }
        public virtual BillingItem InboundVoiceCalls { get; set; }
        public virtual BillingItem OutboundVoiceCalls { get; set; }
        public virtual BillingItem InboundFaxes { get; set; }
        public virtual BillingItem OutboundFaxes { get; set; }
        public virtual BillingItem InboundSmsMessages { get; set; }
        public virtual BillingItem OutboundSmsMessages { get; set; }
        public virtual BillingItem AIInsights { get; set; }
        public virtual BillingItem AILiveMinutes { get; set; }
    }

}

namespace Voice.Api.Customers
{
    public partial class CustomerBreadcrumb
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
    }

}

namespace Voice.Api.Files
{
    public partial class FileInfo
        : EntityInfo
    {
        ///<summary>
        ///The type of file this is
        ///</summary>
        [ApiMember(Description="The type of file this is")]
        public virtual FileTypes Type { get; set; }

        ///<summary>
        ///The account ID this file is associated with
        ///</summary>
        [ApiMember(Description="The account ID this file is associated with")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The name of the account this file is associated with
        ///</summary>
        [ApiMember(Description="The name of the account this file is associated with")]
        public virtual string AccountName { get; set; }

        ///<summary>
        ///The ID of the customer this file is associated with
        ///</summary>
        [ApiMember(Description="The ID of the customer this file is associated with")]
        public virtual string CustomerId { get; set; }

        ///<summary>
        ///The name of the customer this file is associated with
        ///</summary>
        [ApiMember(Description="The name of the customer this file is associated with")]
        public virtual string CustomerName { get; set; }

        ///<summary>
        ///The breadcrumb to the customer for this file
        ///</summary>
        [ApiMember(Description="The breadcrumb to the customer for this file")]
        public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }

        ///<summary>
        ///The ID of the user this file is assocaited with
        ///</summary>
        [ApiMember(Description="The ID of the user this file is assocaited with")]
        public virtual string UserId { get; set; }

        ///<summary>
        ///The name of the user this file is associated with
        ///</summary>
        [ApiMember(Description="The name of the user this file is associated with")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///The original file name for the file
        ///</summary>
        [ApiMember(Description="The original file name for the file")]
        public virtual string FileName { get; set; }

        ///<summary>
        ///The URI of the file
        ///</summary>
        [ApiMember(Description="The URI of the file")]
        public virtual string Uri { get; set; }

        ///<summary>
        ///The Content type of the file
        ///</summary>
        [ApiMember(Description="The Content type of the file")]
        public virtual string ContentType { get; set; }

        ///<summary>
        ///The size of the file
        ///</summary>
        [ApiMember(Description="The size of the file")]
        public virtual long ContentLength { get; set; }

        ///<summary>
        ///The Twilio ID of the recording
        ///</summary>
        [ApiMember(Description="The Twilio ID of the recording")]
        public virtual string RecordingSid { get; set; }

        ///<summary>
        ///The duration of the recording in seconds
        ///</summary>
        [ApiMember(Description="The duration of the recording in seconds")]
        public virtual int RecordingDuration { get; set; }

        ///<summary>
        ///Who is the recording from?
        ///</summary>
        [ApiMember(Description="Who is the recording from?")]
        public virtual string RecordingFrom { get; set; }

        ///<summary>
        ///Transcription (if available)
        ///</summary>
        [ApiMember(Description="Transcription (if available)")]
        public virtual string Transcription { get; set; }

        ///<summary>
        ///From Address (e.g. caller ID) for incoming calls
        ///</summary>
        [ApiMember(Description="From Address (e.g. caller ID) for incoming calls")]
        public virtual string FromAddress { get; set; }

        ///<summary>
        ///To Address (e.g. dialed number) for outgoing calls
        ///</summary>
        [ApiMember(Description="To Address (e.g. dialed number) for outgoing calls")]
        public virtual string ToAddress { get; set; }

        ///<summary>
        ///The AI transcription for this call
        ///</summary>
        [ApiMember(Description="The AI transcription for this call")]
        public virtual string AITranscription { get; set; }
    }

    public enum FileTypes
    {
        Upload,
        VoiceMessage,
        CallRecording,
        Fax,
        Attachment,
        FaxOutgoing,
    }

    ///<summary>
    ///Query for files
    ///</summary>
    [Api(Description="Query for files")]
    public partial class ListFiles
        : ListRequest<FileInfo>
    {
        ///<summary>
        ///Filter by account id
        ///</summary>
        [ApiMember(Description="Filter by account id")]
        public virtual List<string> AccountIds { get; set; }

        ///<summary>
        ///Filter by customer id
        ///</summary>
        [ApiMember(Description="Filter by customer id")]
        public virtual List<string> CustomerIds { get; set; }

        ///<summary>
        ///Filter by specific session
        ///</summary>
        [ApiMember(Description="Filter by specific session")]
        public virtual string SessionId { get; set; }

        ///<summary>
        ///Filter by file name (contains filter)
        ///</summary>
        [ApiMember(Description="Filter by file name (contains filter)")]
        public virtual string FileName { get; set; }

        ///<summary>
        ///Filter by content type (contains filter)
        ///</summary>
        [ApiMember(Description="Filter by content type (contains filter)")]
        public virtual string ContentType { get; set; }

        ///<summary>
        ///Filter by type
        ///</summary>
        [ApiMember(Description="Filter by type")]
        public virtual FileTypes? Type { get; set; }

        ///<summary>
        ///Filter by date created (start of range)
        ///</summary>
        [ApiMember(Description="Filter by date created (start of range)")]
        public virtual string DateCreatedStart { get; set; }

        ///<summary>
        ///Filter by date created (end of range)
        ///</summary>
        [ApiMember(Description="Filter by date created (end of range)")]
        public virtual string DateCreatedEnd { get; set; }

        ///<summary>
        ///Filter by agent ID
        ///</summary>
        [ApiMember(Description="Filter by agent ID")]
        public virtual string UserId { get; set; }

        ///<summary>
        ///Search transcription
        ///</summary>
        [ApiMember(Description="Search transcription")]
        public virtual string TranscriptionContains { get; set; }
    }

}

C# ListFiles DTOs

GET /files HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfFileInfoS8MZGchS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
  <HasMorePages>false</HasMorePages>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Files">
    <d2p1:FileInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AITranscription>String</d2p1:AITranscription>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:ContentLength>0</d2p1:ContentLength>
      <d2p1:ContentType>String</d2p1:ContentType>
      <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
        <d4p1:CustomerBreadcrumb>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:CustomerBreadcrumb>
      </d2p1:CustomerBreadcrumb>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FromAddress>String</d2p1:FromAddress>
      <d2p1:RecordingDuration>0</d2p1:RecordingDuration>
      <d2p1:RecordingFrom>String</d2p1:RecordingFrom>
      <d2p1:RecordingSid>String</d2p1:RecordingSid>
      <d2p1:ToAddress>String</d2p1:ToAddress>
      <d2p1:Transcription>String</d2p1:Transcription>
      <d2p1:Type>Upload</d2p1:Type>
      <d2p1:Uri>String</d2p1:Uri>
      <d2p1:UserId>String</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:FileInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfFileInfoS8MZGchS>