| Required role: | SystemAdministrator |
| All Verbs | /ai/usage |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | query | string | No | Filter by account ID. If not specified will return entries for all customers in all accounts in the date range |
| CustomerId | query | string | No | Filter by customer ID. If not specified, will return all customers for the accounts considered |
| StartDate | query | string | No | The start of the date range to consider |
| EndDate | query | string | No | The end of the date range to consider |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountUsage | form | List<AIAccountUsage> | No | |
| CustomerUsage | form | List<AICustomerUsage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this customer belongs to |
| AIMinutes | form | int | No | The total number of AI minutes used in the date range |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this customer belongs to |
| CustomerId | form | string | No | The customer ID for this uage |
| AIMinutes | form | int | No | The 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 .xml suffix or ?format=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>