Evo Voice

<back to all web services

GetCustomer

Get a specific customer

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


/**
* Get a specific customer
*/
@Api(Description="Get a specific customer")
open class GetCustomer : IGet
{
    /**
    * The ID of the customer you want to get
    */
    @ApiMember(Description="The ID of the customer you want to get")
    open var customerId:String? = null
}

open class CustomerInfo : EntityInfo()
{
    /**
    * The ID of the account associated with this customer
    */
    @ApiMember(Description="The ID of the account associated with this customer")
    open var accountId:String? = null

    /**
    * The parent customer ID for this customer
    */
    @ApiMember(Description="The parent customer ID for this customer")
    open var parentCustomerId:String? = null

    /**
    * The breadcrumb to this customer
    */
    @ApiMember(Description="The breadcrumb to this customer")
    open var breadcrumb:ArrayList<CustomerBreadcrumb>? = null

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

    /**
    * Is this customer staging or production?
    */
    @ApiMember(Description="Is this customer staging or production?")
    open var isStaging:Boolean? = null

    /**
    * The name of the company
    */
    @ApiMember(Description="The name of the company")
    open var name:String? = null

    /**
    * The reference ID for this company
    */
    @ApiMember(Description="The reference ID for this company")
    open var referenceId:String? = null

    /**
    * This customer's data values
    */
    @ApiMember(Description="This customer's data values")
    @SerializedName("data") open var Data:Struct? = null

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

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

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

    /**
    * Override this customer's billing settings? Otherwise inherits from parent
    */
    @ApiMember(Description="Override this customer's billing settings? Otherwise inherits from parent")
    open var overrideBillingSettings:Boolean? = null

    /**
    * Billing settings for this customer
    */
    @ApiMember(Description="Billing settings for this customer")
    open var billingSettings:BillingSettings? = null

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

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

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

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

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

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

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

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

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

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

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

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

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

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

enum class SimpleSchedulingRuleTypes
{
    Always,
    CustomerState,
    Time,
}

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

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

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

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

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

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

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

Kotlin GetCustomer DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /customers/{customerId} HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml

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

<CustomerInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <AccountName>String</AccountName>
  <AppSettings>
    <ChakraTheme>String</ChakraTheme>
    <CustomCss>String</CustomCss>
    <EnableAssistants>false</EnableAssistants>
    <EnableCallHistory>false</EnableCallHistory>
    <EnableDeviceManagement>false</EnableDeviceManagement>
    <EnableDialer>false</EnableDialer>
    <EnablePhoneNumberManagement>false</EnablePhoneNumberManagement>
    <LogoutUrl>String</LogoutUrl>
    <PageTitle>String</PageTitle>
    <PortMyNumberUrl>String</PortMyNumberUrl>
    <ShowFileNameInMessageCenter>false</ShowFileNameInMessageCenter>
    <StringMappings>String</StringMappings>
  </AppSettings>
  <BillingSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts">
    <d2p1:AIInsights>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:AIInsights>
    <d2p1:AILiveMinutes>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:AILiveMinutes>
    <d2p1:Base>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:Base>
    <d2p1:InboundFaxes>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:InboundFaxes>
    <d2p1:InboundSmsMessages>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:InboundSmsMessages>
    <d2p1:InboundVoiceCalls>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:InboundVoiceCalls>
    <d2p1:LocalNumbers>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:LocalNumbers>
    <d2p1:OutboundFaxes>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:OutboundFaxes>
    <d2p1:OutboundSmsMessages>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:OutboundSmsMessages>
    <d2p1:OutboundVoiceCalls>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:OutboundVoiceCalls>
    <d2p1:TollFreeNumbers>
      <d2p1:Allowance>0</d2p1:Allowance>
      <d2p1:BaseCost>0</d2p1:BaseCost>
      <d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
      <d2p1:UnitCost>0</d2p1:UnitCost>
    </d2p1:TollFreeNumbers>
  </BillingSettings>
  <Breadcrumb>
    <CustomerBreadcrumb>
      <Id>String</Id>
      <Name>String</Name>
    </CustomerBreadcrumb>
  </Breadcrumb>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <IntegrationData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
        <d4p1:ThirdPartyId>String</d4p1:ThirdPartyId>
      </d2p1:Value>
    </d2p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
  </IntegrationData>
  <IsStaging>false</IsStaging>
  <Name>String</Name>
  <OverrideAppSettings>false</OverrideAppSettings>
  <OverrideBillingSettings>false</OverrideBillingSettings>
  <ParentCustomerId>String</ParentCustomerId>
  <ReferenceId>String</ReferenceId>
  <Schedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling">
    <d2p1:DefaultState>String</d2p1:DefaultState>
    <d2p1:ForceClosed>false</d2p1:ForceClosed>
    <d2p1:Inherit>false</d2p1:Inherit>
    <d2p1:Rules>
      <d2p1:SchedulingRule>
        <d2p1:ByDay>
          <d2p1:ScheduleDay>
            <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek>
            <d2p1:Offset>0</d2p1:Offset>
          </d2p1:ScheduleDay>
        </d2p1:ByDay>
        <d2p1:ByHour xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByHour>
        <d2p1:ByMinute xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByMinute>
        <d2p1:ByMonth xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByMonth>
        <d2p1:ByMonthDay xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByMonthDay>
        <d2p1:BySetPosition xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:BySetPosition>
        <d2p1:ByWeekNo xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByWeekNo>
        <d2p1:ByYearDay xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ByYearDay>
        <d2p1:Condition>String</d2p1:Condition>
        <d2p1:Count>0</d2p1:Count>
        <d2p1:CustomerState>String</d2p1:CustomerState>
        <d2p1:EndTime>String</d2p1:EndTime>
        <d2p1:FlowId>String</d2p1:FlowId>
        <d2p1:FlowParams xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Frequency>None</d2p1:Frequency>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Interval>0</d2p1:Interval>
        <d2p1:IsAllDay>false</d2p1:IsAllDay>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Priority>0</d2p1:Priority>
        <d2p1:SimpleRuleType>Always</d2p1:SimpleRuleType>
        <d2p1:Source>String</d2p1:Source>
        <d2p1:StartDate>String</d2p1:StartDate>
        <d2p1:StartTime>String</d2p1:StartTime>
        <d2p1:State>String</d2p1:State>
        <d2p1:UntilDate>String</d2p1:UntilDate>
      </d2p1:SchedulingRule>
    </d2p1:Rules>
    <d2p1:TimeZoneId>String</d2p1:TimeZoneId>
  </Schedule>
  <Tags xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
    <d2p1:Tag>
      <d2p1:Color>Magenta</d2p1:Color>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:Tag>
  </Tags>
</CustomerInfo>