Evo Voice

<back to all web services

GetActiveCalls

Gets all activecalls

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
GET/calls/active
"use strict";
export class CallInfo {
    /** @param {{accountSid?:string,answeredBy?:string,callerName?:string,dateCreated?:string,dateUpdated?:string,direction?:string,duration?:number,endTime?:string,forwardedFrom?:string,from?:string,fromFormatted?:string,parentCallSid?:string,phoneNumberSid?:string,price?:number,priceUnit?:string,sid?:string,startTime?:string,status?:string,to?:string,toFormatted?:string,uri?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    accountSid;
    /** @type {string} */
    answeredBy;
    /** @type {string} */
    callerName;
    /** @type {string} */
    dateCreated;
    /** @type {string} */
    dateUpdated;
    /** @type {string} */
    direction;
    /** @type {number} */
    duration;
    /** @type {string} */
    endTime;
    /** @type {string} */
    forwardedFrom;
    /** @type {string} */
    from;
    /** @type {string} */
    fromFormatted;
    /** @type {string} */
    parentCallSid;
    /** @type {string} */
    phoneNumberSid;
    /** @type {number} */
    price;
    /** @type {string} */
    priceUnit;
    /** @type {string} */
    sid;
    /** @type {string} */
    startTime;
    /** @type {string} */
    status;
    /** @type {string} */
    to;
    /** @type {string} */
    toFormatted;
    /** @type {string} */
    uri;
}
export class GetActiveCallsResponse {
    /** @param {{calls?:CallInfo[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CallInfo[]} */
    calls;
}
export class GetActiveCalls {
    /** @param {{accountId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The account ID to retrieve for */
    accountId;
}

JavaScript GetActiveCalls DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /calls/active HTTP/1.1 
Host: team.evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"calls":[{"accountSid":"String","answeredBy":"String","callerName":"String","dateCreated":"String","dateUpdated":"String","direction":"String","duration":0,"endTime":"String","forwardedFrom":"String","from":"String","fromFormatted":"String","parentCallSid":"String","phoneNumberSid":"String","price":0,"priceUnit":"String","sid":"String","startTime":"String","status":"String","to":"String","toFormatted":"String","uri":"String"}]}