Evo Voice

GetAIUsage

**Requires Authentication**
Required role:	SystemAdministrator

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetAIUsage : IGet
{
    /**
    * Filter by account ID. If not specified will return entries for all customers in all accounts in the date range
    */
    @ApiMember(Description="Filter by account ID. If not specified will return entries for all customers in all accounts in the date range")
    open var accountId:String? = null

    /**
    * Filter by customer ID. If not specified, will return all customers for the accounts considered
    */
    @ApiMember(Description="Filter by customer ID. If not specified, will return all customers for the accounts considered")
    open var customerId:String? = null

    /**
    * The start of the date range to consider
    */
    @ApiMember(Description="The start of the date range to consider")
    open var startDate:String? = null

    /**
    * The end of the date range to consider
    */
    @ApiMember(Description="The end of the date range to consider")
    open var endDate:String? = null
}

open class AIUsage
{
    open var accountUsage:ArrayList<AIAccountUsage>? = null
    open var customerUsage:ArrayList<AICustomerUsage>? = null
}

open class AIAccountUsage
{
    /**
    * The account ID this customer belongs to
    */
    @ApiMember(Description="The account ID this customer belongs to")
    open var accountId:String? = null

    /**
    * The total number of AI minutes used in the date range
    */
    @ApiMember(Description="The total number of AI minutes used in the date range")
    open var aiMinutes:Int? = null
}

open class AICustomerUsage
{
    /**
    * The account ID this customer belongs to
    */
    @ApiMember(Description="The account ID this customer belongs to")
    open var accountId:String? = null

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

    /**
    * The total number of AI minutes used in the date range
    */
    @ApiMember(Description="The total number of AI minutes used in the date range")
    open var aiMinutes:Int? = null
}

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