Evo Voice

<back to all web services

ListEndpoints

Lists all endpoints

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/endpoints
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Lists all endpoints
*/
@Api(Description="Lists all endpoints")
open class ListEndpoints : ListRequest<EndpointInfo>()
{
    /**
    * The IDs of the account whose endpoints you want to retrieve
    */
    @ApiMember(Description="The IDs of the account whose endpoints you want to retrieve")
    var accountIds:ArrayList<String> = ArrayList<String>()

    /**
    * The IDs of the customers whose endpoints you want to retrieve
    */
    @ApiMember(Description="The IDs of the customers whose endpoints you want to retrieve")
    var customerIds:ArrayList<String> = ArrayList<String>()

    /**
    * The third party IDs of endpoints you want to retrieve
    */
    @ApiMember(Description="The third party IDs of endpoints you want to retrieve")
    var referenceIds:ArrayList<String> = ArrayList<String>()

    /**
    * If you want a shall parent customer filter (e.g. no deep children)
    */
    @ApiMember(Description="If you want a shall parent customer filter (e.g. no deep children)")
    var shallowParent:Boolean? = null

    /**
    * The IDs of the flows whose endpoints you want to retrieve
    */
    @ApiMember(Description="The IDs of the flows whose endpoints you want to retrieve")
    var flowIds:ArrayList<String> = ArrayList<String>()

    /**
    * The state where the specified flow IDs should be
    */
    @ApiMember(Description="The state where the specified flow IDs should be")
    var flowState:String? = null

    /**
    * The list of tag IDs to filter by (must contain all)
    */
    @ApiMember(Description="The list of tag IDs to filter by (must contain all)")
    var tagIds:ArrayList<String> = ArrayList<String>()

    /**
    * Filter by name
    */
    @ApiMember(Description="Filter by name")
    var nameFilter:String? = null

    /**
    * Filter by phone number
    */
    @ApiMember(Description="Filter by phone number")
    var phoneNumberFilter:String? = null

    /**
    * Filter by type
    */
    @ApiMember(Description="Filter by type")
    @SerializedName("type") var Type:EndpointTypes? = null

    /**
    * Filter by types
    */
    @ApiMember(Description="Filter by types")
    var types:ArrayList<EndpointTypes> = ArrayList<EndpointTypes>()

    /**
    * Filter by user mode
    */
    @ApiMember(Description="Filter by user mode")
    var userMode:UserModes? = null

    /**
    * Filters for any endpoint data fields. Format for each entry should be 'FieldName=Value'. We do not support numeric or boolean currently
    */
    @ApiMember(Description="Filters for any endpoint data fields. Format for each entry should be 'FieldName=Value'. We do not support numeric or boolean currently")
    var dataFilters:ArrayList<String> = ArrayList<String>()

    /**
    * Filter by SIP user name
    */
    @ApiMember(Description="Filter by SIP user name")
    var sipUserName:String? = null

    /**
    * Filter by flow parameters (this must be a JSON struct)
    */
    @ApiMember(Description="Filter by flow parameters (this must be a JSON struct)")
    var flowParametersFilter:String? = null
}

open class ListRequest<T> : IGet
{
    /**
    * The page of data to retrieve
    */
    @ApiMember(Description="The page of data to retrieve")
    var page:Int? = null

    /**
    * If you want all objects to be returned. This should be used with care
    */
    @ApiMember(Description="If you want all objects to be returned. This should be used with care")
    var all:Boolean? = null

    /**
    * The number per page to retrieve
    */
    @ApiMember(Description="The number per page to retrieve")
    var countPerPage:Int? = null

    /**
    * Specific IDs
    */
    @ApiMember(Description="Specific IDs")
    var specificIds:ArrayList<String> = ArrayList<String>()

    /**
    * Specify a sort field
    */
    @ApiMember(Description="Specify a sort field")
    var sortField:String? = null

