Evo Voice

<back to all web services

ListSessions

Retrieve a list of sessions

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Sessions;
using Voice.Api;
using Voice.Api.Customers;
using Voice.Api.Flows;
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.Flows
{
    public enum FlowChannels
    {
        Voice,
        Chat,
        Fax,
    }

}

namespace Voice.Api.Sessions
{
    ///<summary>
    ///Retrieve a list of sessions
    ///</summary>
    [Api(Description="Retrieve a list of sessions")]
    public partial class ListSessions
        : ListRequest<SessionInfo>
    {
        ///<summary>
        ///The account IDs for the sessions to retrieve
        ///</summary>
        [ApiMember(Description="The account IDs for the sessions to retrieve")]
        public virtual List<string> AccountIds { get; set; }

        ///<summary>
        ///Whether to search live or archived sessions
        ///</summary>
        [ApiMember(Description="Whether to search live or archived sessions")]
        public virtual bool SearchArchive { get; set; }

        ///<summary>
        ///The start date to retrieve usage records for (YYYY-MM-DD)
        ///</summary>
        [ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")]
        public virtual string StartDate { get; set; }

        ///<summary>
        ///The end date to retrieve usage records for (YYYY-MM-DD)
        ///</summary>
        [ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)")]
        public virtual string EndDate { get; set; }

        ///<summary>
        ///The IDs of the customers whose sessions you want to retrieve
        ///</summary>
        [ApiMember(Description="The IDs of the customers whose sessions you want to retrieve")]
        public virtual List<string> CustomerIds { get; set; }

        ///<summary>
        ///The IDs of the endpoints whose sessions you want to retrieve
        ///</summary>
        [ApiMember(Description="The IDs of the endpoints whose sessions you want to retrieve")]
        public virtual List<string> EndpointIds { get; set; }

        ///<summary>
        ///Filter by the from  (this is a contains search)
        ///</summary>
        [ApiMember(Description="Filter by the from  (this is a contains search)")]
        public virtual string From { get; set; }

        ///<summary>
        ///Filter by the to  (this is a contains search)
        ///</summary>
        [ApiMember(Description="Filter by the to  (this is a contains search)")]
        public virtual string To { get; set; }

        ///<summary>
        ///Filter by text in the log
        ///</summary>
        [ApiMember(Description="Filter by text in the log")]
        public virtual string Log { get; set; }

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

    public enum SessionCallState
    {
        Disconnected,
        Ringing,
        Connected,
        Hold,
        Passive,
    }

    public enum SessionDialState
    {
        None,
        Active,
    }

    public enum SessionDirections
    {
        Incoming,
        Outgoing,
    }

    public enum SessionHoldReasons
    {
        None,
        Transferring,
    }

    public partial class SessionInfo
        : EntityInfo
    {
        ///<summary>
        ///The state of the session
        ///</summary>
        [ApiMember(Description="The state of the session")]
        public virtual SessionDialState DialState { get; set; }

        ///<summary>
        ///The call state of the session
        ///</summary>
        [ApiMember(Description="The call state of the session")]
        public virtual SessionCallState CallState { get; set; }

        ///<summary>
        ///The queue state of the session
        ///</summary>
        [ApiMember(Description="The queue state of the session")]
        public virtual SessionQueueStates QueueState { get; set; }

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

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

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

        ///<summary>
        ///The customer breadcrumb this session is associated with
        ///</summary>
        [ApiMember(Description="The customer breadcrumb this session is associated with")]
        public virtual List<CustomerBreadcrumb> CustomerBreadcrumb { get; set; }

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

        ///<summary>
        ///The ID of the endpoint associated with this session
        ///</summary>
        [ApiMember(Description="The ID of the endpoint associated with this session")]
        public virtual string EndpointId { get; set; }

        ///<summary>
        ///The name of the endpoint associated with this session
        ///</summary>
        [ApiMember(Description="The name of the endpoint associated with this session")]
        public virtual string EndpointName { get; set; }

        ///<summary>
        ///The date the call completed
        ///</summary>
        [ApiMember(Description="The date the call completed")]
        public virtual string DateCompleted { get; set; }

        ///<summary>
        ///The destination of the session (e.g. what was entered into the Dial box)
        ///</summary>
        [ApiMember(Description="The destination of the session (e.g. what was entered into the Dial box)")]
        public virtual string Destination { get; set; }

        ///<summary>
        ///The to address if any
        ///</summary>
        [ApiMember(Description="The to address if any")]
        public virtual string ToAddress { get; set; }

        ///<summary>
        ///The from address if any
        ///</summary>
        [ApiMember(Description="The from address if any")]
        public virtual string FromAddress { get; set; }

        ///<summary>
        ///The from name if any
        ///</summary>
        [ApiMember(Description="The from name if any")]
        public virtual string FromName { get; set; }

        ///<summary>
        ///Answered by name (if any)
        ///</summary>
        [ApiMember(Description="Answered by name (if any)")]
        public virtual string AnsweredByName { get; set; }

        ///<summary>
        ///The ID of the queue member assigned to this call
        ///</summary>
        [ApiMember(Description="The ID of the queue member assigned to this call")]
        public virtual string QueueMemberId { get; set; }

        ///<summary>
        ///The flow channel
        ///</summary>
        [ApiMember(Description="The flow channel")]
        public virtual FlowChannels Channel { get; set; }

        ///<summary>
        ///Has the session ended
        ///</summary>
        [ApiMember(Description="Has the session ended")]
        public virtual bool Ended { get; set; }

        ///<summary>
        ///The outcome of the call
        ///</summary>
        [ApiMember(Description="The outcome of the call")]
        public virtual string Outcome { get; set; }

        ///<summary>
        ///The twilio Call SID of this session
        ///</summary>
        [ApiMember(Description="The twilio Call SID of this session")]
        public virtual string CallSid { get; set; }

        ///<summary>
        ///Any console data for this session
        ///</summary>
        [ApiMember(Description="Any console data for this session")]
        public virtual string ConsoleData { get; set; }

        ///<summary>
        ///The name of the hold queue for this call
        ///</summary>
        [ApiMember(Description="The name of the hold queue for this call")]
        public virtual string HoldQueueName { get; set; }

        ///<summary>
        ///The user ID who put this call on hold
        ///</summary>
        [ApiMember(Description="The user ID who put this call on hold")]
        public virtual string HeldByUserId { get; set; }

        ///<summary>
        ///The reason for the hold
        ///</summary>
        [ApiMember(Description="The reason for the hold")]
        public virtual SessionHoldReasons HoldReason { get; set; }

        ///<summary>
        ///The SID of the conference if in a conference call
        ///</summary>
        [ApiMember(Description="The SID of the conference if in a conference call")]
        public virtual string ConferenceSid { get; set; }

        ///<summary>
        ///The display name for this session
        ///</summary>
        [ApiMember(Description="The display name for this session")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The log entries for this session
        ///</summary>
        [ApiMember(Description="The log entries for this session")]
        public virtual List<SessionLogInfo> Log { get; set; }

        ///<summary>
        ///The members of this session
        ///</summary>
        [ApiMember(Description="The members of this session")]
        public virtual List<SessionMemberInfo> Members { get; set; }

        ///<summary>
        ///The callback number (typically used for SIP to User calls)
        ///</summary>
        [ApiMember(Description="The callback number (typically used for SIP to User calls)")]
        public virtual string CallbackNumber { get; set; }

        ///<summary>
        ///The ID of the endpoint that answered
        ///</summary>
        [ApiMember(Description="The ID of the endpoint that answered")]
        public virtual string AnsweredById { get; set; }

        ///<summary>
        ///Is this session incoming or outgoing?
        ///</summary>
        [ApiMember(Description="Is this session incoming or outgoing?")]
        public virtual SessionDirections Direction { get; set; }

        ///<summary>
        ///The phone number that this session is coming from (used with SMS chats)
        ///</summary>
        [ApiMember(Description="The phone number that this session is coming from (used with SMS chats)")]
        public virtual string FromPhoneNumber { get; set; }

        ///<summary>
        ///The Call SID of the most recently added conference participant
        ///</summary>
        [ApiMember(Description="The Call SID of the most recently added conference participant")]
        public virtual string MostRecentParticipantCallSid { get; set; }

        ///<summary>
        ///Was this session missed?
        ///</summary>
        [ApiMember(Description="Was this session missed?")]
        public virtual bool WasMissed { get; set; }

        ///<summary>
        ///The ring queue that the call is currently in
        ///</summary>
        [ApiMember(Description="The ring queue that the call is currently in")]
        public virtual string RingQueueId { get; set; }
    }

    public partial class SessionLogInfo
    {
        public virtual string Date { get; set; }
        public virtual string Message { get; set; }
    }

    public enum SessionMemberCallState
    {
        None,
        Ringing,
        Connected,
        Hold,
    }

    public partial class SessionMemberInfo
    {
        public virtual string Identity { get; set; }
        public virtual string EndpointId { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual bool IsOriginalMember { get; set; }
        public virtual string AvatarUrl { get; set; }
        public virtual Dictionary<string, string> ApplicationData { get; set; }
        public virtual SessionMemberCallState CallState { get; set; }
        public virtual SessionMemberRoles Role { get; set; }
        public virtual string CallSid { get; set; }
        public virtual bool Muted { get; set; }
    }

    public enum SessionMemberRoles
    {
        None,
        Caller,
        Agent,
        Transfer,
    }

    public enum SessionQueueStates
    {
        None,
        Queued,
        Ringing,
        Connected,
        Hold,
        Disconnected,
    }

}

C# ListSessions DTOs

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

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

<ListResponseOfSessionInfoBWxtuWQa 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.Sessions">
    <d2p1:SessionInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:AnsweredById>String</d2p1:AnsweredById>
      <d2p1:AnsweredByName>String</d2p1:AnsweredByName>
      <d2p1:CallSid>String</d2p1:CallSid>
      <d2p1:CallState>Disconnected</d2p1:CallState>
      <d2p1:CallbackNumber>String</d2p1:CallbackNumber>
      <d2p1:Channel>Voice</d2p1:Channel>
      <d2p1:ConferenceSid>String</d2p1:ConferenceSid>
      <d2p1:ConsoleData>String</d2p1:ConsoleData>
      <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:DateCompleted>String</d2p1:DateCompleted>
      <d2p1:Destination>String</d2p1:Destination>
      <d2p1:DialState>None</d2p1:DialState>
      <d2p1:Direction>Incoming</d2p1:Direction>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Ended>false</d2p1:Ended>
      <d2p1:EndpointId>String</d2p1:EndpointId>
      <d2p1:EndpointName>String</d2p1:EndpointName>
      <d2p1:FromAddress>String</d2p1:FromAddress>
      <d2p1:FromName>String</d2p1:FromName>
      <d2p1:FromPhoneNumber>String</d2p1:FromPhoneNumber>
      <d2p1:HeldByUserId>String</d2p1:HeldByUserId>
      <d2p1:HoldQueueName>String</d2p1:HoldQueueName>
      <d2p1:HoldReason>None</d2p1:HoldReason>
      <d2p1:Log>
        <d2p1:SessionLogInfo>
          <d2p1:Date>String</d2p1:Date>
          <d2p1:Message>String</d2p1:Message>
        </d2p1:SessionLogInfo>
      </d2p1:Log>
      <d2p1:Members>
        <d2p1:SessionMemberInfo>
          <d2p1:ApplicationData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:ApplicationData>
          <d2p1:AvatarUrl>String</d2p1:AvatarUrl>
          <d2p1:CallSid>String</d2p1:CallSid>
          <d2p1:CallState>None</d2p1:CallState>
          <d2p1:DisplayName>String</d2p1:DisplayName>
          <d2p1:EndpointId>String</d2p1:EndpointId>
          <d2p1:Identity>String</d2p1:Identity>
          <d2p1:IsOriginalMember>false</d2p1:IsOriginalMember>
          <d2p1:Muted>false</d2p1:Muted>
          <d2p1:Role>None</d2p1:Role>
        </d2p1:SessionMemberInfo>
      </d2p1:Members>
      <d2p1:MostRecentParticipantCallSid>String</d2p1:MostRecentParticipantCallSid>
      <d2p1:Outcome>String</d2p1:Outcome>
      <d2p1:QueueMemberId>String</d2p1:QueueMemberId>
      <d2p1:QueueState>None</d2p1:QueueState>
      <d2p1:RingQueueId>String</d2p1:RingQueueId>
      <d2p1:ToAddress>String</d2p1:ToAddress>
      <d2p1:WasMissed>false</d2p1:WasMissed>
    </d2p1:SessionInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfSessionInfoBWxtuWQa>