| PATCH | /portal/assistant |
|---|
"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 CustomerBreadcrumb {
/** @param {{id?:string,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
}
/** @typedef {'PhoneNumber'|'User'|'FaxNumber'|'EmailAddress'|'Unused_1'|'Unused_2'|'Unused_3'|'Unused_4'|'Unused_5'|'Team'|'Assistant'} */
export var EndpointTypes;
(function (EndpointTypes) {
EndpointTypes["PhoneNumber"] = "PhoneNumber"
EndpointTypes["User"] = "User"
EndpointTypes["FaxNumber"] = "FaxNumber"
EndpointTypes["EmailAddress"] = "EmailAddress"
EndpointTypes["Unused_1"] = "Unused_1"
EndpointTypes["Unused_2"] = "Unused_2"
EndpointTypes["Unused_3"] = "Unused_3"
EndpointTypes["Unused_4"] = "Unused_4"
EndpointTypes["Unused_5"] = "Unused_5"
EndpointTypes["Team"] = "Team"
EndpointTypes["Assistant"] = "Assistant"
})(EndpointTypes || (EndpointTypes = {}));
export class Value {
/** @param {{boolValue?:boolean,stringValue?:string,numberValue?:number,listValue?:Struct[],structValue?:Struct}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?boolean} */
boolValue;
/** @type {string} */
stringValue;
/** @type {?number} */
numberValue;
/** @type {Struct[]} */
listValue;
/** @type {Struct} */
structValue;
}
class Dictionary {}
export class Struct extends Dictionary {
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'Always'|'Scheduled'|'Simple'} */
export var EndpointFlowSchedules;
(function (EndpointFlowSchedules) {
EndpointFlowSchedules["Always"] = "Always"
EndpointFlowSchedules["Scheduled"] = "Scheduled"
EndpointFlowSchedules["Simple"] = "Simple"
})(EndpointFlowSchedules || (EndpointFlowSchedules = {}));
/** @typedef {'Always'|'CustomerState'|'Time'} */
export var SimpleSchedulingRuleTypes;
(function (SimpleSchedulingRuleTypes) {
SimpleSchedulingRuleTypes["Always"] = "Always"
SimpleSchedulingRuleTypes["CustomerState"] = "CustomerState"
SimpleSchedulingRuleTypes["Time"] = "Time"
})(SimpleSchedulingRuleTypes || (SimpleSchedulingRuleTypes = {}));
export class ScheduleDay {
/** @param {{offset?:number,dayOfWeek?:DayOfWeek}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {DayOfWeek} */
dayOfWeek;
}
/** @typedef {'None'|'Secondly'|'Minutely'|'Hourly'|'Daily'|'Weekly'|'Monthly'|'Yearly'} */
export var SchedulingRuleFrequency;
(function (SchedulingRuleFrequency) {
SchedulingRuleFrequency["None"] = "None"
SchedulingRuleFrequency["Secondly"] = "Secondly"
SchedulingRuleFrequency["Minutely"] = "Minutely"
SchedulingRuleFrequency["Hourly"] = "Hourly"
SchedulingRuleFrequency["Daily"] = "Daily"
SchedulingRuleFrequency["Weekly"] = "Weekly"
SchedulingRuleFrequency["Monthly"] = "Monthly"
SchedulingRuleFrequency["Yearly"] = "Yearly"
})(SchedulingRuleFrequency || (SchedulingRuleFrequency = {}));
export class SchedulingRule {
/** @param {{id?:string,name?:string,priority?:number,state?:string,source?:string,condition?:string,simpleRuleType?:SimpleSchedulingRuleTypes,customerState?:string,flowId?:string,flowParams?:Struct,isAllDay?:boolean,startDate?:string,startTime?:string,endTime?:string,bySetPosition?:number[],byMonth?:number[],byWeekNo?:number[],byYearDay?:number[],byMonthDay?:number[],byDay?:ScheduleDay[],byHour?:number[],byMinute?:number[],interval?:number,count?:number,untilDate?:string,frequency?:SchedulingRuleFrequency}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {number} */
priority;
/** @type {string} */
state;
/** @type {string} */
source;
/** @type {string} */
condition;
/** @type {SimpleSchedulingRuleTypes} */
simpleRuleType;
/** @type {string} */
customerState;
/** @type {string} */
flowId;
/** @type {Struct} */
flowParams;
/** @type {boolean} */
isAllDay;
/** @type {string} */
startDate;
/** @type {string} */
startTime;
/** @type {string} */
endTime;
/** @type {number[]} */
bySetPosition;
/** @type {number[]} */
byMonth;
/** @type {number[]} */
byWeekNo;
/** @type {number[]} */
byYearDay;
/** @type {number[]} */
byMonthDay;
/** @type {ScheduleDay[]} */
byDay;
/** @type {number[]} */
byHour;
/** @type {number[]} */
byMinute;
/** @type {number} */
interval;
/** @type {number} */
count;
/** @type {string} */
untilDate;
/** @type {SchedulingRuleFrequency} */
frequency;
}
export class Schedule {
/** @param {{timeZoneId?:string,inherit?:boolean,forceClosed?:boolean,rules?:SchedulingRule[],defaultState?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
timeZoneId;
/** @type {boolean} */
inherit;
/** @type {boolean} */
forceClosed;
/** @type {SchedulingRule[]} */
rules;
/** @type {string} */
defaultState;
}
export class ScheduledFlow {
/** @param {{stateName?:string,flowId?:string,flowParams?:Struct}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
stateName;
/** @type {string} */
flowId;
/** @type {Struct} */
flowParams;
}
/** @typedef {'NorthAmericaVirginia'|'NorthAmericaOregon'|'EuropeIreland'|'EuropeFrankfurt'|'AsiaPacificSingapore'|'AsiaPacificTokyo'|'AsiaPacificSydney'|'SouthAmericaSanPaolo'} */
export var TwilioSipRegions;
(function (TwilioSipRegions) {
TwilioSipRegions["NorthAmericaVirginia"] = "NorthAmericaVirginia"
TwilioSipRegions["NorthAmericaOregon"] = "NorthAmericaOregon"
TwilioSipRegions["EuropeIreland"] = "EuropeIreland"
TwilioSipRegions["EuropeFrankfurt"] = "EuropeFrankfurt"
TwilioSipRegions["AsiaPacificSingapore"] = "AsiaPacificSingapore"
TwilioSipRegions["AsiaPacificTokyo"] = "AsiaPacificTokyo"
TwilioSipRegions["AsiaPacificSydney"] = "AsiaPacificSydney"
TwilioSipRegions["SouthAmericaSanPaolo"] = "SouthAmericaSanPaolo"
})(TwilioSipRegions || (TwilioSipRegions = {}));
/** @typedef {'Unknown'|'Ready'|'NotReady'|'LoggedOut'|'WrapUp'|'Outgoing'|'Other'} */
export var AgentStates;
(function (AgentStates) {
AgentStates["Unknown"] = "Unknown"
AgentStates["Ready"] = "Ready"
AgentStates["NotReady"] = "NotReady"
AgentStates["LoggedOut"] = "LoggedOut"
AgentStates["WrapUp"] = "WrapUp"
AgentStates["Outgoing"] = "Outgoing"
AgentStates["Other"] = "Other"
})(AgentStates || (AgentStates = {}));
/** @typedef {'Unknown'|'SetByUser'|'MissedCall'|'SetBySystem'} */
export var AgentStateReasons;
(function (AgentStateReasons) {
AgentStateReasons["Unknown"] = "Unknown"
AgentStateReasons["SetByUser"] = "SetByUser"
AgentStateReasons["MissedCall"] = "MissedCall"
AgentStateReasons["SetBySystem"] = "SetBySystem"
})(AgentStateReasons || (AgentStateReasons = {}));
/** @typedef {'SoftPhone'|'Sip'|'Flow'|'DataOnly'|'ThirdParty'} */
export var UserModes;
(function (UserModes) {
UserModes["SoftPhone"] = "SoftPhone"
UserModes["Sip"] = "Sip"
UserModes["Flow"] = "Flow"
UserModes["DataOnly"] = "DataOnly"
UserModes["ThirdParty"] = "ThirdParty"
})(UserModes || (UserModes = {}));
/** @typedef {'None'|'Manager'|'VoicemailAndCallHistory'|'Custom'} */
export var UserManagerRoles;
(function (UserManagerRoles) {
UserManagerRoles["None"] = "None"
UserManagerRoles["Manager"] = "Manager"
UserManagerRoles["VoicemailAndCallHistory"] = "VoicemailAndCallHistory"
UserManagerRoles["Custom"] = "Custom"
})(UserManagerRoles || (UserManagerRoles = {}));
/** @typedef {'ViewFiles'|'ViewNotifications'|'ViewSessions'|'ViewEndpoints'|'ViewReports'|'ViewCustomers'|'ViewFlows'} */
export var DashboardPermissions;
(function (DashboardPermissions) {
DashboardPermissions["ViewFiles"] = "ViewFiles"
DashboardPermissions["ViewNotifications"] = "ViewNotifications"
DashboardPermissions["ViewSessions"] = "ViewSessions"
DashboardPermissions["ViewEndpoints"] = "ViewEndpoints"
DashboardPermissions["ViewReports"] = "ViewReports"
DashboardPermissions["ViewCustomers"] = "ViewCustomers"
DashboardPermissions["ViewFlows"] = "ViewFlows"
})(DashboardPermissions || (DashboardPermissions = {}));
/** @typedef {'Hidden'|'ReadOnly'|'ReadWrite'} */
export var UserDataFieldModes;
(function (UserDataFieldModes) {
UserDataFieldModes["Hidden"] = "Hidden"
UserDataFieldModes["ReadOnly"] = "ReadOnly"
UserDataFieldModes["ReadWrite"] = "ReadWrite"
})(UserDataFieldModes || (UserDataFieldModes = {}));
/** @typedef {'Magenta'|'Red'|'Volcano'|'Orange'|'Gold'|'Lime'|'Green'|'Cyan'|'Blue'|'GeekBlue'|'Purple'} */
export var TagColors;
(function (TagColors) {
TagColors["Magenta"] = "Magenta"
TagColors["Red"] = "Red"
TagColors["Volcano"] = "Volcano"
TagColors["Orange"] = "Orange"
TagColors["Gold"] = "Gold"
TagColors["Lime"] = "Lime"
TagColors["Green"] = "Green"
TagColors["Cyan"] = "Cyan"
TagColors["Blue"] = "Blue"
TagColors["GeekBlue"] = "GeekBlue"
TagColors["Purple"] = "Purple"
})(TagColors || (TagColors = {}));
export class Tag {
/** @param {{id?:string,name?:string,color?:TagColors}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {TagColors} */
color;
}
/** @typedef {'GET'|'POST'} */
export var ActionUrlHttpMethods;
(function (ActionUrlHttpMethods) {
ActionUrlHttpMethods["GET"] = "GET"
ActionUrlHttpMethods["POST"] = "POST"
})(ActionUrlHttpMethods || (ActionUrlHttpMethods = {}));
export class EndpointActionUrl {
/** @param {{id?:string,url?:string,method?:ActionUrlHttpMethods}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
url;
/** @type {ActionUrlHttpMethods} */
method;
}
/** @typedef {'None'|'CurrentCustomer'|'CurrentAndChildCustomers'} */
export var CustomerVisibility;
(function (CustomerVisibility) {
CustomerVisibility["None"] = "None"
CustomerVisibility["CurrentCustomer"] = "CurrentCustomer"
CustomerVisibility["CurrentAndChildCustomers"] = "CurrentAndChildCustomers"
})(CustomerVisibility || (CustomerVisibility = {}));
export class EndpointContact {
/** @param {{id?:string,displayName?:string,address?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
displayName;
/** @type {string} */
address;
}
export class IntegrationData {
/** @param {{thirdPartyId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
thirdPartyId;
}
export class EntityIntegrationData extends Dictionary {
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'Demo'|'Sip'} */
export var ThirdPartyPhoneSystemTypes;
(function (ThirdPartyPhoneSystemTypes) {
ThirdPartyPhoneSystemTypes["Demo"] = "Demo"
ThirdPartyPhoneSystemTypes["Sip"] = "Sip"
})(ThirdPartyPhoneSystemTypes || (ThirdPartyPhoneSystemTypes = {}));
/** @typedef {'UDP'|'TLS'|'TCP'|'PERS'} */
export var TransportTypes;
(function (TransportTypes) {
TransportTypes["UDP"] = "UDP"
TransportTypes["TLS"] = "TLS"
TransportTypes["TCP"] = "TCP"
TransportTypes["PERS"] = "PERS"
})(TransportTypes || (TransportTypes = {}));
/** @typedef {number} */
export var AudioCodecTypes;
(function (AudioCodecTypes) {
AudioCodecTypes[AudioCodecTypes["PCMU"] = 0] = "PCMU"
AudioCodecTypes[AudioCodecTypes["GSM"] = 3] = "GSM"
AudioCodecTypes[AudioCodecTypes["PCMA"] = 8] = "PCMA"
AudioCodecTypes[AudioCodecTypes["G722"] = 9] = "G722"
AudioCodecTypes[AudioCodecTypes["G729"] = 18] = "G729"
AudioCodecTypes[AudioCodecTypes["ILBC"] = 97] = "ILBC"
AudioCodecTypes[AudioCodecTypes["AMR"] = 98] = "AMR"
AudioCodecTypes[AudioCodecTypes["AMRWB"] = 99] = "AMRWB"
AudioCodecTypes[AudioCodecTypes["SPEEX"] = 100] = "SPEEX"
AudioCodecTypes[AudioCodecTypes["DTMF"] = 101] = "DTMF"
AudioCodecTypes[AudioCodecTypes["SPEEXWB"] = 102] = "SPEEXWB"
AudioCodecTypes[AudioCodecTypes["ISACWB"] = 103] = "ISACWB"
AudioCodecTypes[AudioCodecTypes["ISACSWB"] = 104] = "ISACSWB"
AudioCodecTypes[AudioCodecTypes["OPUS"] = 105] = "OPUS"
AudioCodecTypes[AudioCodecTypes["G7221"] = 121] = "G7221"
AudioCodecTypes[AudioCodecTypes["NONE"] = -1] = "NONE"
})(AudioCodecTypes || (AudioCodecTypes = {}));
/** @typedef {'RFC2833'|'INFO'} */
export var DtmfMethods;
(function (DtmfMethods) {
DtmfMethods["RFC2833"] = "RFC2833"
DtmfMethods["INFO"] = "INFO"
})(DtmfMethods || (DtmfMethods = {}));
export class ThirdPartySipAccountSettings {
/** @param {{number?:string,agent?:string,authName?:string,userName?:string,displayName?:string,password?:string,userDomain?:string,registrationExpires?:number,transportType?:TransportTypes,localIP?:string,localPort?:number,sipServer?:string,sipServerPort?:number,outboundServer?:string,outboundServerPort?:number,stunServer?:string,stunPort?:number,audioPlaybackDeviceName?:string,audioRecordingDeviceName?:string,audioCodecs?:AudioCodecTypes[],dtmfMethod?:DtmfMethods}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {string} */
agent;
/** @type {string} */
authName;
/** @type {string} */
userName;
/** @type {string} */
displayName;
/** @type {string} */
password;
/** @type {string} */
userDomain;
/** @type {number} */
registrationExpires;
/** @type {TransportTypes} */
transportType;
/** @type {string} */
localIP;
/** @type {number} */
localPort;
/** @type {string} */
sipServer;
/** @type {number} */
sipServerPort;
/** @type {string} */
outboundServer;
/** @type {number} */
outboundServerPort;
/** @type {string} */
stunServer;
/** @type {number} */
stunPort;
/** @type {string} */
audioPlaybackDeviceName;
/** @type {string} */
audioRecordingDeviceName;
/** @type {AudioCodecTypes[]} */
audioCodecs;
/** @type {DtmfMethods} */
dtmfMethod;
}
export class ThirdPartySipSettings {
/** @param {{accounts?:ThirdPartySipAccountSettings[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ThirdPartySipAccountSettings[]} */
accounts;
}
export class ThirdPartyDemoSettings {
/** @param {{extension?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
extension;
}
export class ThirdPartyPhoneSystemSettings {
/** @param {{type?:ThirdPartyPhoneSystemTypes,sipSettings?:ThirdPartySipSettings,demoSettings?:ThirdPartyDemoSettings}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ThirdPartyPhoneSystemTypes} */
type;
/** @type {ThirdPartySipSettings} */
sipSettings;
/** @type {ThirdPartyDemoSettings} */
demoSettings;
}
export class AppSettings {
/** @param {{enablePhoneNumberManagement?:boolean,enableDeviceManagement?:boolean,enableDialer?:boolean,enableCallHistory?:boolean,enableAssistants?:boolean,showFileNameInMessageCenter?:boolean,chakraTheme?:string,customCss?:string,pageTitle?:string,stringMappings?:string,logoutUrl?:string,portMyNumberUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
enablePhoneNumberManagement;
/** @type {boolean} */
enableDeviceManagement;
/** @type {boolean} */
enableDialer;
/** @type {boolean} */
enableCallHistory;
/** @type {boolean} */
enableAssistants;
/** @type {boolean} */
showFileNameInMessageCenter;
/** @type {string} */
chakraTheme;
/** @type {string} */
customCss;
/** @type {string} */
pageTitle;
/** @type {string} */
stringMappings;
/** @type {string} */
logoutUrl;
/** @type {string} */
portMyNumberUrl;
}
/** @typedef {'Accuracy'|'Speed'} */
export var AssistantTunings;
(function (AssistantTunings) {
AssistantTunings["Accuracy"] = "Accuracy"
AssistantTunings["Speed"] = "Speed"
})(AssistantTunings || (AssistantTunings = {}));
export class AssistantWord {
/** @param {{word?:string,pronounced?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
word;
/** @type {string} */
pronounced;
}
export class AssistantLink {
/** @param {{url?:string,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
url;
/** @type {string} */
description;
}
/** @typedef {'Blind'|'Supervised'|'MessagesOnly'} */
export var AssistantTransferTypes;
(function (AssistantTransferTypes) {
AssistantTransferTypes["Blind"] = "Blind"
AssistantTransferTypes["Supervised"] = "Supervised"
AssistantTransferTypes["MessagesOnly"] = "MessagesOnly"
})(AssistantTransferTypes || (AssistantTransferTypes = {}));
export class AssistantTakeMessageField {
/** @param {{name?:string,description?:string,required?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
description;
/** @type {boolean} */
required;
}
export class AssistantContact {
/** @param {{name?:string,phoneNumber?:string,transferType?:AssistantTransferTypes,about?:string,emailAddress?:string,takeMessageFields?:AssistantTakeMessageField[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
phoneNumber;
/** @type {AssistantTransferTypes} */
transferType;
/** @type {string} */
about;
/** @type {string} */
emailAddress;
/** @type {AssistantTakeMessageField[]} */
takeMessageFields;
}
export class AssistantIntegration {
/** @param {{uri?:string,httpMethod?:string,authToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uri;
/** @type {string} */
httpMethod;
/** @type {string} */
authToken;
}
export class AssistantSettings {
/** @param {{companyName?:string,greeting?:string,companyInformation?:string,customPrompt?:string,voice?:string,voiceStyle?:string,tuning?:AssistantTunings,words?:AssistantWord[],links?:AssistantLink[],contacts?:AssistantContact[],integrations?:AssistantIntegration[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
companyName;
/** @type {string} */
greeting;
/** @type {string} */
companyInformation;
/** @type {string} */
customPrompt;
/** @type {string} */
voice;
/** @type {string} */
voiceStyle;
/** @type {AssistantTunings} */
tuning;
/** @type {AssistantWord[]} */
words;
/** @type {AssistantLink[]} */
links;
/** @type {AssistantContact[]} */
contacts;
/** @type {AssistantIntegration[]} */
integrations;
}
export class EmbedSettings {
/** @param {{enabled?:boolean,allowedHosts?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
enabled;
/** @type {string} */
allowedHosts;
}
export class EndpointInfo extends EntityInfo {
/** @param {{accountId?:string,accountName?:string,customerId?:string,customerName?:string,referenceId?:string,customerBreadcrumb?:CustomerBreadcrumb[],displayName?:string,type?:EndpointTypes,extraInformation?:string,flowId?:string,flowName?:string,flowParams?:Struct,flowSchedule?:EndpointFlowSchedules,schedule?:Schedule,scheduledFlows?:ScheduledFlow[],disableSms?:boolean,useExternal10DlcCampaign?:boolean,isVirtualPhoneNumber?:boolean,isCallerIdVerified?:boolean,callerIdVerificationCode?:string,phoneNumber?:string,phoneNumberSid?:string,callerIdName?:string,addressSid?:string,doNotTouchPhoneNumber?:boolean,isEnrolledIn10DlcService?:boolean,enableCallerIdLookup?:boolean,userEmailAddress?:string,sipRegion?:TwilioSipRegions,sipCredentialSid?:string,sipUserName?:string,sipPassword?:string,sipDomain?:string,enableEmergencyCalling?:boolean,emergencyAddressSid?:string,emergencyPhoneNumberId?:string,agentState?:AgentStates,agentStateReason?:AgentStateReasons,userMode?:UserModes,voicemailGreetingId?:string,data?:Struct,emailAddress?:string,userFirstName?:string,userLastName?:string,avatarUrl?:string,managerRole?:UserManagerRoles,dashboardPermissions?:DashboardPermissions[],myFieldPermissions?:UserDataFieldModes,customerFieldPermissions?:UserDataFieldModes,otherUserFieldPermissions?:UserDataFieldModes,otherEndpointFieldPermissions?:UserDataFieldModes,name?:string,tags?:Tag[],actionUrls?:EndpointActionUrl[],teamMemberIds?:string[],contactListVisibility?:CustomerVisibility,contacts?:EndpointContact[],documoId?:string,integrationData?:EntityIntegrationData,thirdPartyPhoneSystemSettings?:ThirdPartyPhoneSystemSettings,overrideAppSettings?:boolean,appSettings?:AppSettings,assistantSettings?:AssistantSettings,embedSettings?:EmbedSettings,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The account ID this endpoint is associated with */
accountId;
/**
* @type {string}
* @description The name of the account this endpoint is associated with */
accountName;
/**
* @type {string}
* @description The ID of the customer this endpoint is associated with */
customerId;
/**
* @type {string}
* @description The name of the customer this endpoint is associated with */
customerName;
/**
* @type {string}
* @description The third party reference ID for the endpoint */
referenceId;
/**
* @type {CustomerBreadcrumb[]}
* @description The breadcrumb to the customer for this endpoint */
customerBreadcrumb;
/**
* @type {string}
* @description The display name of the endpoint */
displayName;
/**
* @type {EndpointTypes}
* @description The type of endpoint */
type;
/**
* @type {string}
* @description Extra info for this endpoint (typically to show in grid) */
extraInformation;
/**
* @type {string}
* @description The ID of the flow to use for voice */
flowId;
/**
* @type {string}
* @description The name of the flow to use for voice */
flowName;
/**
* @type {Struct}
* @description The params for the voice flow */
flowParams;
/**
* @type {EndpointFlowSchedules}
* @description Whether to use a single flow always or use scheduled flow system */
flowSchedule;
/**
* @type {Schedule}
* @description This endpoint's schedule */
schedule;
/**
* @type {ScheduledFlow[]}
* @description The list of scheduled flows when using scheduling */
scheduledFlows;
/**
* @type {boolean}
* @description Disable SMS */
disableSms;
/**
* @type {boolean}
* @description Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number */
useExternal10DlcCampaign;
/**
* @type {boolean}
* @description Is this a virtual phone number? */
isVirtualPhoneNumber;
/**
* @type {boolean}
* @description Is caller ID verified for this virtual number? */
isCallerIdVerified;
/**
* @type {string}
* @description The verification code for this number */
callerIdVerificationCode;
/**
* @type {string}
* @description The phone number */
phoneNumber;
/**
* @type {string}
* @description The Sid of the phone number */
phoneNumberSid;
/**
* @type {string}
* @description The caller ID Name (CNAM) for the phone number */
callerIdName;
/**
* @type {string}
* @description The address SID associated with the phone number */
addressSid;
/**
* @type {boolean}
* @description Do not touch this phone number - for BYOA accounts */
doNotTouchPhoneNumber;
/**
* @type {boolean}
* @description Is this number enrolled in a 10DLC messaging service campaign */
isEnrolledIn10DlcService;
/**
* @type {boolean}
* @description Whether we look up caller ID or not */
enableCallerIdLookup;
/**
* @type {string}
* @description The email address of the user */
userEmailAddress;
/**
* @type {TwilioSipRegions}
* @description The Twilio Region for the SIP endpoint */
sipRegion;
/**
* @type {string}
* @description The Twilio Sid of the credentials for Sip */
sipCredentialSid;
/**
* @type {string}
* @description The Twilio SIP user name */
sipUserName;
/**
* @type {string}
* @description The Twilio SIP password */
sipPassword;
/**
* @type {string}
* @description The SIP domain */
sipDomain;
/**
* @type {boolean}
* @description Is emergency calling enabled on this number? */
enableEmergencyCalling;
/**
* @type {string}
* @description The SID of the emergency address for this number */
emergencyAddressSid;
/**
* @type {string}
* @description The ID of the phone number to use for emergency dialing */
emergencyPhoneNumberId;
/**
* @type {AgentStates}
* @description The current agent state of this user endpoint */
agentState;
/**
* @type {AgentStateReasons}
* @description The current agent state reason of this user endpoint */
agentStateReason;
/**
* @type {UserModes}
* @description The mode for this user */
userMode;
/**
* @type {string}
* @description The ID of the file to use for voicemail greeting */
voicemailGreetingId;
/**
* @type {Struct}
* @description The endpoint's data */
data;
/**
* @type {string}
* @description The email address for email endpoints */
emailAddress;
/**
* @type {string}
* @description The first name of the user (for user endpoints) */
userFirstName;
/**
* @type {string}
* @description The last name of the user (for user endpoints) */
userLastName;
/**
* @type {string}
* @description The URL of an image for this user's avatar */
avatarUrl;
/**
* @type {UserManagerRoles}
* @description Does this user have manager role? */
managerRole;
/**
* @type {DashboardPermissions[]}
* @description The list of dashboard permissions for when the manager role is custom */
dashboardPermissions;
/**
* @type {UserDataFieldModes}
* @description The type of visibility this user has to their own fields */
myFieldPermissions;
/**
* @type {UserDataFieldModes}
* @description The type of visibility this user has to customer fields */
customerFieldPermissions;
/**
* @type {UserDataFieldModes}
* @description The type of visibility this user has to other user fields */
otherUserFieldPermissions;
/**
* @type {UserDataFieldModes}
* @description The type of visibility this user has to other endpoint fields */
otherEndpointFieldPermissions;
/**
* @type {string}
* @description The name of this endpoint (for bots etc.) */
name;
/**
* @type {Tag[]}
* @description The list of tags for this endpoint */
tags;
/**
* @type {EndpointActionUrl[]}
* @description The list of action URLs */
actionUrls;
/**
* @type {string[]}
* @description The list of members in this team */
teamMemberIds;
/**
* @type {CustomerVisibility}
* @description Visibility of this user/team in contact lists */
contactListVisibility;
/**
* @type {EndpointContact[]}
* @description The list of contacts personal to this user */
contacts;
/**
* @type {string}
* @description The documo ID for this number */
documoId;
/**
* @type {EntityIntegrationData}
* @description Integration data for this endpoint */
integrationData;
/**
* @type {ThirdPartyPhoneSystemSettings}
* @description Settings for third party phone system */
thirdPartyPhoneSystemSettings;
/**
* @type {boolean}
* @description Should this user override the parent customer's app settings */
overrideAppSettings;
/**
* @type {AppSettings}
* @description App / Portal settings for this user */
appSettings;
/**
* @type {AssistantSettings}
* @description Configuration for the AI assistant */
assistantSettings;
/**
* @type {EmbedSettings}
* @description Configuration for the embed */
embedSettings;
}
export class AppUpdateAssistant {
/** @param {{assistantId?:string,name?:string,settings?:AssistantSettings}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
assistantId;
/** @type {string} */
name;
/** @type {AssistantSettings} */
settings;
}
JavaScript AppUpdateAssistant DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /portal/assistant HTTP/1.1
Host: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AppUpdateAssistant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal">
<AssistantId>String</AssistantId>
<Name>String</Name>
<Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints">
<d2p1:CompanyInformation>String</d2p1:CompanyInformation>
<d2p1:CompanyName>String</d2p1:CompanyName>
<d2p1:Contacts>
<d2p1:AssistantContact>
<d2p1:About>String</d2p1:About>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:Name>String</d2p1:Name>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:TakeMessageFields>
<d2p1:AssistantTakeMessageField>
<d2p1:Description>String</d2p1:Description>
<d2p1:Name>String</d2p1:Name>
<d2p1:Required>false</d2p1:Required>
</d2p1:AssistantTakeMessageField>
</d2p1:TakeMessageFields>
<d2p1:TransferType>Blind</d2p1:TransferType>
</d2p1:AssistantContact>
</d2p1:Contacts>
<d2p1:CustomPrompt>String</d2p1:CustomPrompt>
<d2p1:Greeting>String</d2p1:Greeting>
<d2p1:Integrations>
<d2p1:AssistantIntegration>
<d2p1:AuthToken>String</d2p1:AuthToken>
<d2p1:HttpMethod>String</d2p1:HttpMethod>
<d2p1:Uri>String</d2p1:Uri>
</d2p1:AssistantIntegration>
</d2p1:Integrations>
<d2p1:Links>
<d2p1:AssistantLink>
<d2p1:Description>String</d2p1:Description>
<d2p1:Url>String</d2p1:Url>
</d2p1:AssistantLink>
</d2p1:Links>
<d2p1:Tuning>Accuracy</d2p1:Tuning>
<d2p1:Voice>String</d2p1:Voice>
<d2p1:VoiceStyle>String</d2p1:VoiceStyle>
<d2p1:Words>
<d2p1:AssistantWord>
<d2p1:Pronounced>String</d2p1:Pronounced>
<d2p1:Word>String</d2p1:Word>
</d2p1:AssistantWord>
</d2p1:Words>
</Settings>
</AppUpdateAssistant>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EndpointInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints">
<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>
<ActionUrls>
<EndpointActionUrl>
<Id>String</Id>
<Method>GET</Method>
<Url>String</Url>
</EndpointActionUrl>
</ActionUrls>
<AddressSid>String</AddressSid>
<AgentState>Unknown</AgentState>
<AgentStateReason>Unknown</AgentStateReason>
<AppSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d2p1:ChakraTheme>String</d2p1:ChakraTheme>
<d2p1:CustomCss>String</d2p1:CustomCss>
<d2p1:EnableAssistants>false</d2p1:EnableAssistants>
<d2p1:EnableCallHistory>false</d2p1:EnableCallHistory>
<d2p1:EnableDeviceManagement>false</d2p1:EnableDeviceManagement>
<d2p1:EnableDialer>false</d2p1:EnableDialer>
<d2p1:EnablePhoneNumberManagement>false</d2p1:EnablePhoneNumberManagement>
<d2p1:LogoutUrl>String</d2p1:LogoutUrl>
<d2p1:PageTitle>String</d2p1:PageTitle>
<d2p1:PortMyNumberUrl>String</d2p1:PortMyNumberUrl>
<d2p1:ShowFileNameInMessageCenter>false</d2p1:ShowFileNameInMessageCenter>
<d2p1:StringMappings>String</d2p1:StringMappings>
</AppSettings>
<AssistantSettings>
<CompanyInformation>String</CompanyInformation>
<CompanyName>String</CompanyName>
<Contacts>
<AssistantContact>
<About>String</About>
<EmailAddress>String</EmailAddress>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<TakeMessageFields>
<AssistantTakeMessageField>
<Description>String</Description>
<Name>String</Name>
<Required>false</Required>
</AssistantTakeMessageField>
</TakeMessageFields>
<TransferType>Blind</TransferType>
</AssistantContact>
</Contacts>
<CustomPrompt>String</CustomPrompt>
<Greeting>String</Greeting>
<Integrations>
<AssistantIntegration>
<AuthToken>String</AuthToken>
<HttpMethod>String</HttpMethod>
<Uri>String</Uri>
</AssistantIntegration>
</Integrations>
<Links>
<AssistantLink>
<Description>String</Description>
<Url>String</Url>
</AssistantLink>
</Links>
<Tuning>Accuracy</Tuning>
<Voice>String</Voice>
<VoiceStyle>String</VoiceStyle>
<Words>
<AssistantWord>
<Pronounced>String</Pronounced>
<Word>String</Word>
</AssistantWord>
</Words>
</AssistantSettings>
<AvatarUrl>String</AvatarUrl>
<CallerIdName>String</CallerIdName>
<CallerIdVerificationCode>String</CallerIdVerificationCode>
<ContactListVisibility>None</ContactListVisibility>
<Contacts>
<EndpointContact>
<Address>String</Address>
<DisplayName>String</DisplayName>
<Id>String</Id>
</EndpointContact>
</Contacts>
<CustomerBreadcrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d2p1:CustomerBreadcrumb>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:CustomerBreadcrumb>
</CustomerBreadcrumb>
<CustomerFieldPermissions>Hidden</CustomerFieldPermissions>
<CustomerId>String</CustomerId>
<CustomerName>String</CustomerName>
<DashboardPermissions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
<d2p1:DashboardPermissions>ViewFiles</d2p1:DashboardPermissions>
</DashboardPermissions>
<Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<DisableSms>false</DisableSms>
<DisplayName>String</DisplayName>
<DoNotTouchPhoneNumber>false</DoNotTouchPhoneNumber>
<DocumoId>String</DocumoId>
<EmailAddress>String</EmailAddress>
<EmbedSettings>
<AllowedHosts>String</AllowedHosts>
<Enabled>false</Enabled>
</EmbedSettings>
<EmergencyAddressSid>String</EmergencyAddressSid>
<EmergencyPhoneNumberId>String</EmergencyPhoneNumberId>
<EnableCallerIdLookup>false</EnableCallerIdLookup>
<EnableEmergencyCalling>false</EnableEmergencyCalling>
<ExtraInformation>String</ExtraInformation>
<FlowId>String</FlowId>
<FlowName>String</FlowName>
<FlowParams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<FlowSchedule>Always</FlowSchedule>
<IntegrationData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
<d4p1:ThirdPartyId>String</d4p1:ThirdPartyId>
</d2p1:Value>
</d2p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
</IntegrationData>
<IsCallerIdVerified>false</IsCallerIdVerified>
<IsEnrolledIn10DlcService>false</IsEnrolledIn10DlcService>
<IsVirtualPhoneNumber>false</IsVirtualPhoneNumber>
<ManagerRole>None</ManagerRole>
<MyFieldPermissions>Hidden</MyFieldPermissions>
<Name>String</Name>
<OtherEndpointFieldPermissions>Hidden</OtherEndpointFieldPermissions>
<OtherUserFieldPermissions>Hidden</OtherUserFieldPermissions>
<OverrideAppSettings>false</OverrideAppSettings>
<PhoneNumber>String</PhoneNumber>
<PhoneNumberSid>String</PhoneNumberSid>
<ReferenceId>String</ReferenceId>
<Schedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling">
<d2p1:DefaultState>String</d2p1:DefaultState>
<d2p1:ForceClosed>false</d2p1:ForceClosed>
<d2p1:Inherit>false</d2p1:Inherit>
<d2p1:Rules>
<d2p1:SchedulingRule>
<d2p1:ByDay>
<d2p1:ScheduleDay>
<d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek>
<d2p1:Offset>0</d2p1:Offset>
</d2p1:ScheduleDay>
</d2p1:ByDay>
<d2p1:ByHour xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByHour>
<d2p1:ByMinute xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByMinute>
<d2p1:ByMonth xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByMonth>
<d2p1:ByMonthDay xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByMonthDay>
<d2p1:BySetPosition xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:BySetPosition>
<d2p1:ByWeekNo xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByWeekNo>
<d2p1:ByYearDay xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</d2p1:ByYearDay>
<d2p1:Condition>String</d2p1:Condition>
<d2p1:Count>0</d2p1:Count>
<d2p1:CustomerState>String</d2p1:CustomerState>
<d2p1:EndTime>String</d2p1:EndTime>
<d2p1:FlowId>String</d2p1:FlowId>
<d2p1:FlowParams xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<d2p1:Frequency>None</d2p1:Frequency>
<d2p1:Id>String</d2p1:Id>
<d2p1:Interval>0</d2p1:Interval>
<d2p1:IsAllDay>false</d2p1:IsAllDay>
<d2p1:Name>String</d2p1:Name>
<d2p1:Priority>0</d2p1:Priority>
<d2p1:SimpleRuleType>Always</d2p1:SimpleRuleType>
<d2p1:Source>String</d2p1:Source>
<d2p1:StartDate>String</d2p1:StartDate>
<d2p1:StartTime>String</d2p1:StartTime>
<d2p1:State>String</d2p1:State>
<d2p1:UntilDate>String</d2p1:UntilDate>
</d2p1:SchedulingRule>
</d2p1:Rules>
<d2p1:TimeZoneId>String</d2p1:TimeZoneId>
</Schedule>
<ScheduledFlows>
<ScheduledFlow>
<FlowId>String</FlowId>
<FlowParams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<StateName>String</StateName>
</ScheduledFlow>
</ScheduledFlows>
<SipCredentialSid>String</SipCredentialSid>
<SipDomain>String</SipDomain>
<SipPassword>String</SipPassword>
<SipRegion>NorthAmericaVirginia</SipRegion>
<SipUserName>String</SipUserName>
<Tags xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
<d2p1:Tag>
<d2p1:Color>Magenta</d2p1:Color>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:Tag>
</Tags>
<TeamMemberIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TeamMemberIds>
<ThirdPartyPhoneSystemSettings>
<DemoSettings>
<Extension>String</Extension>
</DemoSettings>
<SipSettings>
<Accounts>
<ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings>
<Agent>String</Agent>
<AudioCodecs>
<ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes>PCMU</ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes>
</AudioCodecs>
<AudioPlaybackDeviceName>String</AudioPlaybackDeviceName>
<AudioRecordingDeviceName>String</AudioRecordingDeviceName>
<AuthName>String</AuthName>
<DTMFMethod>RFC2833</DTMFMethod>
<DisplayName>String</DisplayName>
<LocalIP>String</LocalIP>
<LocalPort>0</LocalPort>
<Number>String</Number>
<OutboundServer>String</OutboundServer>
<OutboundServerPort>0</OutboundServerPort>
<Password>String</Password>
<RegistrationExpires>0</RegistrationExpires>
<SipServer>String</SipServer>
<SipServerPort>0</SipServerPort>
<StunPort>0</StunPort>
<StunServer>String</StunServer>
<TransportType>UDP</TransportType>
<UserDomain>String</UserDomain>
<UserName>String</UserName>
</ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings>
</Accounts>
</SipSettings>
<Type>Demo</Type>
</ThirdPartyPhoneSystemSettings>
<Type>PhoneNumber</Type>
<UseExternal10DlcCampaign>false</UseExternal10DlcCampaign>
<UserEmailAddress>String</UserEmailAddress>
<UserFirstName>String</UserFirstName>
<UserLastName>String</UserLastName>
<UserMode>SoftPhone</UserMode>
<VoicemailGreetingId>String</VoicemailGreetingId>
</EndpointInfo>