    /**
    * Specify a sort order
    */
    @ApiMember(Description="Specify a sort order")
    var sortOrder:SortOrders? = null

    /**
    * Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
    */
    @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
    var simplifiedPaging:Boolean? = null
}

enum class SortOrders
{
    Ascend,
    Descend,
}

open class EndpointInfo : EntityInfo()
{
    /**
    * The account ID this endpoint is associated with
    */
    @ApiMember(Description="The account ID this endpoint is associated with")
    var accountId:String? = null

    /**
    * The name of the account this endpoint is associated with
    */
    @ApiMember(Description="The name of the account this endpoint is associated with")
    var accountName:String? = null

    /**
    * The ID of the customer this endpoint is associated with
    */
    @ApiMember(Description="The ID of the customer this endpoint is associated with")
    var customerId:String? = null

    /**
    * The name of the customer this endpoint is associated with
    */
    @ApiMember(Description="The name of the customer this endpoint is associated with")
    var customerName:String? = null

    /**
    * The third party reference ID for the endpoint
    */
    @ApiMember(Description="The third party reference ID for the endpoint")
    var referenceId:String? = null

    /**
    * The breadcrumb to the customer for this endpoint
    */
    @ApiMember(Description="The breadcrumb to the customer for this endpoint")
    var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()

    /**
    * The display name of the endpoint
    */
    @ApiMember(Description="The display name of the endpoint")
    var displayName:String? = null

    /**
    * The type of endpoint
    */
    @ApiMember(Description="The type of endpoint")
    @SerializedName("type") var Type:EndpointTypes? = null

    /**
    * Extra info for this endpoint (typically to show in grid)
    */
    @ApiMember(Description="Extra info for this endpoint (typically to show in grid)")
    var extraInformation:String? = null

    /**
    * The ID of the flow to use for voice
    */
    @ApiMember(Description="The ID of the flow to use for voice")
    var flowId:String? = null

    /**
    * The name of the flow to use for voice
    */
    @ApiMember(Description="The name of the flow to use for voice")
    var flowName:String? = null

    /**
    * The params for the voice flow
    */
    @ApiMember(Description="The params for the voice flow")
    var flowParams:Struct? = null

    /**
    * Whether to use a single flow always or use scheduled flow system
    */
    @ApiMember(Description="Whether to use a single flow always or use scheduled flow system")
    var flowSchedule:EndpointFlowSchedules? = null

    /**
    * This endpoint's schedule
    */
    @ApiMember(Description="This endpoint's schedule")
    var schedule:Schedule? = null

    /**
    * The list of scheduled flows when using scheduling
    */
    @ApiMember(Description="The list of scheduled flows when using scheduling")
    var scheduledFlows:ArrayList<ScheduledFlow> = ArrayList<ScheduledFlow>()

    /**
    * Disable SMS
    */
    @ApiMember(Description="Disable SMS")
    var disableSms:Boolean? = null

    /**
    * Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
    */
    @ApiMember(Description="Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number")
    var useExternal10DlcCampaign:Boolean? = null

    /**
    * Is this a virtual phone number?
    */
    @ApiMember(Description="Is this a virtual phone number?")
    var isVirtualPhoneNumber:Boolean? = null

    /**
    * Is caller ID verified for this virtual number?
    */
    @ApiMember(Description="Is caller ID verified for this virtual number?")
    var isCallerIdVerified:Boolean? = null

    /**
    * The verification code for this number
    */
    @ApiMember(Description="The verification code for this number")
    var callerIdVerificationCode:String? = null

    /**
    * The phone number
    */
    @ApiMember(Description="The phone number")
    var phoneNumber:String? = null

    /**
    * The Sid of the phone number
    */
    @ApiMember(Description="The Sid of the phone number")
    var phoneNumberSid:String? = null

    /**
    * The caller ID Name (CNAM) for the phone number
    */
    @ApiMember(Description="The caller ID Name (CNAM) for the phone number")
    var callerIdName:String? = null

