Evo Voice

<back to all web services

ApplyAISession

Applies all changes for the specified session

Requires Authentication
Requires the role:SystemAdministrator
The following routes are available for this service:
POST/ai/sessions/{sessionId}/apply
"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;
}
export class AISessionActionInfo {
    /** @param {{date?:string,id?:string,functionName?:string,arguments?:string,description?:string,canBeApplied?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    date;
    /** @type {string} */
    id;
    /** @type {string} */
    functionName;
    /** @type {string} */
    arguments;
    /** @type {string} */
    description;
    /** @type {boolean} */
    canBeApplied;
}
export class AISessionInfo extends EntityInfo {
    /** @param {{accountId?:string,accountName?:string,purpose?:string,actions?:AISessionActionInfo[],id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the account associated with this session */
    accountId;
    /**
     * @type {string}
     * @description The name of the account associated with this customer */
    accountName;
    /**
     * @type {string}
     * @description The purpose for this AI session */
    purpose;
    /**
     * @type {AISessionActionInfo[]}
     * @description The actions performed in this session */
    actions;
}
export class ApplyAISession {
    /** @param {{sessionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the session to apply */
    sessionId;
}

JavaScript ApplyAISession 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 /ai/sessions/{sessionId}/apply HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApplyAISession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <SessionId>String</SessionId>
</ApplyAISession>

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

<AISessionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <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>
  <AccountId>String</AccountId>
  <AccountName>String</AccountName>
  <Actions>
    <AISessionActionInfo>
      <Arguments>String</Arguments>
      <CanBeApplied>false</CanBeApplied>
      <Date>String</Date>
      <Description>String</Description>
      <FunctionName>String</FunctionName>
      <Id>String</Id>
    </AISessionActionInfo>
  </Actions>
  <Purpose>String</Purpose>
</AISessionInfo>