| GET | /portal/home |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Portal;
using Voice.Api.Messaging;
using Voice.Api.Sessions;
using Voice.Api;
using Voice.Api.Customers;
using Voice.Api.Flows;
using Voice.Api.Files;
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; }
}
}
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
{
public FileInfo()
{
CustomerBreadcrumb = new List<CustomerBreadcrumb>{};
}
///<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; }
}
public enum FileTypes
{
Upload,
VoiceMessage,
CallRecording,
Fax,
Attachment,
FaxOutgoing,
}
}
namespace Voice.Api.Flows
{
public enum FlowChannels
{
Voice,
Chat,
Fax,
}
}
namespace Voice.Api.Messaging
{
public partial class ConversationInfo
{
public virtual string Id { get; set; }
public virtual string EndpointId { get; set; }
public virtual string OtherAddress { get; set; }
public virtual MessageInfo MostRecentMessage { get; set; }
}
public enum MessageDirections
{
Incoming,
Outgoing,
}
public partial class MessageInfo
{
public virtual string Id { get; set; }
public virtual string AccountId { get; set; }
public virtual string CustomerId { get; set; }
public virtual string EndpointId { get; set; }
public virtual string EndpointDisplayName { get; set; }
public virtual string Date { get; set; }
public virtual MessageDirections Direction { get; set; }
public virtual string OtherAddress { get; set; }
public virtual string Sender { get; set; }
public virtual string Text { get; set; }
public virtual bool IsUnread { get; set; }
}
}
namespace Voice.Api.Portal
{
public partial class AppGetHomeInformation
{
public virtual string AccountId { get; set; }
public virtual string CustomerId { get; set; }
public virtual string FromDate { get; set; }
}
public partial class AppHomeCallMetric
{
public virtual string MetricKey { get; set; }
public virtual double Total { get; set; }
public virtual double Average { get; set; }
}
public partial class AppHomeInformation
{
public AppHomeInformation()
{
Conversations = new List<ConversationInfo>{};
Calls = new List<SessionInfo>{};
CallMetrics = new List<AppHomeCallMetric>{};
Voicemail = new List<FileInfo>{};
Forms = new List<HostedSuiteCompletedForm>{};
}
public virtual bool IsHostedSuiteCustomer { get; set; }
public virtual List<ConversationInfo> Conversations { get; set; }
public virtual List<SessionInfo> Calls { get; set; }
public virtual List<AppHomeCallMetric> CallMetrics { get; set; }
public virtual List<FileInfo> Voicemail { get; set; }
public virtual List<HostedSuiteCompletedForm> Forms { get; set; }
}
public partial class HostedSuiteCompletedForm
{
public HostedSuiteCompletedForm()
{
ContactsIds = new List<string>{};
ContactsNames = new List<string>{};
Fields = new List<HostedSuiteCompletedFormField>{};
}
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual string DateCreated { get; set; }
public virtual string DateCompleted { get; set; }
public virtual string FormId { get; set; }
public virtual string FormName { get; set; }
public virtual string ClientId { get; set; }
public virtual string ClientName { get; set; }
public virtual string ContactId { get; set; }
public virtual string ContactName { get; set; }
public virtual List<string> ContactsIds { get; set; }
public virtual List<string> ContactsNames { get; set; }
public virtual string EmailSubject { get; set; }
public virtual string CallerNumber { get; set; }
public virtual List<HostedSuiteCompletedFormField> Fields { get; set; }
}
public partial class HostedSuiteCompletedFormField
{
public HostedSuiteCompletedFormField()
{
Values = new List<string>{};
}
public virtual string Name { get; set; }
public virtual List<string> Values { get; set; }
}
}
namespace Voice.Api.Sessions
{
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
{
public SessionInfo()
{
CustomerBreadcrumb = new List<CustomerBreadcrumb>{};
Log = new List<SessionLogInfo>{};
Members = new List<SessionMemberInfo>{};
}
///<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 SessionMemberInfo()
{
ApplicationData = new Dictionary<string, string>{};
}
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,
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /portal/home HTTP/1.1 Host: evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"isHostedSuiteCustomer":false,"conversations":[{"id":"String","endpointId":"String","otherAddress":"String","mostRecentMessage":{"id":"String","accountId":"String","customerId":"String","endpointId":"String","endpointDisplayName":"String","date":"String","direction":"Incoming","otherAddress":"String","sender":"String","text":"String","isUnread":false}}],"calls":[{"dialState":"None","callState":"Disconnected","queueState":"None","accountId":"String","accountName":"String","customerId":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"customerName":"String","endpointId":"String","endpointName":"String","dateCompleted":"String","destination":"String","toAddress":"String","fromAddress":"String","fromName":"String","answeredByName":"String","queueMemberId":"String","channel":"Voice","ended":false,"outcome":"String","callSid":"String","consoleData":"String","holdQueueName":"String","heldByUserId":"String","holdReason":"None","conferenceSid":"String","displayName":"String","log":[{"date":"String","message":"String"}],"members":[{"identity":"String","endpointId":"String","displayName":"String","isOriginalMember":false,"avatarUrl":"String","applicationData":{"String":"String"},"callState":"None","role":"None","callSid":"String","muted":false}],"callbackNumber":"String","answeredById":"String","direction":"Incoming","fromPhoneNumber":"String","mostRecentParticipantCallSid":"String","wasMissed":false,"ringQueueId":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"callMetrics":[{"metricKey":"String","total":0,"average":0}],"voicemail":[{"type":"Upload","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userId":"String","userName":"String","fileName":"String","uri":"String","contentType":"String","contentLength":0,"recordingSid":"String","recordingDuration":0,"recordingFrom":"String","transcription":"String","fromAddress":"String","toAddress":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"forms":[{"id":"String","name":"String","dateCreated":"String","dateCompleted":"String","formId":"String","formName":"String","clientId":"String","clientName":"String","contactId":"String","contactName":"String","contactsIds":["String"],"contactsNames":["String"],"emailSubject":"String","callerNumber":"String","fields":[{"name":"String","values":["String"]}]}]}