Evo Voice

<back to all web services

NotUsedRequest

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api;
using Voice.Api.App;
using Voice.Api.Flows;
using Voice.Api.Endpoints;
using Voice.Api.Notifications;
using Voice.Api.Customers;
using Voice.Api.Files;
using Voice.Api.Flows.Data;

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 NotUsedRequest
    {
        public virtual PushNotification PushNotification { get; set; }
        public virtual List<NotificationInfo> Notifications { get; set; }
        public virtual NodeParameter NodeParameter { get; set; }
    }

}

namespace Voice.Api.App
{
    public partial class PushNotification
    {
        public virtual PushNotificationTypes Type { get; set; }
        public virtual FlowChannels Channel { get; set; }
        public virtual string EndpointId { get; set; }
        public virtual string EndpointUserName { get; set; }
        public virtual string SessionId { get; set; }
        public virtual string Sender { get; set; }
        public virtual string Title { get; set; }
        public virtual string Body { get; set; }
        public virtual int? Badge { get; set; }
        public virtual string AttachmentUri { get; set; }
        public virtual string AttachmentContentType { get; set; }
        public virtual AgentStates AgentState { get; set; }
        public virtual AgentStateReasons AgentStateReason { get; set; }
    }

    public enum PushNotificationTypes
    {
        SessionDisconnected,
        SessionInvite,
        ChatMessage,
        SessionInactivated,
        AgentStateChanged,
        SessionHeld,
        SessionAnswered,
        ActiveSessionsChanged,
        Ping,
        SessionScreenChanged,
        Toast,
        SessionInfoChanged,
        MessageReceived,
        SessionHolding,
    }

}

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

}

namespace Voice.Api.Endpoints
{
    public enum AgentStateReasons
    {
        Unknown,
        SetByUser,
        MissedCall,
        SetBySystem,
    }

    public enum AgentStates
    {
        Unknown,
        Ready,
        NotReady,
        LoggedOut,
        WrapUp,
        Outgoing,
        Other,
    }

    public enum UserDataFieldModes
    {
        Hidden,
        ReadOnly,
        ReadWrite,
    }

}

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,
    }

}

namespace Voice.Api.Flows
{
    public enum FlowChannels
    {
        Voice,
        Chat,
        Fax,
    }

    public partial class NodeParameter
    {
        public virtual string Id { get; set; }
        public virtual ValueTypes Type { get; set; }
        public virtual ValueSources Source { get; set; }
        public virtual bool IsAsync { get; set; }
        public virtual string ReferenceId { get; set; }
        public virtual Value Value { get; set; }
        public virtual bool NoEvalTemplate { get; set; }
        public virtual List<NodeParameterMap> ListParameters { get; set; }
        public virtual NodeParameterMap StructParameters { get; set; }
        public virtual bool IsOutput { get; set; }
        public virtual string Expression { get; set; }
        public virtual DataType ListType { get; set; }
    }

    public partial class NodeParameterMap
        : Dictionary<string, NodeParameter>
    {
    }

}