    /**
    * The address SID associated with the phone number
    */
    @ApiMember(Description="The address SID associated with the phone number")
    var addressSid:String? = null

    /**
    * Do not touch this phone number - for BYOA accounts
    */
    @ApiMember(Description="Do not touch this phone number - for BYOA accounts")
    var doNotTouchPhoneNumber:Boolean? = null

    /**
    * Is this number enrolled in a 10DLC messaging service campaign
    */
    @ApiMember(Description="Is this number enrolled in a 10DLC messaging service campaign")
    var isEnrolledIn10DlcService:Boolean? = null

    /**
    * Whether we look up caller ID or not
    */
    @ApiMember(Description="Whether we look up caller ID or not")
    var enableCallerIdLookup:Boolean? = null

    /**
    * The email address of the user
    */
    @ApiMember(Description="The email address of the user")
    var userEmailAddress:String? = null

    /**
    * The Twilio Region for the SIP endpoint
    */
    @ApiMember(Description="The Twilio Region for the SIP endpoint")
    var sipRegion:TwilioSipRegions? = null

    /**
    * The Twilio Sid of the credentials for Sip
    */
    @ApiMember(Description="The Twilio Sid of the credentials for Sip")
    var sipCredentialSid:String? = null

    /**
    * The Twilio SIP user name
    */
    @ApiMember(Description="The Twilio SIP user name")
    var sipUserName:String? = null

    /**
    * The Twilio SIP password
    */
    @ApiMember(Description="The Twilio SIP password")
    var sipPassword:String? = null

    /**
    * The SIP domain
    */
    @ApiMember(Description="The SIP domain")
    var sipDomain:String? = null

    /**
    * Is emergency calling enabled on this number?
    */
    @ApiMember(Description="Is emergency calling enabled on this number?")
    var enableEmergencyCalling:Boolean? = null

    /**
    * The SID of the emergency address for this number
    */
    @ApiMember(Description="The SID of the emergency address for this number")
    var emergencyAddressSid:String? = null

    /**
    * The ID of the phone number to use for emergency dialing
    */
    @ApiMember(Description="The ID of the phone number to use for emergency dialing")
    var emergencyPhoneNumberId:String? = null

    /**
    * The current agent state of this user endpoint
    */
    @ApiMember(Description="The current agent state of this user endpoint")
    var agentState:AgentStates? = null

    /**
    * The current agent state reason of this user endpoint
    */
    @ApiMember(Description="The current agent state reason of this user endpoint")
    var agentStateReason:AgentStateReasons? = null

    /**
    * The mode for this user
    */
    @ApiMember(Description="The mode for this user")
    var userMode:UserModes? = null

    /**
    * The ID of the file to use for voicemail greeting
    */
    @ApiMember(Description="The ID of the file to use for voicemail greeting")
    var voicemailGreetingId:String? = null

    /**
    * The endpoint's data
    */
    @ApiMember(Description="The endpoint's data")
    @SerializedName("data") var Data:Struct? = null

    /**
    * The email address for email endpoints
    */
    @ApiMember(Description="The email address for email endpoints")
    var emailAddress:String? = null

    /**
    * The first name of the user (for user endpoints)
    */
    @ApiMember(Description="The first name of the user (for user endpoints)")
    var userFirstName:String? = null

    /**
    * The last name of the user (for user endpoints)
    */
    @ApiMember(Description="The last name of the user (for user endpoints)")
    var userLastName:String? = null

    /**
    * The URL of an image for this user's avatar
    */
    @ApiMember(Description="The URL of an image for this user's avatar")
    var avatarUrl:String? = null

    /**
    * Does this user have manager role?
    */
    @ApiMember(Description="Does this user have manager role?")
    var managerRole:UserManagerRoles? = null

