Evo Voice

<back to all web services

GetDashboardHome

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, CallCenterDashboard
The following routes are available for this service:
All Verbs/dashboard/home
"use strict";
export class DashboardCustomerSpend {
    /** @param {{customerId?:string,customerName?:string,callSpend?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    customerId;
    /** @type {string} */
    customerName;
    /** @type {number} */
    callSpend;
}
export class DashboardHomeData {
    /** @param {{customerSpends?:DashboardCustomerSpend[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DashboardCustomerSpend[]} */
    customerSpends;
}
export class GetDashboardHome {
    /** @param {{accountId?:string,startDate?:string,endDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    accountId;
    /** @type {string} */
    startDate;
    /** @type {string} */
    endDate;
}

JavaScript GetDashboardHome 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 /dashboard/home HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDashboardHome xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard">
  <AccountId>String</AccountId>
  <EndDate>String</EndDate>
  <StartDate>String</StartDate>
</GetDashboardHome>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardHomeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard">
  <CustomerSpends>
    <DashboardCustomerSpend>
      <CallSpend>0</CallSpend>
      <CustomerId>String</CustomerId>
      <CustomerName>String</CustomerName>
    </DashboardCustomerSpend>
  </CustomerSpends>
</DashboardHomeData>