Evo Voice

<back to all web services

DeleteChatMember

Removes the specified member from the chat

Requires Authentication
Required role:User
The following routes are available for this service:
DELETE/sessions/{sessionId}/members/{memberId}
"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 DeleteChatMember {
    /** @param {{sessionId?:string,memberToRemove?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the session */
    sessionId;
    /**
     * @type {string}
     * @description The member to add. This can be a cell phone number, user ID (email) */
    memberToRemove;
}

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

DELETE /sessions/{sessionId}/members/{memberId} HTTP/1.1 
Host: team.evovoice.io 
Accept: text/csv

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

{"dialState":"None","callState":"Disconnected","queueState":"None","accountId":"String","accountName":"String","customerId":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"customerName":"String","endpointId":"String","endpointName":"String","dateCompleted":"String","destination":"String","toAddress":"String","fromAddress":"String","fromName":"String","answeredByName":"String","queueMemberId":"String","channel":"Voice","ended":false,"outcome":"String","callSid":"String","consoleData":"String","holdQueueName":"String","heldByUserId":"String","holdReason":"None","conferenceSid":"String","displayName":"String","log":[{"date":"String","message":"String"}],"members":[{"identity":"String","endpointId":"String","displayName":"String","isOriginalMember":false,"avatarUrl":"String","applicationData":{"String":"String"},"callState":"None","role":"None","callSid":"String","muted":false}],"callbackNumber":"String","answeredById":"String","direction":"Incoming","fromPhoneNumber":"String","mostRecentParticipantCallSid":"String","wasMissed":false,"ringQueueId":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}