GET | /portal/users |
---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.App.Portal;
using Voice.Api;
using Voice.Api.Endpoints;
using Voice.Api.Customers;
using Voice.Api.Flows.Data;
using Voice.Api.Scheduling;
using Voice.Api.Authentication;
using Voice.Api.Settings;
using Voice.Api.Integrations;
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.App.Portal
{
public partial class AppGetUsers
: ListRequest<EndpointInfo>
{
public virtual string AccountId { get; set; }
public virtual string CustomerId { get; set; }
public virtual UserModes? UserMode { get; set; }
public virtual string Name { get; set; }
}
}
namespace Voice.Api.Authentication
{
public enum DashboardPermissions
{
ViewFiles,
ViewNotifications,
ViewSessions,
ViewEndpoints,
ViewReports,
ViewCustomers,
ViewFlows,
}
}
namespace Voice.Api.Customers
{
public partial class AppSettings
{
public virtual bool EnablePhoneNumberManagement { get; set; }
public virtual bool EnableDeviceManagement { get; set; }
public virtual bool EnableDialer { get; set; }
public virtual bool EnableCallHistory { get; set; }
public virtual bool EnableAssistants { get; set; }
public virtual bool ShowFileNameInMessageCenter { get; set; }
public virtual string ChakraTheme { get; set; }
public virtual string CustomCss { get; set; }
public virtual string PageTitle { get; set; }
public virtual string StringMappings { get; set; }
public virtual string LogoutUrl { get; set; }
public virtual string PortMyNumberUrl { get; set; }
}
public partial class CustomerBreadcrumb
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
}
}
namespace Voice.Api.Endpoints
{
public enum ActionUrlHttpMethods
{
GET,
POST,
}
public enum AgentStateReasons
{
Unknown,
SetByUser,
MissedCall,
SetBySystem,
}
public enum AgentStates
{
Unknown,
Ready,
NotReady,
LoggedOut,
WrapUp,
Outgoing,
Other,
}
public partial class AssistantContact
{
public virtual string Name { get; set; }
public virtual string PhoneNumber { get; set; }
public virtual AssistantTransferTypes TransferType { get; set; }
public virtual string About { get; set; }
public virtual string EmailAddress { get; set; }
public virtual List<AssistantTakeMessageField> TakeMessageFields { get; set; }
}
public partial class AssistantIntegration
{
public virtual string Uri { get; set; }
public virtual string HttpMethod { get; set; }
public virtual string AuthToken { get; set; }
}
public partial class AssistantLink
{
public virtual string Url { get; set; }
public virtual string Description { get; set; }
}
public partial class AssistantSettings
{
public virtual string CompanyName { get; set; }
public virtual string Greeting { get; set; }
public virtual string CompanyInformation { get; set; }
public virtual string CustomPrompt { get; set; }
public virtual string Voice { get; set; }
public virtual string VoiceStyle { get; set; }
public virtual AssistantTunings Tuning { get; set; }
public virtual List<AssistantWord> Words { get; set; }
public virtual List<AssistantLink> Links { get; set; }
public virtual List<AssistantContact> Contacts { get; set; }
public virtual List<AssistantIntegration> Integrations { get; set; }
}
public partial class AssistantTakeMessageField
{
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual bool Required { get; set; }
}
public enum AssistantTransferTypes
{
Blind,
Supervised,
MessagesOnly,
}
public enum AssistantTunings
{
Accuracy,
Speed,
}
public partial class AssistantWord
{
public virtual string Word { get; set; }
public virtual string Pronounced { get; set; }
}
public enum CustomerVisibility
{
None,
CurrentCustomer,
CurrentAndChildCustomers,
}
public partial class EmbedSettings
{
public virtual bool Enabled { get; set; }
public virtual string AllowedHosts { get; set; }
}
public partial class EndpointActionUrl
{
public virtual string Id { get; set; }
public virtual string Url { get; set; }
public virtual ActionUrlHttpMethods Method { get; set; }
}
public partial class EndpointContact
{
public virtual string Id { get; set; }
public virtual string DisplayName { get; set; }
public virtual string Address { get; set; }
}
public enum EndpointFlowSchedules
{
Always,
Scheduled,
Simple,
}
public partial class EndpointInfo
: 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 third party reference ID for the endpoint
///</summary>
[ApiMember(Description="The third party reference ID for the endpoint")]
public virtual string ReferenceId { 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 display name of the endpoint
///</summary>
[ApiMember(Description="The display name of the endpoint")]
public virtual string DisplayName { get; set; }
///<summary>
///The type of endpoint
///</summary>
[ApiMember(Description="The type of endpoint")]
public virtual EndpointTypes Type { get; set; }
///<summary>
///Extra info for this endpoint (typically to show in grid)
///</summary>
[ApiMember(Description="Extra info for this endpoint (typically to show in grid)")]
public virtual string ExtraInformation { get; set; }
///<summary>
///The ID of the flow to use for voice
///</summary>
[ApiMember(Description="The ID of the flow to use for voice")]
public virtual string FlowId { get; set; }
///<summary>
///The name of the flow to use for voice
///</summary>
[ApiMember(Description="The name of the flow to use for voice")]
public virtual string FlowName { get; set; }
///<summary>
///The params for the voice flow
///</summary>
[ApiMember(Description="The params for the voice flow")]
public virtual Struct FlowParams { get; set; }
///<summary>
///Whether to use a single flow always or use scheduled flow system
///</summary>
[ApiMember(Description="Whether to use a single flow always or use scheduled flow system")]
public virtual EndpointFlowSchedules FlowSchedule { get; set; }
///<summary>
///This endpoint's schedule
///</summary>
[ApiMember(Description="This endpoint's schedule")]
public virtual Schedule Schedule { get; set; }
///<summary>
///The list of scheduled flows when using scheduling
///</summary>
[ApiMember(Description="The list of scheduled flows when using scheduling")]
public virtual List<ScheduledFlow> ScheduledFlows { get; set; }
///<summary>
///Disable SMS
///</summary>
[ApiMember(Description="Disable SMS")]
public virtual bool DisableSms { get; set; }
///<summary>
///Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
///</summary>
[ApiMember(Description="Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number")]
public virtual bool UseExternal10DlcCampaign { get; set; }
///<summary>
///Is this a virtual phone number?
///</summary>
[ApiMember(Description="Is this a virtual phone number?")]
public virtual bool IsVirtualPhoneNumber { get; set; }
///<summary>
///Is caller ID verified for this virtual number?
///</summary>
[ApiMember(Description="Is caller ID verified for this virtual number?")]
public virtual bool IsCallerIdVerified { get; set; }
///<summary>
///The verification code for this number
///</summary>
[ApiMember(Description="The verification code for this number")]
public virtual string CallerIdVerificationCode { get; set; }
///<summary>
///The phone number
///</summary>
[ApiMember(Description="The phone number")]
public virtual string PhoneNumber { get; set; }
///<summary>
///The Sid of the phone number
///</summary>
[ApiMember(Description="The Sid of the phone number")]
public virtual string PhoneNumberSid { get; set; }
///<summary>
///The caller ID Name (CNAM) for the phone number
///</summary>
[ApiMember(Description="The caller ID Name (CNAM) for the phone number")]
public virtual string CallerIdName { get; set; }
///<summary>
///The address SID associated with the phone number
///</summary>
[ApiMember(Description="The address SID associated with the phone number")]
public virtual string AddressSid { get; set; }
///<summary>
///Do not touch this phone number - for BYOA accounts
///</summary>
[ApiMember(Description="Do not touch this phone number - for BYOA accounts")]
public virtual bool DoNotTouchPhoneNumber { get; set; }
///<summary>
///Is this number enrolled in a 10DLC messaging service campaign
///</summary>
[ApiMember(Description="Is this number enrolled in a 10DLC messaging service campaign")]
public virtual bool IsEnrolledIn10DlcService { get; set; }
///<summary>
///Whether we look up caller ID or not
///</summary>
[ApiMember(Description="Whether we look up caller ID or not")]
public virtual bool EnableCallerIdLookup { get; set; }
///<summary>
///The email address of the user
///</summary>
[ApiMember(Description="The email address of the user")]
public virtual string UserEmailAddress { get; set; }
///<summary>
///The Twilio Region for the SIP endpoint
///</summary>
[ApiMember(Description="The Twilio Region for the SIP endpoint")]
public virtual TwilioSipRegions SipRegion { get; set; }
///<summary>
///The Twilio Sid of the credentials for Sip
///</summary>
[ApiMember(Description="The Twilio Sid of the credentials for Sip")]
public virtual string SipCredentialSid { get; set; }
///<summary>
///The Twilio SIP user name
///</summary>
[ApiMember(Description="The Twilio SIP user name")]
public virtual string SipUserName { get; set; }
///<summary>
///The Twilio SIP password
///</summary>
[ApiMember(Description="The Twilio SIP password")]
public virtual string SipPassword { get; set; }
///<summary>
///The SIP domain
///</summary>
[ApiMember(Description="The SIP domain")]
public virtual string SipDomain { get; set; }
///<summary>
///Is emergency calling enabled on this number?
///</summary>
[ApiMember(Description="Is emergency calling enabled on this number?")]
public virtual bool EnableEmergencyCalling { get; set; }
///<summary>
///The SID of the emergency address for this number
///</summary>
[ApiMember(Description="The SID of the emergency address for this number")]
public virtual string EmergencyAddressSid { get; set; }
///<summary>
///The ID of the phone number to use for emergency dialing
///</summary>
[ApiMember(Description="The ID of the phone number to use for emergency dialing")]
public virtual string EmergencyPhoneNumberId { get; set; }
///<summary>
///The current agent state of this user endpoint
///</summary>
[ApiMember(Description="The current agent state of this user endpoint")]
public virtual AgentStates AgentState { get; set; }
///<summary>
///The current agent state reason of this user endpoint
///</summary>
[ApiMember(Description="The current agent state reason of this user endpoint")]
public virtual AgentStateReasons AgentStateReason { get; set; }
///<summary>
///The mode for this user
///</summary>
[ApiMember(Description="The mode for this user")]
public virtual UserModes UserMode { get; set; }
///<summary>
///The ID of the file to use for voicemail greeting
///</summary>
[ApiMember(Description="The ID of the file to use for voicemail greeting")]
public virtual string VoicemailGreetingId { get; set; }
///<summary>
///The endpoint's data
///</summary>
[ApiMember(Description="The endpoint's data")]
public virtual Struct Data { get; set; }
///<summary>
///The email address for email endpoints
///</summary>
[ApiMember(Description="The email address for email endpoints")]
public virtual string EmailAddress { get; set; }
///<summary>
///The first name of the user (for user endpoints)
///</summary>
[ApiMember(Description="The first name of the user (for user endpoints)")]
public virtual string UserFirstName { get; set; }
///<summary>
///The last name of the user (for user endpoints)
///</summary>
[ApiMember(Description="The last name of the user (for user endpoints)")]
public virtual string UserLastName { get; set; }
///<summary>
///The URL of an image for this user's avatar
///</summary>
[ApiMember(Description="The URL of an image for this user's avatar")]
public virtual string AvatarUrl { get; set; }
///<summary>
///Does this user have manager role?
///</summary>
[ApiMember(Description="Does this user have manager role?")]
public virtual UserManagerRoles ManagerRole { get; set; }
///<summary>
///The list of dashboard permissions for when the manager role is custom
///</summary>
[ApiMember(Description="The list of dashboard permissions for when the manager role is custom")]
public virtual List<DashboardPermissions> DashboardPermissions { get; set; }
///<summary>
///The type of visibility this user has to their own fields
///</summary>
[ApiMember(Description="The type of visibility this user has to their own fields")]
public virtual UserDataFieldModes MyFieldPermissions { get; set; }
///<summary>
///The type of visibility this user has to customer fields
///</summary>
[ApiMember(Description="The type of visibility this user has to customer fields")]
public virtual UserDataFieldModes CustomerFieldPermissions { get; set; }
///<summary>
///The type of visibility this user has to other user fields
///</summary>
[ApiMember(Description="The type of visibility this user has to other user fields")]
public virtual UserDataFieldModes OtherUserFieldPermissions { get; set; }
///<summary>
///The type of visibility this user has to other endpoint fields
///</summary>
[ApiMember(Description="The type of visibility this user has to other endpoint fields")]
public virtual UserDataFieldModes OtherEndpointFieldPermissions { get; set; }
///<summary>
///The name of this endpoint (for bots etc.)
///</summary>
[ApiMember(Description="The name of this endpoint (for bots etc.)")]
public virtual string Name { get; set; }
///<summary>
///The list of tags for this endpoint
///</summary>
[ApiMember(Description="The list of tags for this endpoint")]
public virtual List<Tag> Tags { get; set; }
///<summary>
///The list of action URLs
///</summary>
[ApiMember(Description="The list of action URLs")]
public virtual List<EndpointActionUrl> ActionUrls { get; set; }
///<summary>
///The list of members in this team
///</summary>
[ApiMember(Description="The list of members in this team")]
public virtual List<string> TeamMemberIds { get; set; }
///<summary>
///Visibility of this user/team in contact lists
///</summary>
[ApiMember(Description="Visibility of this user/team in contact lists")]
public virtual CustomerVisibility ContactListVisibility { get; set; }
///<summary>
///The list of contacts personal to this user
///</summary>
[ApiMember(Description="The list of contacts personal to this user")]
public virtual List<EndpointContact> Contacts { get; set; }
///<summary>
///The documo ID for this number
///</summary>
[ApiMember(Description="The documo ID for this number")]
public virtual string DocumoId { get; set; }
///<summary>
///Integration data for this endpoint
///</summary>
[ApiMember(Description="Integration data for this endpoint")]
public virtual EntityIntegrationData IntegrationData { get; set; }
///<summary>
///Settings for third party phone system
///</summary>
[ApiMember(Description="Settings for third party phone system")]
public virtual ThirdPartyPhoneSystemSettings ThirdPartyPhoneSystemSettings { get; set; }
///<summary>
///Should this user override the parent customer's app settings
///</summary>
[ApiMember(Description="Should this user override the parent customer's app settings")]
public virtual bool OverrideAppSettings { get; set; }
///<summary>
///App / Portal settings for this user
///</summary>
[ApiMember(Description="App / Portal settings for this user")]
public virtual AppSettings AppSettings { get; set; }
///<summary>
///Configuration for the AI assistant
///</summary>
[ApiMember(Description="Configuration for the AI assistant")]
public virtual AssistantSettings AssistantSettings { get; set; }
///<summary>
///Configuration for the embed
///</summary>
[ApiMember(Description="Configuration for the embed")]
public virtual EmbedSettings EmbedSettings { get; set; }
}
public enum EndpointTypes
{
PhoneNumber,
User,
FaxNumber,
EmailAddress,
Unused_1,
Unused_2,
Unused_3,
Unused_4,
Unused_5,
Team,
Assistant,
}
public partial class ScheduledFlow
{
public virtual string StateName { get; set; }
public virtual string FlowId { get; set; }
public virtual Struct FlowParams { get; set; }
}
public partial class ThirdPartyPhoneSystemSettings
{
public virtual ThirdPartyPhoneSystemTypes Type { get; set; }
public virtual ThirdPartySipSettings SipSettings { get; set; }
public virtual ThirdPartyDemoSettings DemoSettings { get; set; }
public partial class ThirdPartyDemoSettings
{
public virtual string Extension { get; set; }
}
public partial class ThirdPartySipSettings
{
public virtual List<ThirdPartySipAccountSettings> Accounts { get; set; }
public enum TransportTypes
{
UDP,
TLS,
TCP,
PERS,
}
public enum AudioCodecTypes
{
PCMU = 0,
GSM = 3,
PCMA = 8,
G722 = 9,
G729 = 18,
ILBC = 97,
AMR = 98,
AMRWB = 99,
SPEEX = 100,
DTMF = 101,
SPEEXWB = 102,
ISACWB = 103,
ISACSWB = 104,
OPUS = 105,
G7221 = 121,
NONE = -1,
}
public enum DtmfMethods
{
RFC2833,
INFO,
}
public partial class ThirdPartySipAccountSettings
{
public virtual string Number { get; set; }
public virtual string Agent { get; set; }
public virtual string AuthName { get; set; }
public virtual string UserName { get; set; }
public virtual string DisplayName { get; set; }
public virtual string Password { get; set; }
public virtual string UserDomain { get; set; }
public virtual int RegistrationExpires { get; set; }
public virtual TransportTypes TransportType { get; set; }
public virtual string LocalIP { get; set; }
public virtual int LocalPort { get; set; }
public virtual string SipServer { get; set; }
public virtual int SipServerPort { get; set; }
public virtual string OutboundServer { get; set; }
public virtual int OutboundServerPort { get; set; }
public virtual string StunServer { get; set; }
public virtual int StunPort { get; set; }
public virtual string AudioPlaybackDeviceName { get; set; }
public virtual string AudioRecordingDeviceName { get; set; }
public virtual List<AudioCodecTypes> AudioCodecs { get; set; }
public virtual DtmfMethods DTMFMethod { get; set; }
}
}
}
public enum ThirdPartyPhoneSystemTypes
{
Demo,
Sip,
}
public enum TwilioSipRegions
{
NorthAmericaVirginia,
NorthAmericaOregon,
EuropeIreland,
EuropeFrankfurt,
AsiaPacificSingapore,
AsiaPacificTokyo,
AsiaPacificSydney,
SouthAmericaSanPaolo,
}
public enum UserDataFieldModes
{
Hidden,
ReadOnly,
ReadWrite,
}
public enum UserManagerRoles
{
None,
Manager,
VoicemailAndCallHistory,
Custom,
}
public enum UserModes
{
SoftPhone,
Sip,
Flow,
DataOnly,
ThirdParty,
}
}
namespace Voice.Api.Flows.Data
{
public partial class Struct
: Dictionary<string, Value>
{
}
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; }
}
}
namespace Voice.Api.Integrations
{
public partial class EntityIntegrationData
: Dictionary<string, IntegrationData>
{
}
public partial class IntegrationData
{
public virtual string ThirdPartyId { get; set; }
}
}
namespace Voice.Api.Scheduling
{
public partial class Schedule
{
public virtual string TimeZoneId { get; set; }
public virtual bool Inherit { get; set; }
public virtual bool ForceClosed { get; set; }
public virtual List<SchedulingRule> Rules { get; set; }
public virtual string DefaultState { get; set; }
}
public partial class ScheduleDay
{
public virtual int Offset { get; set; }
public virtual DayOfWeek DayOfWeek { get; set; }
}
public partial class SchedulingRule
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual int Priority { get; set; }
public virtual string State { get; set; }
public virtual string Source { get; set; }
public virtual string Condition { get; set; }
public virtual SimpleSchedulingRuleTypes SimpleRuleType { get; set; }
public virtual string CustomerState { get; set; }
public virtual string FlowId { get; set; }
public virtual Struct FlowParams { get; set; }
public virtual bool IsAllDay { get; set; }
public virtual string StartDate { get; set; }
public virtual string StartTime { get; set; }
public virtual string EndTime { get; set; }
public virtual List<int> BySetPosition { get; set; }
public virtual List<int> ByMonth { get; set; }
public virtual List<int> ByWeekNo { get; set; }
public virtual List<int> ByYearDay { get; set; }
public virtual List<int> ByMonthDay { get; set; }
public virtual List<ScheduleDay> ByDay { get; set; }
public virtual List<int> ByHour { get; set; }
public virtual List<int> ByMinute { get; set; }
public virtual int Interval { get; set; }
public virtual int Count { get; set; }
public virtual string UntilDate { get; set; }
public virtual SchedulingRuleFrequency Frequency { get; set; }
}
public enum SchedulingRuleFrequency
{
None,
Secondly,
Minutely,
Hourly,
Daily,
Weekly,
Monthly,
Yearly,
}
public enum SimpleSchedulingRuleTypes
{
Always,
CustomerState,
Time,
}
}
namespace Voice.Api.Settings
{
public partial class Tag
{
public virtual string Id { get; set; }
public virtual string Name { get; set; }
public virtual TagColors Color { get; set; }
}
public enum TagColors
{
Magenta,
Red,
Volcano,
Orange,
Gold,
Lime,
Green,
Cyan,
Blue,
GeekBlue,
Purple,
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /portal/users HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListResponseOfEndpointInfoWeVlXEog 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.Endpoints"> <d2p1:EndpointInfo> <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:ActionUrls> <d2p1:EndpointActionUrl> <d2p1:Id>String</d2p1:Id> <d2p1:Method>GET</d2p1:Method> <d2p1:Url>String</d2p1:Url> </d2p1:EndpointActionUrl> </d2p1:ActionUrls> <d2p1:AddressSid>String</d2p1:AddressSid> <d2p1:AgentState>Unknown</d2p1:AgentState> <d2p1:AgentStateReason>Unknown</d2p1:AgentStateReason> <d2p1:AppSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers"> <d4p1:ChakraTheme>String</d4p1:ChakraTheme> <d4p1:CustomCss>String</d4p1:CustomCss> <d4p1:EnableAssistants>false</d4p1:EnableAssistants> <d4p1:EnableCallHistory>false</d4p1:EnableCallHistory> <d4p1:EnableDeviceManagement>false</d4p1:EnableDeviceManagement> <d4p1:EnableDialer>false</d4p1:EnableDialer> <d4p1:EnablePhoneNumberManagement>false</d4p1:EnablePhoneNumberManagement> <d4p1:LogoutUrl>String</d4p1:LogoutUrl> <d4p1:PageTitle>String</d4p1:PageTitle> <d4p1:PortMyNumberUrl>String</d4p1:PortMyNumberUrl> <d4p1:ShowFileNameInMessageCenter>false</d4p1:ShowFileNameInMessageCenter> <d4p1:StringMappings>String</d4p1:StringMappings> </d2p1:AppSettings> <d2p1:AssistantSettings> <d2p1:CompanyInformation>String</d2p1:CompanyInformation> <d2p1:CompanyName>String</d2p1:CompanyName> <d2p1:Contacts> <d2p1:AssistantContact> <d2p1:About>String</d2p1:About> <d2p1:EmailAddress>String</d2p1:EmailAddress> <d2p1:Name>String</d2p1:Name> <d2p1:PhoneNumber>String</d2p1:PhoneNumber> <d2p1:TakeMessageFields> <d2p1:AssistantTakeMessageField> <d2p1:Description>String</d2p1:Description> <d2p1:Name>String</d2p1:Name> <d2p1:Required>false</d2p1:Required> </d2p1:AssistantTakeMessageField> </d2p1:TakeMessageFields> <d2p1:TransferType>Blind</d2p1:TransferType> </d2p1:AssistantContact> </d2p1:Contacts> <d2p1:CustomPrompt>String</d2p1:CustomPrompt> <d2p1:Greeting>String</d2p1:Greeting> <d2p1:Integrations> <d2p1:AssistantIntegration> <d2p1:AuthToken>String</d2p1:AuthToken> <d2p1:HttpMethod>String</d2p1:HttpMethod> <d2p1:Uri>String</d2p1:Uri> </d2p1:AssistantIntegration> </d2p1:Integrations> <d2p1:Links> <d2p1:AssistantLink> <d2p1:Description>String</d2p1:Description> <d2p1:Url>String</d2p1:Url> </d2p1:AssistantLink> </d2p1:Links> <d2p1:Tuning>Accuracy</d2p1:Tuning> <d2p1:Voice>String</d2p1:Voice> <d2p1:VoiceStyle>String</d2p1:VoiceStyle> <d2p1:Words> <d2p1:AssistantWord> <d2p1:Pronounced>String</d2p1:Pronounced> <d2p1:Word>String</d2p1:Word> </d2p1:AssistantWord> </d2p1:Words> </d2p1:AssistantSettings> <d2p1:AvatarUrl>String</d2p1:AvatarUrl> <d2p1:CallerIdName>String</d2p1:CallerIdName> <d2p1:CallerIdVerificationCode>String</d2p1:CallerIdVerificationCode> <d2p1:ContactListVisibility>None</d2p1:ContactListVisibility> <d2p1:Contacts> <d2p1:EndpointContact> <d2p1:Address>String</d2p1:Address> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:Id>String</d2p1:Id> </d2p1:EndpointContact> </d2p1:Contacts> <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:CustomerFieldPermissions>Hidden</d2p1:CustomerFieldPermissions> <d2p1:CustomerId>String</d2p1:CustomerId> <d2p1:CustomerName>String</d2p1:CustomerName> <d2p1:DashboardPermissions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication"> <d4p1:DashboardPermissions>ViewFiles</d4p1:DashboardPermissions> </d2p1:DashboardPermissions> <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:DisableSms>false</d2p1:DisableSms> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:DoNotTouchPhoneNumber>false</d2p1:DoNotTouchPhoneNumber> <d2p1:DocumoId>String</d2p1:DocumoId> <d2p1:EmailAddress>String</d2p1:EmailAddress> <d2p1:EmbedSettings> <d2p1:AllowedHosts>String</d2p1:AllowedHosts> <d2p1:Enabled>false</d2p1:Enabled> </d2p1:EmbedSettings> <d2p1:EmergencyAddressSid>String</d2p1:EmergencyAddressSid> <d2p1:EmergencyPhoneNumberId>String</d2p1:EmergencyPhoneNumberId> <d2p1:EnableCallerIdLookup>false</d2p1:EnableCallerIdLookup> <d2p1:EnableEmergencyCalling>false</d2p1:EnableEmergencyCalling> <d2p1:ExtraInformation>String</d2p1:ExtraInformation> <d2p1:FlowId>String</d2p1:FlowId> <d2p1:FlowName>String</d2p1:FlowName> <d2p1:FlowParams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:FlowSchedule>Always</d2p1:FlowSchedule> <d2p1:IntegrationData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh> <d4p1:Key>String</d4p1:Key> <d4p1:Value xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations"> <d6p1:ThirdPartyId>String</d6p1:ThirdPartyId> </d4p1:Value> </d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh> </d2p1:IntegrationData> <d2p1:IsCallerIdVerified>false</d2p1:IsCallerIdVerified> <d2p1:IsEnrolledIn10DlcService>false</d2p1:IsEnrolledIn10DlcService> <d2p1:IsVirtualPhoneNumber>false</d2p1:IsVirtualPhoneNumber> <d2p1:ManagerRole>None</d2p1:ManagerRole> <d2p1:MyFieldPermissions>Hidden</d2p1:MyFieldPermissions> <d2p1:Name>String</d2p1:Name> <d2p1:OtherEndpointFieldPermissions>Hidden</d2p1:OtherEndpointFieldPermissions> <d2p1:OtherUserFieldPermissions>Hidden</d2p1:OtherUserFieldPermissions> <d2p1:OverrideAppSettings>false</d2p1:OverrideAppSettings> <d2p1:PhoneNumber>String</d2p1:PhoneNumber> <d2p1:PhoneNumberSid>String</d2p1:PhoneNumberSid> <d2p1:ReferenceId>String</d2p1:ReferenceId> <d2p1:Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling"> <d4p1:DefaultState>String</d4p1:DefaultState> <d4p1:ForceClosed>false</d4p1:ForceClosed> <d4p1:Inherit>false</d4p1:Inherit> <d4p1:Rules> <d4p1:SchedulingRule> <d4p1:ByDay> <d4p1:ScheduleDay> <d4p1:DayOfWeek>Sunday</d4p1:DayOfWeek> <d4p1:Offset>0</d4p1:Offset> </d4p1:ScheduleDay> </d4p1:ByDay> <d4p1:ByHour xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByHour> <d4p1:ByMinute xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMinute> <d4p1:ByMonth xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMonth> <d4p1:ByMonthDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMonthDay> <d4p1:BySetPosition xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:BySetPosition> <d4p1:ByWeekNo xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByWeekNo> <d4p1:ByYearDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByYearDay> <d4p1:Condition>String</d4p1:Condition> <d4p1:Count>0</d4p1:Count> <d4p1:CustomerState>String</d4p1:CustomerState> <d4p1:EndTime>String</d4p1:EndTime> <d4p1:FlowId>String</d4p1:FlowId> <d4p1:FlowParams xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d4p1:Frequency>None</d4p1:Frequency> <d4p1:Id>String</d4p1:Id> <d4p1:Interval>0</d4p1:Interval> <d4p1:IsAllDay>false</d4p1:IsAllDay> <d4p1:Name>String</d4p1:Name> <d4p1:Priority>0</d4p1:Priority> <d4p1:SimpleRuleType>Always</d4p1:SimpleRuleType> <d4p1:Source>String</d4p1:Source> <d4p1:StartDate>String</d4p1:StartDate> <d4p1:StartTime>String</d4p1:StartTime> <d4p1:State>String</d4p1:State> <d4p1:UntilDate>String</d4p1:UntilDate> </d4p1:SchedulingRule> </d4p1:Rules> <d4p1:TimeZoneId>String</d4p1:TimeZoneId> </d2p1:Schedule> <d2p1:ScheduledFlows> <d2p1:ScheduledFlow> <d2p1:FlowId>String</d2p1:FlowId> <d2p1:FlowParams xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:StateName>String</d2p1:StateName> </d2p1:ScheduledFlow> </d2p1:ScheduledFlows> <d2p1:SipCredentialSid>String</d2p1:SipCredentialSid> <d2p1:SipDomain>String</d2p1:SipDomain> <d2p1:SipPassword>String</d2p1:SipPassword> <d2p1:SipRegion>NorthAmericaVirginia</d2p1:SipRegion> <d2p1:SipUserName>String</d2p1:SipUserName> <d2p1:Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings"> <d4p1:Tag> <d4p1:Color>Magenta</d4p1:Color> <d4p1:Id>String</d4p1:Id> <d4p1:Name>String</d4p1:Name> </d4p1:Tag> </d2p1:Tags> <d2p1:TeamMemberIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:TeamMemberIds> <d2p1:ThirdPartyPhoneSystemSettings> <d2p1:DemoSettings> <d2p1:Extension>String</d2p1:Extension> </d2p1:DemoSettings> <d2p1:SipSettings> <d2p1:Accounts> <d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings> <d2p1:Agent>String</d2p1:Agent> <d2p1:AudioCodecs> <d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes>PCMU</d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes> </d2p1:AudioCodecs> <d2p1:AudioPlaybackDeviceName>String</d2p1:AudioPlaybackDeviceName> <d2p1:AudioRecordingDeviceName>String</d2p1:AudioRecordingDeviceName> <d2p1:AuthName>String</d2p1:AuthName> <d2p1:DTMFMethod>RFC2833</d2p1:DTMFMethod> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:LocalIP>String</d2p1:LocalIP> <d2p1:LocalPort>0</d2p1:LocalPort> <d2p1:Number>String</d2p1:Number> <d2p1:OutboundServer>String</d2p1:OutboundServer> <d2p1:OutboundServerPort>0</d2p1:OutboundServerPort> <d2p1:Password>String</d2p1:Password> <d2p1:RegistrationExpires>0</d2p1:RegistrationExpires> <d2p1:SipServer>String</d2p1:SipServer> <d2p1:SipServerPort>0</d2p1:SipServerPort> <d2p1:StunPort>0</d2p1:StunPort> <d2p1:StunServer>String</d2p1:StunServer> <d2p1:TransportType>UDP</d2p1:TransportType> <d2p1:UserDomain>String</d2p1:UserDomain> <d2p1:UserName>String</d2p1:UserName> </d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings> </d2p1:Accounts> </d2p1:SipSettings> <d2p1:Type>Demo</d2p1:Type> </d2p1:ThirdPartyPhoneSystemSettings> <d2p1:Type>PhoneNumber</d2p1:Type> <d2p1:UseExternal10DlcCampaign>false</d2p1:UseExternal10DlcCampaign> <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress> <d2p1:UserFirstName>String</d2p1:UserFirstName> <d2p1:UserLastName>String</d2p1:UserLastName> <d2p1:UserMode>SoftPhone</d2p1:UserMode> <d2p1:VoicemailGreetingId>String</d2p1:VoicemailGreetingId> </d2p1:EndpointInfo> </Items> <TotalCount>0</TotalCount> <TotalPages>0</TotalPages> </ListResponseOfEndpointInfoWeVlXEog>