Evo Voice

GetAIUsage

**Requires Authentication**
Required role:	SystemAdministrator

The following routes are available for this service:
All Verbs	/ai/usage

"use strict";
export class AIAccountUsage {
    /** @param {{accountId?:string,aiMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The account ID this customer belongs to */
    accountId;
    /**
     * @type {number}
     * @description The total number of AI minutes used in the date range */
    aiMinutes;
}
export class AICustomerUsage {
    /** @param {{accountId?:string,customerId?:string,aiMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The account ID this customer belongs to */
    accountId;
    /**
     * @type {string}
     * @description The customer ID for this uage */
    customerId;
    /**
     * @type {number}
     * @description The total number of AI minutes used in the date range */
    aiMinutes;
}
export class AIUsage {
    /** @param {{accountUsage?:AIAccountUsage[],customerUsage?:AICustomerUsage[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AIAccountUsage[]} */
    accountUsage;
    /** @type {AICustomerUsage[]} */
    customerUsage;
}
export class GetAIUsage {
    /** @param {{accountId?:string,customerId?:string,startDate?:string,endDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Filter by account ID. If not specified will return entries for all customers in all accounts in the date range */
    accountId;
    /**
     * @type {string}
     * @description Filter by customer ID. If not specified, will return all customers for the accounts considered */
    customerId;
    /**
     * @type {string}
     * @description The start of the date range to consider */
    startDate;
    /**
     * @type {string}
     * @description The end of the date range to consider */
    endDate;
}

JavaScript GetAIUsage 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.

POST /ai/usage HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAIUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <AccountId>String</AccountId>
  <CustomerId>String</CustomerId>
  <EndDate>String</EndDate>
  <StartDate>String</StartDate>
</GetAIUsage>

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

<AIUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <AccountUsage>
    <AIAccountUsage>
      <AIMinutes>0</AIMinutes>
      <AccountId>String</AccountId>
    </AIAccountUsage>
  </AccountUsage>
  <CustomerUsage>
    <AICustomerUsage>
      <AIMinutes>0</AIMinutes>
      <AccountId>String</AccountId>
      <CustomerId>String</CustomerId>
    </AICustomerUsage>
  </CustomerUsage>
</AIUsage>