    /**
    * The list of dashboard permissions for when the manager role is custom
    */
    @ApiMember(Description="The list of dashboard permissions for when the manager role is custom")
    var dashboardPermissions:ArrayList<DashboardPermissions> = ArrayList<DashboardPermissions>()

    /**
    * The type of visibility this user has to their own fields
    */
    @ApiMember(Description="The type of visibility this user has to their own fields")
    var myFieldPermissions:UserDataFieldModes? = null

    /**
    * The type of visibility this user has to customer fields
    */
    @ApiMember(Description="The type of visibility this user has to customer fields")
    var customerFieldPermissions:UserDataFieldModes? = null

    /**
    * The type of visibility this user has to other user fields
    */
    @ApiMember(Description="The type of visibility this user has to other user fields")
    var otherUserFieldPermissions:UserDataFieldModes? = null

    /**
    * The type of visibility this user has to other endpoint fields
    */
    @ApiMember(Description="The type of visibility this user has to other endpoint fields")
    var otherEndpointFieldPermissions:UserDataFieldModes? = null

    /**
    * The name of this endpoint (for bots etc.)
    */
    @ApiMember(Description="The name of this endpoint (for bots etc.)")
    var name:String? = null

    /**
    * The list of tags for this endpoint
    */
    @ApiMember(Description="The list of tags for this endpoint")
    var tags:ArrayList<Tag> = ArrayList<Tag>()

    /**
    * The list of action URLs
    */
    @ApiMember(Description="The list of action URLs")
    var actionUrls:ArrayList<EndpointActionUrl> = ArrayList<EndpointActionUrl>()

    /**
    * The list of members in this team
    */
    @ApiMember(Description="The list of members in this team")
    var teamMemberIds:ArrayList<String> = ArrayList<String>()

    /**
    * Visibility of this user/team in contact lists
    */
    @ApiMember(Description="Visibility of this user/team in contact lists")
    var contactListVisibility:CustomerVisibility? = null

    /**
    * The list of contacts personal to this user
    */
    @ApiMember(Description="The list of contacts personal to this user")
    var contacts:ArrayList<EndpointContact> = ArrayList<EndpointContact>()

    /**
    * The documo ID for this number
    */
    @ApiMember(Description="The documo ID for this number")
    var documoId:String? = null

    /**
    * Integration data for this endpoint
    */
    @ApiMember(Description="Integration data for this endpoint")
    var integrationData:EntityIntegrationData? = null

    /**
    * Settings for third party phone system
    */
    @ApiMember(Description="Settings for third party phone system")
    var thirdPartyPhoneSystemSettings:ThirdPartyPhoneSystemSettings? = null

    /**
    * Should this user override the parent customer's app settings
    */
    @ApiMember(Description="Should this user override the parent customer's app settings")
    var overrideAppSettings:Boolean? = null

    /**
    * App / Portal settings for this user
    */
    @ApiMember(Description="App / Portal settings for this user")
    var appSettings:AppSettings? = null
}

open class EntityInfo
{
    /**
    * The ID of the object
    */
    @ApiMember(Description="The ID of the object")
    var id:String? = null

    /**
    * The date the object was created
    */
    @ApiMember(Description="The date the object was created")
    var dateCreated:String? = null

    /**
    * The date the object was last modified
    */
    @ApiMember(Description="The date the object was last modified")
    var dateLastModified:String? = null

    /**
    * The user that created this object
    */
    @ApiMember(Description="The user that created this object")
    var createdBy:String? = null

    /**
    * The user that last modified this object
    */
    @ApiMember(Description="The user that last modified this object")
    var lastModifiedBy:String? = null
}

open class CustomerBreadcrumb
{
    var id:String? = null
    var name:String? = null
}

enum class EndpointTypes
{
    PhoneNumber,
    User,
    FaxNumber,
    EmailAddress,
    Unused1,
    Unused2,
    Unused3,
    Unused4,
    Unused5,
    Team,
}

