Evo Voice

<back to all web services

GetAIUsage

Requires Authentication
Required role:SystemAdministrator
The following routes are available for this service:
All Verbs/ai/usage
GetAIUsage Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNoFilter by account ID. If not specified will return entries for all customers in all accounts in the date range
CustomerIdquerystringNoFilter by customer ID. If not specified, will return all customers for the accounts considered
StartDatequerystringNoThe start of the date range to consider
EndDatequerystringNoThe end of the date range to consider
AIUsage Parameters:
NameParameterData TypeRequiredDescription
AccountUsageformList<AIAccountUsage>No
CustomerUsageformList<AICustomerUsage>No
AIAccountUsage Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe account ID this customer belongs to
AIMinutesformintNoThe total number of AI minutes used in the date range
AICustomerUsage Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe account ID this customer belongs to
CustomerIdformstringNoThe customer ID for this uage
AIMinutesformintNoThe total number of AI minutes used in the date range

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accountId: String,
	customerId: String,
	startDate: String,
	endDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	accountUsage: 
	[
		{
			accountId: String,
			aiMinutes: 0
		}
	],
	customerUsage: 
	[
		{
			accountId: String,
			customerId: String,
			aiMinutes: 0
		}
	]
}