Evo Voice

<back to all web services

AppGetActiveSessions

Requires Authentication
The following routes are available for this service:
GET/portal/active-sessions
"use strict";
export class EntityInfo {
    /** @param {{id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the object */
    id;
    /**
     * @type {string}
     * @description The date the object was created */
    dateCreated;
    /**
     * @type {string}
     * @description The date the object was last modified */
    dateLastModified;
    /**
     * @type {string}
     * @description The user that created this object */
    createdBy;
    /**
     * @type {string}
     * @description The user that last modified this object */
    lastModifiedBy;
}
/** @typedef {'None'|'Active'} */
export var SessionDialState;
(function (SessionDialState) {
    SessionDialState["None"] = "None"
    SessionDialState["Active"] = "Active"
})(SessionDialState || (SessionDialState = {}));
/** @typedef {'Disconnected'|'Ringing'|'Connected'|'Hold'|'Passive'} */
export var SessionCallState;
(function (SessionCallState) {
    SessionCallState["Disconnected"] = "Disconnected"
    SessionCallState["Ringing"] = "Ringing"
    SessionCallState["Connected"] = "Connected"
    SessionCallState["Hold"] = "Hold"
    SessionCallState["Passive"] = "Passive"
})(SessionCallState || (SessionCallState = {}));
/** @typedef {'None'|'Queued'|'Ringing'|'Connected'|'Hold'|'Disconnected'} */
export var SessionQueueStates;
(function (SessionQueueStates) {
    SessionQueueStates["None"] = "None"
    SessionQueueStates["Queued"] = "Queued"
    SessionQueueStates["Ringing"] = "Ringing"
    SessionQueueStates["Connected"] = "Connected"
    SessionQueueStates["Hold"] = "Hold"
    SessionQueueStates["Disconnected"] = "Disconnected"
})(SessionQueueStates || (SessionQueueStates = {}));
export class CustomerBreadcrumb {
    /** @param {{id?:string,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
}
/** @typedef {'Voice'|'Chat'|'Fax'} */
export var FlowChannels;
(function (FlowChannels) {
    FlowChannels["Voice"] = "Voice"
    FlowChannels["Chat"] = "Chat"
    FlowChannels["Fax"] = "Fax"
})(FlowChannels || (FlowChannels = {}));
/** @typedef {'None'|'Transferring'} */
export var SessionHoldReasons;
(function (SessionHoldReasons) {
    SessionHoldReasons["None"] = "None"
    SessionHoldReasons["Transferring"] = "Transferring"
})(SessionHoldReasons || (SessionHoldReasons = {}));
export class SessionLogInfo {
    /** @param {{date?:string,message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    date;
    /** @type {string} */
    message;
}
/** @typedef {'None'|'Ringing'|'Connected'|'Hold'} */
export var SessionMemberCallState;
(function (SessionMemberCallState) {
    SessionMemberCallState["None"] = "None"
    SessionMemberCallState["Ringing"] = "Ringing"
    SessionMemberCallState["Connected"] = "Connected"
    SessionMemberCallState["Hold"] = "Hold"
})(SessionMemberCallState || (SessionMemberCallState = {}));
/** @typedef {'None'|'Caller'|'Agent'|'Transfer'} */
export var SessionMemberRoles;
(function (SessionMemberRoles) {
    SessionMemberRoles["None"] = "None"
    SessionMemberRoles["Caller"] = "Caller"
    SessionMemberRoles["Agent"] = "Agent"
    SessionMemberRoles["Transfer"] = "Transfer"
})(SessionMemberRoles || (SessionMemberRoles = {}));
export class SessionMemberInfo {
    /** @param {{identity?:string,endpointId?:string,displayName?:string,isOriginalMember?:boolean,avatarUrl?:string,applicationData?:{ [index:string]: string; },callState?:SessionMemberCallState,role?:SessionMemberRoles,callSid?:string,muted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    identity;
    /** @type {string} */
    endpointId;
    /** @type {string} */
    displayName;
    /** @type {boolean} */
    isOriginalMember;
    /** @type {string} */
    avatarUrl;
    /** @type {{ [index:string]: string; }} */
    applicationData;
    /** @type {SessionMemberCallState} */
    callState;
    /** @type {SessionMemberRoles} */
    role;
    /** @type {string} */
    callSid;
    /** @type {boolean} */
    muted;
}
/** @typedef {'Incoming'|'Outgoing'} */
export var SessionDirections;
(function (SessionDirections) {
    SessionDirections["Incoming"] = "Incoming"
    SessionDirections["Outgoing"] = "Outgoing"
})(SessionDirections || (SessionDirections = {}));
export class SessionInfo extends EntityInfo {
    /** @param {{dialState?:SessionDialState,callState?:SessionCallState,queueState?:SessionQueueStates,accountId?:string,accountName?:string,customerId?:string,customerBreadcrumb?:CustomerBreadcrumb[],customerName?:string,endpointId?:string,endpointName?:string,dateCompleted?:string,destination?:string,toAddress?:string,fromAddress?:string,fromName?:string,answeredByName?:string,queueMemberId?:string,channel?:FlowChannels,ended?:boolean,outcome?:string,callSid?:string,consoleData?:string,holdQueueName?:string,heldByUserId?:string,holdReason?:SessionHoldReasons,conferenceSid?:string,displayName?:string,log?:SessionLogInfo[],members?:SessionMemberInfo[],callbackNumber?:string,answeredById?:string,direction?:SessionDirections,fromPhoneNumber?:string,mostRecentParticipantCallSid?:string,wasMissed?:boolean,ringQueueId?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {SessionDialState}
     * @description The state of the session */
    dialState;
    /**
     * @type {SessionCallState}
     * @description The call state of the session */
    callState;
    /**
     * @type {SessionQueueStates}
     * @description The queue state of the session */
    queueState;
    /**
     * @type {string}
     * @description The ID of the account associated with the flow */
    accountId;
    /**
     * @type {string}
     * @description The name of the account associated with the session */
    accountName;
    /**
     * @type {string}
     * @description The ID of the customer this session is associated with */
    customerId;
    /**
     * @type {CustomerBreadcrumb[]}
     * @description The customer breadcrumb this session is associated with */
    customerBreadcrumb;
    /**
     * @type {string}
     * @description The name of the customer this session is associated with */
    customerName;
    /**
     * @type {string}
     * @description The ID of the endpoint associated with this session */
    endpointId;
    /**
     * @type {string}
     * @description The name of the endpoint associated with this session */
    endpointName;
    /**
     * @type {string}
     * @description The date the call completed */
    dateCompleted;
    /**
     * @type {string}
     * @description The destination of the session (e.g. what was entered into the Dial box) */
    destination;
    /**
     * @type {string}
     * @description The to address if any */
    toAddress;
    /**
     * @type {string}
     * @description The from address if any */
    fromAddress;
    /**
     * @type {string}
     * @description The from name if any */
    fromName;
    /**
     * @type {string}
     * @description Answered by name (if any) */
    answeredByName;
    /**
     * @type {string}
     * @description The ID of the queue member assigned to this call */
    queueMemberId;
    /**
     * @type {FlowChannels}
     * @description The flow channel */
    channel;
    /**
     * @type {boolean}
     * @description Has the session ended */
    ended;
    /**
     * @type {string}
     * @description The outcome of the call */
    outcome;
    /**
     * @type {string}
     * @description The twilio Call SID of this session */
    callSid;
    /**
     * @type {string}
     * @description Any console data for this session */
    consoleData;
    /**
     * @type {string}
     * @description The name of the hold queue for this call */
    holdQueueName;
    /**
     * @type {string}
     * @description The user ID who put this call on hold */
    heldByUserId;
    /**
     * @type {SessionHoldReasons}
     * @description The reason for the hold */
    holdReason;
    /**
     * @type {string}
     * @description The SID of the conference if in a conference call */
    conferenceSid;
    /**
     * @type {string}
     * @description The display name for this session */
    displayName;
    /**
     * @type {SessionLogInfo[]}
     * @description The log entries for this session */
    log;
    /**
     * @type {SessionMemberInfo[]}
     * @description The members of this session */
    members;
    /**
     * @type {string}
     * @description The callback number (typically used for SIP to User calls) */
    callbackNumber;
    /**
     * @type {string}
     * @description The ID of the endpoint that answered */
    answeredById;
    /**
     * @type {SessionDirections}
     * @description Is this session incoming or outgoing? */
    direction;
    /**
     * @type {string}
     * @description The phone number that this session is coming from (used with SMS chats) */
    fromPhoneNumber;
    /**
     * @type {string}
     * @description The Call SID of the most recently added conference participant */
    mostRecentParticipantCallSid;
    /**
     * @type {boolean}
     * @description Was this session missed? */
    wasMissed;
    /**
     * @type {string}
     * @description The ring queue that the call is currently in */
    ringQueueId;
}
export class AppGetActiveSessionsResult {
    /** @param {{sessions?:SessionInfo[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SessionInfo[]} */
    sessions;
}
export class AppGetActiveSessions {
    /** @param {{accountId?:string,customerId?:string,startDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    accountId;
    /** @type {string} */
    customerId;
    /** @type {string} */
    startDate;
}

JavaScript AppGetActiveSessions 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.

GET /portal/active-sessions HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AppGetActiveSessionsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal">
  <Sessions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
    <d2p1:SessionInfo>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
      <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
      <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
      <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:AnsweredById>String</d2p1:AnsweredById>
      <d2p1:AnsweredByName>String</d2p1:AnsweredByName>
      <d2p1:CallSid>String</d2p1:CallSid>
      <d2p1:CallState>Disconnected</d2p1:CallState>
      <d2p1:CallbackNumber>String</d2p1:CallbackNumber>
      <d2p1:Channel>Voice</d2p1:Channel>
      <d2p1:ConferenceSid>String</d2p1:ConferenceSid>
      <d2p1:ConsoleData>String</d2p1:ConsoleData>
      <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
        <d4p1:CustomerBreadcrumb>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:CustomerBreadcrumb>
      </d2p1:CustomerBreadcrumb>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:DateCompleted>String</d2p1:DateCompleted>
      <d2p1:Destination>String</d2p1:Destination>
      <d2p1:DialState>None</d2p1:DialState>
      <d2p1:Direction>Incoming</d2p1:Direction>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Ended>false</d2p1:Ended>
      <d2p1:EndpointId>String</d2p1:EndpointId>
      <d2p1:EndpointName>String</d2p1:EndpointName>
      <d2p1:FromAddress>String</d2p1:FromAddress>
      <d2p1:FromName>String</d2p1:FromName>
      <d2p1:FromPhoneNumber>String</d2p1:FromPhoneNumber>
      <d2p1:HeldByUserId>String</d2p1:HeldByUserId>
      <d2p1:HoldQueueName>String</d2p1:HoldQueueName>
      <d2p1:HoldReason>None</d2p1:HoldReason>
      <d2p1:Log>
        <d2p1:SessionLogInfo>
          <d2p1:Date>String</d2p1:Date>
          <d2p1:Message>String</d2p1:Message>
        </d2p1:SessionLogInfo>
      </d2p1:Log>
      <d2p1:Members>
        <d2p1:SessionMemberInfo>
          <d2p1:ApplicationData xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:ApplicationData>
          <d2p1:AvatarUrl>String</d2p1:AvatarUrl>
          <d2p1:CallSid>String</d2p1:CallSid>
          <d2p1:CallState>None</d2p1:CallState>
          <d2p1:DisplayName>String</d2p1:DisplayName>
          <d2p1:EndpointId>String</d2p1:EndpointId>
          <d2p1:Identity>String</d2p1:Identity>
          <d2p1:IsOriginalMember>false</d2p1:IsOriginalMember>
          <d2p1:Muted>false</d2p1:Muted>
          <d2p1:Role>None</d2p1:Role>
        </d2p1:SessionMemberInfo>
      </d2p1:Members>
      <d2p1:MostRecentParticipantCallSid>String</d2p1:MostRecentParticipantCallSid>
      <d2p1:Outcome>String</d2p1:Outcome>
      <d2p1:QueueMemberId>String</d2p1:QueueMemberId>
      <d2p1:QueueState>None</d2p1:QueueState>
      <d2p1:RingQueueId>String</d2p1:RingQueueId>
      <d2p1:ToAddress>String</d2p1:ToAddress>
      <d2p1:WasMissed>false</d2p1:WasMissed>
    </d2p1:SessionInfo>
  </Sessions>
</AppGetActiveSessionsResult>