open class Struct : HashMap<String,Value>()
{
}

open class Value
{
    var boolValue:Boolean? = null
    var stringValue:String? = null
    var numberValue:Double? = null
    var listValue:ArrayList<Struct> = ArrayList<Struct>()
    var structValue:Struct? = null
}

enum class EndpointFlowSchedules
{
    Always,
    Scheduled,
    Simple,
}

open class Schedule
{
    var timeZoneId:String? = null
    var inherit:Boolean? = null
    var forceClosed:Boolean? = null
    var rules:ArrayList<SchedulingRule> = ArrayList<SchedulingRule>()
    var defaultState:String? = null
}

open class SchedulingRule
{
    var id:String? = null
    var name:String? = null
    var priority:Int? = null
    var state:String? = null
    var source:String? = null
    var condition:String? = null
    var simpleRuleType:SimpleSchedulingRuleTypes? = null
    var customerState:String? = null
    var flowId:String? = null
    var flowParams:Struct? = null
    var isAllDay:Boolean? = null
    var startDate:String? = null
    var startTime:String? = null
    var endTime:String? = null
    var bySetPosition:ArrayList<Int> = ArrayList<Int>()
    var byMonth:ArrayList<Int> = ArrayList<Int>()
    var byWeekNo:ArrayList<Int> = ArrayList<Int>()
    var byYearDay:ArrayList<Int> = ArrayList<Int>()
    var byMonthDay:ArrayList<Int> = ArrayList<Int>()
    var byDay:ArrayList<ScheduleDay> = ArrayList<ScheduleDay>()
    var byHour:ArrayList<Int> = ArrayList<Int>()
    var byMinute:ArrayList<Int> = ArrayList<Int>()
    var interval:Int? = null
    var count:Int? = null
    var untilDate:String? = null
    var frequency:SchedulingRuleFrequency? = null
}

enum class SimpleSchedulingRuleTypes
{
    Always,
    CustomerState,
    Time,
}

open class ScheduleDay
{
    var offset:Int? = null
    var dayOfWeek:DayOfWeek? = null
}

enum class SchedulingRuleFrequency
{
    None,
    Secondly,
    Minutely,
    Hourly,
    Daily,
    Weekly,
    Monthly,
    Yearly,
}

open class ScheduledFlow
{
    var stateName:String? = null
    var flowId:String? = null
    var flowParams:Struct? = null
}

enum class TwilioSipRegions
{
    NorthAmericaVirginia,
    NorthAmericaOregon,
    EuropeIreland,
    EuropeFrankfurt,
    AsiaPacificSingapore,
    AsiaPacificTokyo,
    AsiaPacificSydney,
    SouthAmericaSanPaolo,
}

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

enum class AgentStateReasons
{
    Unknown,
    SetByUser,
    MissedCall,
    SetBySystem,
}

enum class UserModes
{
    SoftPhone,
    Sip,
    Flow,
    DataOnly,
    ThirdParty,
}

enum class UserManagerRoles
{
    None,
    Manager,
    VoicemailAndCallHistory,
    Custom,
}

enum class DashboardPermissions
{
    ViewFiles,
    ViewNotifications,
    ViewSessions,
    ViewEndpoints,
    ViewReports,
    ViewCustomers,
    ViewFlows,
}

enum class UserDataFieldModes
{
    Hidden,
    ReadOnly,
    ReadWrite,
}

open class Tag
{
    var id:String? = null
    var name:String? = null
    var color:TagColors? = null
}

enum class TagColors
{
    Magenta,
    Red,
    Volcano,
    Orange,
    Gold,
    Lime,
    Green,
    Cyan,
    Blue,
    GeekBlue,
    Purple,
}

open class EndpointActionUrl
{
    var id:String? = null
    var url:String? = null
    var method:ActionUrlHttpMethods? = null
}

enum class ActionUrlHttpMethods
{
    Get,
    Post,
}

