Evo Voice

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}



export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


export class EntityInfo
{
    /** @description The ID of the object */
    // @ApiMember(Description="The ID of the object")
    public id: string;

    /** @description The date the object was created */
    // @ApiMember(Description="The date the object was created")
    public dateCreated: string;

    /** @description The date the object was last modified */
    // @ApiMember(Description="The date the object was last modified")
    public dateLastModified: string;

    /** @description The user that created this object */
    // @ApiMember(Description="The user that created this object")
    public createdBy: string;

    /** @description The user that last modified this object */
    // @ApiMember(Description="The user that last modified this object")
    public lastModifiedBy: string;

    public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}

export class CustomerBreadcrumb
{
    public id: string;
    public name: string;

    public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}

export class Value
{
    public boolValue?: boolean;
    public stringValue: string;
    public numberValue?: number;
    public listValue: Struct[];
    public structValue: Struct;

    public constructor(init?: Partial<Value>) { (Object as any).assign(this, init); }
}

export class Struct
{

    public constructor(init?: Partial<Struct>) { (Object as any).assign(this, init); }
}

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

export class Tag
{
    public id: string;
    public name: string;
    public color: TagColors;

    public constructor(init?: Partial<Tag>) { (Object as any).assign(this, init); }
}

export enum SimpleSchedulingRuleTypes
{
    Always = 'Always',
    CustomerState = 'CustomerState',
    Time = 'Time',
}

export class ScheduleDay
{
    public offset: number;
    public dayOfWeek: DayOfWeek;

    public constructor(init?: Partial<ScheduleDay>) { (Object as any).assign(this, init); }
}

export enum SchedulingRuleFrequency
{
    None = 'None',
    Secondly = 'Secondly',
    Minutely = 'Minutely',
    Hourly = 'Hourly',
    Daily = 'Daily',
    Weekly = 'Weekly',
    Monthly = 'Monthly',
    Yearly = 'Yearly',
}

export class SchedulingRule
{
    public id: string;
    public name: string;
    public priority: number;
    public state: string;
    public source: string;
    public condition: string;
    public simpleRuleType: SimpleSchedulingRuleTypes;
    public customerState: string;
    public flowId: string;
    public flowParams: Struct;
    public isAllDay: boolean;
    public startDate: string;
    public startTime: string;
    public endTime: string;
    public bySetPosition: number[];
    public byMonth: number[];
    public byWeekNo: number[];
    public byYearDay: number[];
    public byMonthDay: number[];
    public byDay: ScheduleDay[];
    public byHour: number[];
    public byMinute: number[];
    public interval: number;
    public count: number;
    public untilDate: string;
    public frequency: SchedulingRuleFrequency;

    public constructor(init?: Partial<SchedulingRule>) { (Object as any).assign(this, init); }
}

export class Schedule
{
    public timeZoneId: string;
    public inherit: boolean;
    public forceClosed: boolean;
    public rules: SchedulingRule[];
    public defaultState: string;

    public constructor(init?: Partial<Schedule>) { (Object as any).assign(this, init); }
}

export class IntegrationData
{
    public thirdPartyId: string;

    public constructor(init?: Partial<IntegrationData>) { (Object as any).assign(this, init); }
}

export class Dictionary<T> { [Key: string]: T; }

export class EntityIntegrationData extends Dictionary<IntegrationData>
{

    public constructor(init?: Partial<EntityIntegrationData>) { super(); (Object as any).assign(this, init); }
}

export class BillingItem
{
    public baseCost: number;
    public rawUnitMultiplier: number;
    public unitCost: number;
    public allowance: number;

    public constructor(init?: Partial<BillingItem>) { (Object as any).assign(this, init); }
}

export class BillingSettings
{
    public base: BillingItem;
    public localNumbers: BillingItem;
    public tollFreeNumbers: BillingItem;
    public inboundVoiceCalls: BillingItem;
    public outboundVoiceCalls: BillingItem;
    public inboundFaxes: BillingItem;
    public outboundFaxes: BillingItem;
    public inboundSmsMessages: BillingItem;
    public outboundSmsMessages: BillingItem;
    public aiInsights: BillingItem;
    public aiLiveMinutes: BillingItem;

    public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}

export class AppSettings
{
    public enablePhoneNumberManagement: boolean;
    public enableDeviceManagement: boolean;
    public enableDialer: boolean;
    public enableCallHistory: boolean;
    public enableAssistants: boolean;
    public showFileNameInMessageCenter: boolean;
    public chakraTheme: string;
    public customCss: string;
    public pageTitle: string;
    public stringMappings: string;
    public logoutUrl: string;
    public portMyNumberUrl: string;

    public constructor(init?: Partial<AppSettings>) { (Object as any).assign(this, init); }
}

export class CustomerInfo extends EntityInfo
{
    /** @description The ID of the account associated with this customer */
    // @ApiMember(Description="The ID of the account associated with this customer")
    public accountId: string;

    /** @description The parent customer ID for this customer */
    // @ApiMember(Description="The parent customer ID for this customer")
    public parentCustomerId: string;

    /** @description The breadcrumb to this customer */
    // @ApiMember(Description="The breadcrumb to this customer")
    public breadcrumb: CustomerBreadcrumb[];

    /** @description The name of the account associated with this customer */
    // @ApiMember(Description="The name of the account associated with this customer")
    public accountName: string;

    /** @description Is this customer staging or production? */
    // @ApiMember(Description="Is this customer staging or production?")
    public isStaging: boolean;

    /** @description The name of the company */
    // @ApiMember(Description="The name of the company")
    public name: string;

    /** @description The reference ID for this company */
    // @ApiMember(Description="The reference ID for this company")
    public referenceId: string;

    /** @description This customer's data values */
    // @ApiMember(Description="This customer's data values")
    public data: Struct;

    /** @description The list of tags for this customer */
    // @ApiMember(Description="The list of tags for this customer")
    public tags: Tag[];

    /** @description This customer's schedule */
    // @ApiMember(Description="This customer's schedule")
    public schedule: Schedule;

    /** @description Integration data for this customer */
    // @ApiMember(Description="Integration data for this customer")
    public integrationData: EntityIntegrationData;

    /** @description Override this customer's billing settings? Otherwise inherits from parent */
    // @ApiMember(Description="Override this customer's billing settings? Otherwise inherits from parent")
    public overrideBillingSettings: boolean;

    /** @description Billing settings for this customer */
    // @ApiMember(Description="Billing settings for this customer")
    public billingSettings: BillingSettings;

    /** @description Should this customer override the parent customer's app settings */
    // @ApiMember(Description="Should this customer override the parent customer's app settings")
    public overrideAppSettings: boolean;

    /** @description App / Portal settings for this customer */
    // @ApiMember(Description="App / Portal settings for this customer")
    public appSettings: AppSettings;

    public constructor(init?: Partial<CustomerInfo>) { super(init); (Object as any).assign(this, init); }
}

/** @description Get a specific customer */
// @Api(Description="Get a specific customer")
export class GetCustomer implements IGet
{
    /** @description The ID of the customer you want to get */
    // @ApiMember(Description="The ID of the customer you want to get")
    public customerId: string;

    public constructor(init?: Partial<GetCustomer>) { (Object as any).assign(this, init); }
}

TypeScript 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>