namespace Voice.Api.Flows.Data
{
    public partial class DataField
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual ValueTypes Type { get; set; }
        public virtual UIHints UIHint { get; set; }
        public virtual string UITab { get; set; }
        public virtual bool IsAsync { get; set; }
        public virtual bool DisableBinding { get; set; }
        public virtual DataType StructType { get; set; }
        public virtual DataType ListType { get; set; }
        public virtual string Description { get; set; }
        public virtual List<string> PossibleValues { get; set; }
        public virtual bool IsOutput { get; set; }
        public virtual string CustomFieldValuesUrl { get; set; }
        public virtual Value DefaultValue { get; set; }
        public virtual string TransitionNameFormat { get; set; }
        public virtual DataFieldUniqueness Uniqueness { get; set; }
        public virtual bool VoiceOnly { get; set; }
        public virtual string ConditionalVisibilityField { get; set; }
        public virtual string ConditionalVisibilityValue { get; set; }
        public virtual bool NoEvalTemplate { get; set; }
        public virtual UserDataFieldModes UserMode { get; set; }
        public virtual bool AnyValueType { get; set; }
    }

    public enum DataFieldUniqueness
    {
        NotUnique,
        Unique,
        UniqueToCustomer,
    }

    public partial class DataType
    {
        public virtual string TypeName { get; set; }
        public virtual List<DataField> Fields { get; set; }
    }

    public partial class Struct
        : Dictionary<string, Value>
    {
    }

    public enum UIHints
    {
        None,
        LargeText,
        InlineForm,
        Password,
        InlineStruct,
    }

    public partial class Value
    {
        public virtual bool? BoolValue { get; set; }
        public virtual string StringValue { get; set; }
        public virtual double? NumberValue { get; set; }
        public virtual List<Struct> ListValue { get; set; }
        public virtual Struct StructValue { get; set; }
    }

    public enum ValueSources
    {
        Value,
        Flow,
        System,
        Customer,
        Session,
        Endpoint,
        Expression,
        User,
    }

    public enum ValueTypes
    {
        NotSpecified,
        String,
        Boolean,
        Number,
        List,
        Struct,
        Transition,
        Custom,
        Date,
        AudioFile,
        TimeZoneId,
        PhoneNumber,
        User,
        Endpoint,
        Time,
        File,
        FaxNumber,
        EmailAccount,
        Customer,
        Flow,
        Team,
        FlowReference,
        Integration,
        Assistant,
    }

}

namespace Voice.Api.Notifications
{
    public partial class NotificationInfo
        : EntityInfo
    {
        ///<summary>
        ///The account ID this endpoint is associated with
        ///</summary>
        [ApiMember(Description="The account ID this endpoint is associated with")]
        public virtual string AccountId { get; set; }

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

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

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

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

        ///<summary>
        ///The type of notification
        ///</summary>
        [ApiMember(Description="The type of notification")]
        public virtual NotificationTypes Type { get; set; }

        ///<summary>
        ///The subject of the notification
        ///</summary>
        [ApiMember(Description="The subject of the notification")]
        public virtual string Subject { get; set; }

        ///<summary>
        ///The body of the notification
        ///</summary>
        [ApiMember(Description="The body of the notification")]
        public virtual string Body { get; set; }

        ///<summary>
        ///The recipients of this notification
        ///</summary>
        [ApiMember(Description="The recipients of this notification")]
        public virtual List<NotificationRecipientInfo> Recipients { get; set; }

        ///<summary>
        ///The list of attachments
        ///</summary>
        [ApiMember(Description="The list of attachments")]
        public virtual List<FileInfo> Attachments { get; set; }

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

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

        ///<summary>
        ///Was there an error?
        ///</summary>
        [ApiMember(Description="Was there an error?")]
        public virtual bool Error { get; set; }

        ///<summary>
        ///The error message
        ///</summary>
        [ApiMember(Description="The error message")]
        public virtual string ErrorMessage { get; set; }
    }

    public partial class NotificationRecipientInfo
    {
        ///<summary>
        ///The address of the recipient
        ///</summary>
        [ApiMember(Description="The address of the recipient")]
        public virtual string Address { get; set; }

        ///<summary>
        ///Extra info about the recipient e.g. CC, BCC
        ///</summary>
        [ApiMember(Description="Extra info about the recipient e.g. CC, BCC")]
        public virtual string Extra { get; set; }

        ///<summary>
        ///The name of the recipient
        ///</summary>
        [ApiMember(Description="The name of the recipient")]
        public virtual string Name { get; set; }
    }

    public enum NotificationTypes
    {
        Email,
        Sms,
        Push,
        IncomingCall,
        OutgoingCall,
    }

}

C# NotUsedRequest DTOs

POST /not-used HTTP/1.1 
Host: team.evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"pushNotification":{"type":"SessionDisconnected","channel":"Voice","endpointId":"String","endpointUserName":"String","sessionId":"String","sender":"String","title":"String","body":"String","badge":0,"attachmentUri":"String","attachmentContentType":"String","agentState":"Unknown","agentStateReason":"Unknown"},"notifications":[{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"type":"Email","subject":"String","body":"String","recipients":[{"address":"String","extra":"String","name":"String"}],"attachments":[{"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","aiTranscription":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"from":"String","to":"String","error":false,"errorMessage":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}]}