enum class CustomerVisibility
{
    None,
    CurrentCustomer,
    CurrentAndChildCustomers,
}

open class EndpointContact
{
    var id:String? = null
    var displayName:String? = null
    var address:String? = null
}

open class EntityIntegrationData : HashMap<String,IntegrationData>()
{
}

open class IntegrationData
{
    var thirdPartyId:String? = null
}

open class ThirdPartyPhoneSystemSettings
{
    @SerializedName("type") var Type:ThirdPartyPhoneSystemTypes? = null
    var sipSettings:ThirdPartySipSettings? = null
    var demoSettings:ThirdPartyDemoSettings? = null
}

enum class ThirdPartyPhoneSystemTypes
{
    Demo,
    Sip,
}

open class ThirdPartySipSettings
{
    var accounts:ArrayList<ThirdPartySipAccountSettings> = ArrayList<ThirdPartySipAccountSettings>()
}

open class ThirdPartySipAccountSettings
{
    var number:String? = null
    var agent:String? = null
    var authName:String? = null
    var userName:String? = null
    var displayName:String? = null
    var password:String? = null
    var userDomain:String? = null
    var registrationExpires:Int? = null
    var transportType:TransportTypes? = null
    var localIP:String? = null
    var localPort:Int? = null
    var sipServer:String? = null
    var sipServerPort:Int? = null
    var outboundServer:String? = null
    var outboundServerPort:Int? = null
    var stunServer:String? = null
    var stunPort:Int? = null
    var audioPlaybackDeviceName:String? = null
    var audioRecordingDeviceName:String? = null
    var audioCodecs:ArrayList<AudioCodecTypes> = ArrayList<AudioCodecTypes>()
    var dtmfMethod:DtmfMethods? = null
}

enum class TransportTypes
{
    Udp,
    Tls,
    Tcp,
    Pers,
}

enum class AudioCodecTypes(val value:Int)
{
    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),
}

enum class DtmfMethods
{
    RfC2833,
    Info,
}

open class ThirdPartyDemoSettings
{
    var extension:String? = null
}

open class AppSettings
{
    var enablePhoneNumberManagement:Boolean? = null
    var enableDeviceManagement:Boolean? = null
    var enableDialer:Boolean? = null
    var enableCallHistory:Boolean? = null
    var showFileNameInMessageCenter:Boolean? = null
    var chakraTheme:String? = null
    var customCss:String? = null
    var pageTitle:String? = null
    var stringMappings:String? = null
    var logoutUrl:String? = null
    var portMyNumberUrl:String? = null
}

open class ListResponse<AccountInfo>
{
    /**
    * The items
    */
    @ApiMember(Description="The items")
    var items:ArrayList<AccountInfo> = ArrayList<AccountInfo>()

    /**
    * The total number of items
    */
    @ApiMember(Description="The total number of items")
    var totalCount:Int? = null

    /**
    * The total number of pages
    */
    @ApiMember(Description="The total number of pages")
    var totalPages:Int? = null

    /**
    * Are there more pages of items? Used with simplified paging
    */
    @ApiMember(Description="Are there more pages of items? Used with simplified paging")
    var hasMorePages:Boolean? = null
}

open class AccountInfo : EntityInfo()
{
    /**
    * The name of this account
    */
    @ApiMember(Description="The name of this account")
    var name:String? = null

    /**
    * The ID of this account's parent
    */
    @ApiMember(Description="The ID of this account's parent")
    var parentAccountId:String? = null

    /**
    * The twilio account SID
    */
    @ApiMember(Description="The twilio account SID")
    var twilioAccountSid:String? = null

    /**
    * The ancestors of this account. Useful for breadcrumbs
    */
    @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
    var ancestorIds:ArrayList<String> = ArrayList<String>()

    /**
    * The max number of phone numbers this account can have
    */
    @ApiMember(Description="The max number of phone numbers this account can have")
    var maxPhoneNumbers:Int? = null

    /**
    * This account is BYOA
    */
    @ApiMember(Description="This account is BYOA")
    var isBYOA:Boolean? = null

    /**
    * TrustHub Profile Sid
    */
    @ApiMember(Description="TrustHub Profile Sid")
    var trustHubProfileSid:String? = null

    /**
    * The ID of the logo file
    */
    @ApiMember(Description="The ID of the logo file")
    var logoId:String? = null

    /**
    * The URI of the logo file
    */
    @ApiMember(Description="The URI of the logo file")
    var logoUri:String? = null

    /**
    * The billing settings for this account
    */
    @ApiMember(Description="The billing settings for this account")
    var billingSettings:BillingSettings? = null
}

open class BillingSettings
{
    var base:BillingItem? = null
    var localNumbers:BillingItem? = null
    var tollFreeNumbers:BillingItem? = null
    var inboundVoiceCalls:BillingItem? = null
    var outboundVoiceCalls:BillingItem? = null
    var inboundFaxes:BillingItem? = null
    var outboundFaxes:BillingItem? = null
    var inboundSmsMessages:BillingItem? = null
    var outboundSmsMessages:BillingItem? = null
}

open class BillingItem
{
    var baseCost:Double? = null
    var rawUnitMultiplier:Double? = null
    var unitCost:Double? = null
    var allowance:Int? = null
}

Kotlin ListEndpoints DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /endpoints HTTP/1.1 
Host: evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","referenceId":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"displayName":"String","type":"PhoneNumber","extraInformation":"String","flowId":"String","flowName":"String","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"flowSchedule":"Always","schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"scheduledFlows":[{"stateName":"String","flowId":"String","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}}}],"disableSms":false,"useExternal10DlcCampaign":false,"isVirtualPhoneNumber":false,"isCallerIdVerified":false,"callerIdVerificationCode":"String","phoneNumber":"String","phoneNumberSid":"String","callerIdName":"String","addressSid":"String","doNotTouchPhoneNumber":false,"isEnrolledIn10DlcService":false,"enableCallerIdLookup":false,"userEmailAddress":"String","sipRegion":"NorthAmericaVirginia","sipCredentialSid":"String","sipUserName":"String","sipPassword":"String","sipDomain":"String","enableEmergencyCalling":false,"emergencyAddressSid":"String","emergencyPhoneNumberId":"String","agentState":"Unknown","agentStateReason":"Unknown","userMode":"SoftPhone","voicemailGreetingId":"String","data":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"emailAddress":"String","userFirstName":"String","userLastName":"String","avatarUrl":"String","managerRole":"None","dashboardPermissions":["ViewFiles"],"myFieldPermissions":"Hidden","customerFieldPermissions":"Hidden","otherUserFieldPermissions":"Hidden","otherEndpointFieldPermissions":"Hidden","name":"String","tags":[{"id":"String","name":"String","color":"Magenta"}],"actionUrls":[{"id":"String","url":"String","method":"GET"}],"teamMemberIds":["String"],"contactListVisibility":"None","contacts":[{"id":"String","displayName":"String","address":"String"}],"documoId":"String","integrationData":{"String":{"thirdPartyId":"String"}},"thirdPartyPhoneSystemSettings":{"type":"Demo","sipSettings":{"accounts":[{"number":"String","agent":"String","authName":"String","userName":"String","displayName":"String","password":"String","userDomain":"String","registrationExpires":0,"transportType":"UDP","localIP":"String","localPort":0,"sipServer":"String","sipServerPort":0,"outboundServer":"String","outboundServerPort":0,"stunServer":"String","stunPort":0,"audioPlaybackDeviceName":"String","audioRecordingDeviceName":"String","audioCodecs":["PCMU"],"dtmfMethod":"RFC2833"}]},"demoSettings":{"extension":"String"}},"overrideAppSettings":false,"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}