GET | /portal/users |
---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export enum SortOrders
{
Ascend = 'Ascend',
Descend = 'Descend',
}
export class ListRequest<T> implements IGet
{
/** @description The page of data to retrieve */
// @ApiMember(Description="The page of data to retrieve")
public page: number;
/** @description If you want all objects to be returned. This should be used with care */
// @ApiMember(Description="If you want all objects to be returned. This should be used with care")
public all: boolean;
/** @description The number per page to retrieve */
// @ApiMember(Description="The number per page to retrieve")
public countPerPage: number;
/** @description Specific IDs */
// @ApiMember(Description="Specific IDs")
public specificIds: string[];
/** @description Specify a sort field */
// @ApiMember(Description="Specify a sort field")
public sortField: string;
/** @description Specify a sort order */
// @ApiMember(Description="Specify a sort order")
public sortOrder: SortOrders;
/** @description Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array */
// @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
public simplifiedPaging: boolean;
public constructor(init?: Partial<ListRequest<T>>) { (Object as any).assign(this, init); }
}
export class EntityInfo
{
/** @description The ID of the object */
// @ApiMember(Description="The ID of the object")
public id: string;
/** @description The date the object was created */
// @ApiMember(Description="The date the object was created")
public dateCreated: string;
/** @description The date the object was last modified */
// @ApiMember(Description="The date the object was last modified")
public dateLastModified: string;
/** @description The user that created this object */
// @ApiMember(Description="The user that created this object")
public createdBy: string;
/** @description The user that last modified this object */
// @ApiMember(Description="The user that last modified this object")
public lastModifiedBy: string;
public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}
export class CustomerBreadcrumb
{
public id: string;
public name: string;
public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}
export enum EndpointTypes
{
PhoneNumber = 'PhoneNumber',
User = 'User',
FaxNumber = 'FaxNumber',
EmailAddress = 'EmailAddress',
Unused_1 = 'Unused_1',
Unused_2 = 'Unused_2',
Unused_3 = 'Unused_3',
Unused_4 = 'Unused_4',
Unused_5 = 'Unused_5',
Team = 'Team',
Assistant = 'Assistant',
}
export class Value
{
public boolValue?: boolean;
public stringValue: string;
public numberValue?: number;
public listValue: Struct[];
public structValue: Struct;
public constructor(init?: Partial<Value>) { (Object as any).assign(this, init); }
}
export class Struct
{
public constructor(init?: Partial<Struct>) { (Object as any).assign(this, init); }
}
export enum EndpointFlowSchedules
{
Always = 'Always',
Scheduled = 'Scheduled',
Simple = 'Simple',
}
export enum SimpleSchedulingRuleTypes
{
Always = 'Always',
CustomerState = 'CustomerState',
Time = 'Time',
}
export class ScheduleDay
{
public offset: number;
public dayOfWeek: DayOfWeek;
public constructor(init?: Partial<ScheduleDay>) { (Object as any).assign(this, init); }
}
export enum SchedulingRuleFrequency
{
None = 'None',
Secondly = 'Secondly',
Minutely = 'Minutely',
Hourly = 'Hourly',
Daily = 'Daily',
Weekly = 'Weekly',
Monthly = 'Monthly',
Yearly = 'Yearly',
}
export class SchedulingRule
{
public id: string;
public name: string;
public priority: number;
public state: string;
public source: string;
public condition: string;
public simpleRuleType: SimpleSchedulingRuleTypes;
public customerState: string;
public flowId: string;
public flowParams: Struct;
public isAllDay: boolean;
public startDate: string;
public startTime: string;
public endTime: string;
public bySetPosition: number[];
public byMonth: number[];
public byWeekNo: number[];
public byYearDay: number[];
public byMonthDay: number[];
public byDay: ScheduleDay[];
public byHour: number[];
public byMinute: number[];
public interval: number;
public count: number;
public untilDate: string;
public frequency: SchedulingRuleFrequency;
public constructor(init?: Partial<SchedulingRule>) { (Object as any).assign(this, init); }
}
export class Schedule
{
public timeZoneId: string;
public inherit: boolean;
public forceClosed: boolean;
public rules: SchedulingRule[];
public defaultState: string;
public constructor(init?: Partial<Schedule>) { (Object as any).assign(this, init); }
}
export class ScheduledFlow
{
public stateName: string;
public flowId: string;
public flowParams: Struct;
public constructor(init?: Partial<ScheduledFlow>) { (Object as any).assign(this, init); }
}
export enum TwilioSipRegions
{
NorthAmericaVirginia = 'NorthAmericaVirginia',
NorthAmericaOregon = 'NorthAmericaOregon',
EuropeIreland = 'EuropeIreland',
EuropeFrankfurt = 'EuropeFrankfurt',
AsiaPacificSingapore = 'AsiaPacificSingapore',
AsiaPacificTokyo = 'AsiaPacificTokyo',
AsiaPacificSydney = 'AsiaPacificSydney',
SouthAmericaSanPaolo = 'SouthAmericaSanPaolo',
}
export enum AgentStates
{
Unknown = 'Unknown',
Ready = 'Ready',
NotReady = 'NotReady',
LoggedOut = 'LoggedOut',
WrapUp = 'WrapUp',
Outgoing = 'Outgoing',
Other = 'Other',
}
export enum AgentStateReasons
{
Unknown = 'Unknown',
SetByUser = 'SetByUser',
MissedCall = 'MissedCall',
SetBySystem = 'SetBySystem',
}
export enum UserModes
{
SoftPhone = 'SoftPhone',
Sip = 'Sip',
Flow = 'Flow',
DataOnly = 'DataOnly',
ThirdParty = 'ThirdParty',
}
export enum UserManagerRoles
{
None = 'None',
Manager = 'Manager',
VoicemailAndCallHistory = 'VoicemailAndCallHistory',
Custom = 'Custom',
}
export enum DashboardPermissions
{
ViewFiles = 'ViewFiles',
ViewNotifications = 'ViewNotifications',
ViewSessions = 'ViewSessions',
ViewEndpoints = 'ViewEndpoints',
ViewReports = 'ViewReports',
ViewCustomers = 'ViewCustomers',
ViewFlows = 'ViewFlows',
}
export enum UserDataFieldModes
{
Hidden = 'Hidden',
ReadOnly = 'ReadOnly',
ReadWrite = 'ReadWrite',
}
export enum TagColors
{
Magenta = 'Magenta',
Red = 'Red',
Volcano = 'Volcano',
Orange = 'Orange',
Gold = 'Gold',
Lime = 'Lime',
Green = 'Green',
Cyan = 'Cyan',
Blue = 'Blue',
GeekBlue = 'GeekBlue',
Purple = 'Purple',
}
export class Tag
{
public id: string;
public name: string;
public color: TagColors;
public constructor(init?: Partial<Tag>) { (Object as any).assign(this, init); }
}
export enum ActionUrlHttpMethods
{
GET = 'GET',
POST = 'POST',
}
export class EndpointActionUrl
{
public id: string;
public url: string;
public method: ActionUrlHttpMethods;
public constructor(init?: Partial<EndpointActionUrl>) { (Object as any).assign(this, init); }
}
export enum CustomerVisibility
{
None = 'None',
CurrentCustomer = 'CurrentCustomer',
CurrentAndChildCustomers = 'CurrentAndChildCustomers',
}
export class EndpointContact
{
public id: string;
public displayName: string;
public address: string;
public constructor(init?: Partial<EndpointContact>) { (Object as any).assign(this, init); }
}
export class IntegrationData
{
public thirdPartyId: string;
public constructor(init?: Partial<IntegrationData>) { (Object as any).assign(this, init); }
}
export class Dictionary<T> { [Key: string]: T; }
export class EntityIntegrationData extends Dictionary<IntegrationData>
{
public constructor(init?: Partial<EntityIntegrationData>) { super(); (Object as any).assign(this, init); }
}
export enum ThirdPartyPhoneSystemTypes
{
Demo = 'Demo',
Sip = 'Sip',
}
export enum TransportTypes
{
UDP = 'UDP',
TLS = 'TLS',
TCP = 'TCP',
PERS = 'PERS',
}
export enum AudioCodecTypes
{
PCMU = 0,
GSM = 3,
PCMA = 8,
G722 = 9,
G729 = 18,
ILBC = 97,
AMR = 98,
AMRWB = 99,
SPEEX = 100,
DTMF = 101,
SPEEXWB = 102,
ISACWB = 103,
ISACSWB = 104,
OPUS = 105,
G7221 = 121,
NONE = -1,
}
export enum DtmfMethods
{
RFC2833 = 'RFC2833',
INFO = 'INFO',
}
export class ThirdPartySipAccountSettings
{
public number: string;
public agent: string;
public authName: string;
public userName: string;
public displayName: string;
public password: string;
public userDomain: string;
public registrationExpires: number;
public transportType: TransportTypes;
public localIP: string;
public localPort: number;
public sipServer: string;
public sipServerPort: number;
public outboundServer: string;
public outboundServerPort: number;
public stunServer: string;
public stunPort: number;
public audioPlaybackDeviceName: string;
public audioRecordingDeviceName: string;
public audioCodecs: AudioCodecTypes[];
public dtmfMethod: DtmfMethods;
public constructor(init?: Partial<ThirdPartySipAccountSettings>) { (Object as any).assign(this, init); }
}
export class ThirdPartySipSettings
{
public accounts: ThirdPartySipAccountSettings[];
public constructor(init?: Partial<ThirdPartySipSettings>) { (Object as any).assign(this, init); }
}
export class ThirdPartyDemoSettings
{
public extension: string;
public constructor(init?: Partial<ThirdPartyDemoSettings>) { (Object as any).assign(this, init); }
}
export class ThirdPartyPhoneSystemSettings
{
public type: ThirdPartyPhoneSystemTypes;
public sipSettings: ThirdPartySipSettings;
public demoSettings: ThirdPartyDemoSettings;
public constructor(init?: Partial<ThirdPartyPhoneSystemSettings>) { (Object as any).assign(this, init); }
}
export class AppSettings
{
public enablePhoneNumberManagement: boolean;
public enableDeviceManagement: boolean;
public enableDialer: boolean;
public enableCallHistory: boolean;
public enableAssistants: boolean;
public showFileNameInMessageCenter: boolean;
public chakraTheme: string;
public customCss: string;
public pageTitle: string;
public stringMappings: string;
public logoutUrl: string;
public portMyNumberUrl: string;
public constructor(init?: Partial<AppSettings>) { (Object as any).assign(this, init); }
}
export enum AssistantTunings
{
Accuracy = 'Accuracy',
Speed = 'Speed',
}
export class AssistantWord
{
public word: string;
public pronounced: string;
public constructor(init?: Partial<AssistantWord>) { (Object as any).assign(this, init); }
}
export class AssistantLink
{
public url: string;
public description: string;
public constructor(init?: Partial<AssistantLink>) { (Object as any).assign(this, init); }
}
export enum AssistantTransferTypes
{
Blind = 'Blind',
Supervised = 'Supervised',
MessagesOnly = 'MessagesOnly',
}
export class AssistantTakeMessageField
{
public name: string;
public description: string;
public required: boolean;
public constructor(init?: Partial<AssistantTakeMessageField>) { (Object as any).assign(this, init); }
}
export class AssistantContact
{
public name: string;
public phoneNumber: string;
public transferType: AssistantTransferTypes;
public about: string;
public emailAddress: string;
public takeMessageFields: AssistantTakeMessageField[];
public constructor(init?: Partial<AssistantContact>) { (Object as any).assign(this, init); }
}
export class AssistantIntegration
{
public uri: string;
public httpMethod: string;
public authToken: string;
public constructor(init?: Partial<AssistantIntegration>) { (Object as any).assign(this, init); }
}
export class AssistantSettings
{
public companyName: string;
public greeting: string;
public companyInformation: string;
public customPrompt: string;
public voice: string;
public voiceStyle: string;
public tuning: AssistantTunings;
public words: AssistantWord[];
public links: AssistantLink[];
public contacts: AssistantContact[];
public integrations: AssistantIntegration[];
public constructor(init?: Partial<AssistantSettings>) { (Object as any).assign(this, init); }
}
export class EmbedSettings
{
public enabled: boolean;
public allowedHosts: string;
public constructor(init?: Partial<EmbedSettings>) { (Object as any).assign(this, init); }
}
export class EndpointInfo extends EntityInfo
{
/** @description The account ID this endpoint is associated with */
// @ApiMember(Description="The account ID this endpoint is associated with")
public accountId: string;
/** @description The name of the account this endpoint is associated with */
// @ApiMember(Description="The name of the account this endpoint is associated with")
public accountName: string;
/** @description The ID of the customer this endpoint is associated with */
// @ApiMember(Description="The ID of the customer this endpoint is associated with")
public customerId: string;
/** @description The name of the customer this endpoint is associated with */
// @ApiMember(Description="The name of the customer this endpoint is associated with")
public customerName: string;
/** @description The third party reference ID for the endpoint */
// @ApiMember(Description="The third party reference ID for the endpoint")
public referenceId: string;
/** @description The breadcrumb to the customer for this endpoint */
// @ApiMember(Description="The breadcrumb to the customer for this endpoint")
public customerBreadcrumb: CustomerBreadcrumb[];
/** @description The display name of the endpoint */
// @ApiMember(Description="The display name of the endpoint")
public displayName: string;
/** @description The type of endpoint */
// @ApiMember(Description="The type of endpoint")
public type: EndpointTypes;
/** @description Extra info for this endpoint (typically to show in grid) */
// @ApiMember(Description="Extra info for this endpoint (typically to show in grid)")
public extraInformation: string;
/** @description The ID of the flow to use for voice */
// @ApiMember(Description="The ID of the flow to use for voice")
public flowId: string;
/** @description The name of the flow to use for voice */
// @ApiMember(Description="The name of the flow to use for voice")
public flowName: string;
/** @description The params for the voice flow */
// @ApiMember(Description="The params for the voice flow")
public flowParams: Struct;
/** @description Whether to use a single flow always or use scheduled flow system */
// @ApiMember(Description="Whether to use a single flow always or use scheduled flow system")
public flowSchedule: EndpointFlowSchedules;
/** @description This endpoint's schedule */
// @ApiMember(Description="This endpoint's schedule")
public schedule: Schedule;
/** @description The list of scheduled flows when using scheduling */
// @ApiMember(Description="The list of scheduled flows when using scheduling")
public scheduledFlows: ScheduledFlow[];
/** @description Disable SMS */
// @ApiMember(Description="Disable SMS")
public disableSms: boolean;
/** @description Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number */
// @ApiMember(Description="Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number")
public useExternal10DlcCampaign: boolean;
/** @description Is this a virtual phone number? */
// @ApiMember(Description="Is this a virtual phone number?")
public isVirtualPhoneNumber: boolean;
/** @description Is caller ID verified for this virtual number? */
// @ApiMember(Description="Is caller ID verified for this virtual number?")
public isCallerIdVerified: boolean;
/** @description The verification code for this number */
// @ApiMember(Description="The verification code for this number")
public callerIdVerificationCode: string;
/** @description The phone number */
// @ApiMember(Description="The phone number")
public phoneNumber: string;
/** @description The Sid of the phone number */
// @ApiMember(Description="The Sid of the phone number")
public phoneNumberSid: string;
/** @description The caller ID Name (CNAM) for the phone number */
// @ApiMember(Description="The caller ID Name (CNAM) for the phone number")
public callerIdName: string;
/** @description The address SID associated with the phone number */
// @ApiMember(Description="The address SID associated with the phone number")
public addressSid: string;
/** @description Do not touch this phone number - for BYOA accounts */
// @ApiMember(Description="Do not touch this phone number - for BYOA accounts")
public doNotTouchPhoneNumber: boolean;
/** @description Is this number enrolled in a 10DLC messaging service campaign */
// @ApiMember(Description="Is this number enrolled in a 10DLC messaging service campaign")
public isEnrolledIn10DlcService: boolean;
/** @description Whether we look up caller ID or not */
// @ApiMember(Description="Whether we look up caller ID or not")
public enableCallerIdLookup: boolean;
/** @description The email address of the user */
// @ApiMember(Description="The email address of the user")
public userEmailAddress: string;
/** @description The Twilio Region for the SIP endpoint */
// @ApiMember(Description="The Twilio Region for the SIP endpoint")
public sipRegion: TwilioSipRegions;
/** @description The Twilio Sid of the credentials for Sip */
// @ApiMember(Description="The Twilio Sid of the credentials for Sip")
public sipCredentialSid: string;
/** @description The Twilio SIP user name */
// @ApiMember(Description="The Twilio SIP user name")
public sipUserName: string;
/** @description The Twilio SIP password */
// @ApiMember(Description="The Twilio SIP password")
public sipPassword: string;
/** @description The SIP domain */
// @ApiMember(Description="The SIP domain")
public sipDomain: string;
/** @description Is emergency calling enabled on this number? */
// @ApiMember(Description="Is emergency calling enabled on this number?")
public enableEmergencyCalling: boolean;
/** @description The SID of the emergency address for this number */
// @ApiMember(Description="The SID of the emergency address for this number")
public emergencyAddressSid: string;
/** @description The ID of the phone number to use for emergency dialing */
// @ApiMember(Description="The ID of the phone number to use for emergency dialing")
public emergencyPhoneNumberId: string;
/** @description The current agent state of this user endpoint */
// @ApiMember(Description="The current agent state of this user endpoint")
public agentState: AgentStates;
/** @description The current agent state reason of this user endpoint */
// @ApiMember(Description="The current agent state reason of this user endpoint")
public agentStateReason: AgentStateReasons;
/** @description The mode for this user */
// @ApiMember(Description="The mode for this user")
public userMode: UserModes;
/** @description The ID of the file to use for voicemail greeting */
// @ApiMember(Description="The ID of the file to use for voicemail greeting")
public voicemailGreetingId: string;
/** @description The endpoint's data */
// @ApiMember(Description="The endpoint's data")
public data: Struct;
/** @description The email address for email endpoints */
// @ApiMember(Description="The email address for email endpoints")
public emailAddress: string;
/** @description The first name of the user (for user endpoints) */
// @ApiMember(Description="The first name of the user (for user endpoints)")
public userFirstName: string;
/** @description The last name of the user (for user endpoints) */
// @ApiMember(Description="The last name of the user (for user endpoints)")
public userLastName: string;
/** @description The URL of an image for this user's avatar */
// @ApiMember(Description="The URL of an image for this user's avatar")
public avatarUrl: string;
/** @description Does this user have manager role? */
// @ApiMember(Description="Does this user have manager role?")
public managerRole: UserManagerRoles;
/** @description The list of dashboard permissions for when the manager role is custom */
// @ApiMember(Description="The list of dashboard permissions for when the manager role is custom")
public dashboardPermissions: DashboardPermissions[];
/** @description The type of visibility this user has to their own fields */
// @ApiMember(Description="The type of visibility this user has to their own fields")
public myFieldPermissions: UserDataFieldModes;
/** @description The type of visibility this user has to customer fields */
// @ApiMember(Description="The type of visibility this user has to customer fields")
public customerFieldPermissions: UserDataFieldModes;
/** @description The type of visibility this user has to other user fields */
// @ApiMember(Description="The type of visibility this user has to other user fields")
public otherUserFieldPermissions: UserDataFieldModes;
/** @description The type of visibility this user has to other endpoint fields */
// @ApiMember(Description="The type of visibility this user has to other endpoint fields")
public otherEndpointFieldPermissions: UserDataFieldModes;
/** @description The name of this endpoint (for bots etc.) */
// @ApiMember(Description="The name of this endpoint (for bots etc.)")
public name: string;
/** @description The list of tags for this endpoint */
// @ApiMember(Description="The list of tags for this endpoint")
public tags: Tag[];
/** @description The list of action URLs */
// @ApiMember(Description="The list of action URLs")
public actionUrls: EndpointActionUrl[];
/** @description The list of members in this team */
// @ApiMember(Description="The list of members in this team")
public teamMemberIds: string[];
/** @description Visibility of this user/team in contact lists */
// @ApiMember(Description="Visibility of this user/team in contact lists")
public contactListVisibility: CustomerVisibility;
/** @description The list of contacts personal to this user */
// @ApiMember(Description="The list of contacts personal to this user")
public contacts: EndpointContact[];
/** @description The documo ID for this number */
// @ApiMember(Description="The documo ID for this number")
public documoId: string;
/** @description Integration data for this endpoint */
// @ApiMember(Description="Integration data for this endpoint")
public integrationData: EntityIntegrationData;
/** @description Settings for third party phone system */
// @ApiMember(Description="Settings for third party phone system")
public thirdPartyPhoneSystemSettings: ThirdPartyPhoneSystemSettings;
/** @description Should this user override the parent customer's app settings */
// @ApiMember(Description="Should this user override the parent customer's app settings")
public overrideAppSettings: boolean;
/** @description App / Portal settings for this user */
// @ApiMember(Description="App / Portal settings for this user")
public appSettings: AppSettings;
/** @description Configuration for the AI assistant */
// @ApiMember(Description="Configuration for the AI assistant")
public assistantSettings: AssistantSettings;
/** @description Configuration for the embed */
// @ApiMember(Description="Configuration for the embed")
public embedSettings: EmbedSettings;
public constructor(init?: Partial<EndpointInfo>) { super(init); (Object as any).assign(this, init); }
}
export class AppGetUsers extends ListRequest<EndpointInfo>
{
public accountId: string;
public customerId: string;
public userMode?: UserModes;
public name: string;
public constructor(init?: Partial<AppGetUsers>) { super(init); (Object as any).assign(this, init); }
}
export class BillingItem
{
public baseCost: number;
public rawUnitMultiplier: number;
public unitCost: number;
public allowance: number;
public constructor(init?: Partial<BillingItem>) { (Object as any).assign(this, init); }
}
export class BillingSettings
{
public base: BillingItem;
public localNumbers: BillingItem;
public tollFreeNumbers: BillingItem;
public inboundVoiceCalls: BillingItem;
public outboundVoiceCalls: BillingItem;
public inboundFaxes: BillingItem;
public outboundFaxes: BillingItem;
public inboundSmsMessages: BillingItem;
public outboundSmsMessages: BillingItem;
public aiInsights: BillingItem;
public aiLiveMinutes: BillingItem;
public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}
export class AccountInfo extends EntityInfo
{
/** @description The name of this account */
// @ApiMember(Description="The name of this account")
public name: string;
/** @description The ID of this account's parent */
// @ApiMember(Description="The ID of this account's parent")
public parentAccountId: string;
/** @description The twilio account SID */
// @ApiMember(Description="The twilio account SID")
public twilioAccountSid: string;
/** @description The ancestors of this account. Useful for breadcrumbs */
// @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
public ancestorIds: string[];
/** @description The max number of phone numbers this account can have */
// @ApiMember(Description="The max number of phone numbers this account can have")
public maxPhoneNumbers: number;
/** @description This account is BYOA */
// @ApiMember(Description="This account is BYOA")
public isBYOA: boolean;
/** @description TrustHub Profile Sid */
// @ApiMember(Description="TrustHub Profile Sid")
public trustHubProfileSid: string;
/** @description The ID of the logo file */
// @ApiMember(Description="The ID of the logo file")
public logoId: string;
/** @description The URI of the logo file */
// @ApiMember(Description="The URI of the logo file")
public logoUri: string;
/** @description The billing settings for this account */
// @ApiMember(Description="The billing settings for this account")
public billingSettings: BillingSettings;
public constructor(init?: Partial<AccountInfo>) { super(init); (Object as any).assign(this, init); }
}
export class ListResponse<T>
{
/** @description The items */
// @ApiMember(Description="The items")
public items: AccountInfo[];
/** @description The total number of items */
// @ApiMember(Description="The total number of items")
public totalCount: number;
/** @description The total number of pages */
// @ApiMember(Description="The total number of pages")
public totalPages: number;
/** @description Are there more pages of items? Used with simplified paging */
// @ApiMember(Description="Are there more pages of items? Used with simplified paging")
public hasMorePages: boolean;
public constructor(init?: Partial<ListResponse<T>>) { (Object as any).assign(this, init); }
}
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.
GET /portal/users HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListResponseOfEndpointInfoWeVlXEog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api"> <HasMorePages>false</HasMorePages> <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints"> <d2p1:EndpointInfo> <CreatedBy>String</CreatedBy> <DateCreated>String</DateCreated> <DateLastModified>String</DateLastModified> <Id>String</Id> <LastModifiedBy>String</LastModifiedBy> <d2p1:AccountId>String</d2p1:AccountId> <d2p1:AccountName>String</d2p1:AccountName> <d2p1:ActionUrls> <d2p1:EndpointActionUrl> <d2p1:Id>String</d2p1:Id> <d2p1:Method>GET</d2p1:Method> <d2p1:Url>String</d2p1:Url> </d2p1:EndpointActionUrl> </d2p1:ActionUrls> <d2p1:AddressSid>String</d2p1:AddressSid> <d2p1:AgentState>Unknown</d2p1:AgentState> <d2p1:AgentStateReason>Unknown</d2p1:AgentStateReason> <d2p1:AppSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers"> <d4p1:ChakraTheme>String</d4p1:ChakraTheme> <d4p1:CustomCss>String</d4p1:CustomCss> <d4p1:EnableAssistants>false</d4p1:EnableAssistants> <d4p1:EnableCallHistory>false</d4p1:EnableCallHistory> <d4p1:EnableDeviceManagement>false</d4p1:EnableDeviceManagement> <d4p1:EnableDialer>false</d4p1:EnableDialer> <d4p1:EnablePhoneNumberManagement>false</d4p1:EnablePhoneNumberManagement> <d4p1:LogoutUrl>String</d4p1:LogoutUrl> <d4p1:PageTitle>String</d4p1:PageTitle> <d4p1:PortMyNumberUrl>String</d4p1:PortMyNumberUrl> <d4p1:ShowFileNameInMessageCenter>false</d4p1:ShowFileNameInMessageCenter> <d4p1:StringMappings>String</d4p1:StringMappings> </d2p1:AppSettings> <d2p1:AssistantSettings> <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> </d2p1:AssistantSettings> <d2p1:AvatarUrl>String</d2p1:AvatarUrl> <d2p1:CallerIdName>String</d2p1:CallerIdName> <d2p1:CallerIdVerificationCode>String</d2p1:CallerIdVerificationCode> <d2p1:ContactListVisibility>None</d2p1:ContactListVisibility> <d2p1:Contacts> <d2p1:EndpointContact> <d2p1:Address>String</d2p1:Address> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:Id>String</d2p1:Id> </d2p1:EndpointContact> </d2p1:Contacts> <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:CustomerFieldPermissions>Hidden</d2p1:CustomerFieldPermissions> <d2p1:CustomerId>String</d2p1:CustomerId> <d2p1:CustomerName>String</d2p1:CustomerName> <d2p1:DashboardPermissions xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication"> <d4p1:DashboardPermissions>ViewFiles</d4p1:DashboardPermissions> </d2p1:DashboardPermissions> <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:DisableSms>false</d2p1:DisableSms> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:DoNotTouchPhoneNumber>false</d2p1:DoNotTouchPhoneNumber> <d2p1:DocumoId>String</d2p1:DocumoId> <d2p1:EmailAddress>String</d2p1:EmailAddress> <d2p1:EmbedSettings> <d2p1:AllowedHosts>String</d2p1:AllowedHosts> <d2p1:Enabled>false</d2p1:Enabled> </d2p1:EmbedSettings> <d2p1:EmergencyAddressSid>String</d2p1:EmergencyAddressSid> <d2p1:EmergencyPhoneNumberId>String</d2p1:EmergencyPhoneNumberId> <d2p1:EnableCallerIdLookup>false</d2p1:EnableCallerIdLookup> <d2p1:EnableEmergencyCalling>false</d2p1:EnableEmergencyCalling> <d2p1:ExtraInformation>String</d2p1:ExtraInformation> <d2p1:FlowId>String</d2p1:FlowId> <d2p1:FlowName>String</d2p1:FlowName> <d2p1:FlowParams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:FlowSchedule>Always</d2p1:FlowSchedule> <d2p1:IntegrationData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh> <d4p1:Key>String</d4p1:Key> <d4p1:Value xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations"> <d6p1:ThirdPartyId>String</d6p1:ThirdPartyId> </d4p1:Value> </d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh> </d2p1:IntegrationData> <d2p1:IsCallerIdVerified>false</d2p1:IsCallerIdVerified> <d2p1:IsEnrolledIn10DlcService>false</d2p1:IsEnrolledIn10DlcService> <d2p1:IsVirtualPhoneNumber>false</d2p1:IsVirtualPhoneNumber> <d2p1:ManagerRole>None</d2p1:ManagerRole> <d2p1:MyFieldPermissions>Hidden</d2p1:MyFieldPermissions> <d2p1:Name>String</d2p1:Name> <d2p1:OtherEndpointFieldPermissions>Hidden</d2p1:OtherEndpointFieldPermissions> <d2p1:OtherUserFieldPermissions>Hidden</d2p1:OtherUserFieldPermissions> <d2p1:OverrideAppSettings>false</d2p1:OverrideAppSettings> <d2p1:PhoneNumber>String</d2p1:PhoneNumber> <d2p1:PhoneNumberSid>String</d2p1:PhoneNumberSid> <d2p1:ReferenceId>String</d2p1:ReferenceId> <d2p1:Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling"> <d4p1:DefaultState>String</d4p1:DefaultState> <d4p1:ForceClosed>false</d4p1:ForceClosed> <d4p1:Inherit>false</d4p1:Inherit> <d4p1:Rules> <d4p1:SchedulingRule> <d4p1:ByDay> <d4p1:ScheduleDay> <d4p1:DayOfWeek>Sunday</d4p1:DayOfWeek> <d4p1:Offset>0</d4p1:Offset> </d4p1:ScheduleDay> </d4p1:ByDay> <d4p1:ByHour xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByHour> <d4p1:ByMinute xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMinute> <d4p1:ByMonth xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMonth> <d4p1:ByMonthDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByMonthDay> <d4p1:BySetPosition xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:BySetPosition> <d4p1:ByWeekNo xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByWeekNo> <d4p1:ByYearDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:int>0</d7p1:int> </d4p1:ByYearDay> <d4p1:Condition>String</d4p1:Condition> <d4p1:Count>0</d4p1:Count> <d4p1:CustomerState>String</d4p1:CustomerState> <d4p1:EndTime>String</d4p1:EndTime> <d4p1:FlowId>String</d4p1:FlowId> <d4p1:FlowParams xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d4p1:Frequency>None</d4p1:Frequency> <d4p1:Id>String</d4p1:Id> <d4p1:Interval>0</d4p1:Interval> <d4p1:IsAllDay>false</d4p1:IsAllDay> <d4p1:Name>String</d4p1:Name> <d4p1:Priority>0</d4p1:Priority> <d4p1:SimpleRuleType>Always</d4p1:SimpleRuleType> <d4p1:Source>String</d4p1:Source> <d4p1:StartDate>String</d4p1:StartDate> <d4p1:StartTime>String</d4p1:StartTime> <d4p1:State>String</d4p1:State> <d4p1:UntilDate>String</d4p1:UntilDate> </d4p1:SchedulingRule> </d4p1:Rules> <d4p1:TimeZoneId>String</d4p1:TimeZoneId> </d2p1:Schedule> <d2p1:ScheduledFlows> <d2p1:ScheduledFlow> <d2p1:FlowId>String</d2p1:FlowId> <d2p1:FlowParams xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <d2p1:StateName>String</d2p1:StateName> </d2p1:ScheduledFlow> </d2p1:ScheduledFlows> <d2p1:SipCredentialSid>String</d2p1:SipCredentialSid> <d2p1:SipDomain>String</d2p1:SipDomain> <d2p1:SipPassword>String</d2p1:SipPassword> <d2p1:SipRegion>NorthAmericaVirginia</d2p1:SipRegion> <d2p1:SipUserName>String</d2p1:SipUserName> <d2p1:Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings"> <d4p1:Tag> <d4p1:Color>Magenta</d4p1:Color> <d4p1:Id>String</d4p1:Id> <d4p1:Name>String</d4p1:Name> </d4p1:Tag> </d2p1:Tags> <d2p1:TeamMemberIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:TeamMemberIds> <d2p1:ThirdPartyPhoneSystemSettings> <d2p1:DemoSettings> <d2p1:Extension>String</d2p1:Extension> </d2p1:DemoSettings> <d2p1:SipSettings> <d2p1:Accounts> <d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings> <d2p1:Agent>String</d2p1:Agent> <d2p1:AudioCodecs> <d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes>PCMU</d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.AudioCodecTypes> </d2p1:AudioCodecs> <d2p1:AudioPlaybackDeviceName>String</d2p1:AudioPlaybackDeviceName> <d2p1:AudioRecordingDeviceName>String</d2p1:AudioRecordingDeviceName> <d2p1:AuthName>String</d2p1:AuthName> <d2p1:DTMFMethod>RFC2833</d2p1:DTMFMethod> <d2p1:DisplayName>String</d2p1:DisplayName> <d2p1:LocalIP>String</d2p1:LocalIP> <d2p1:LocalPort>0</d2p1:LocalPort> <d2p1:Number>String</d2p1:Number> <d2p1:OutboundServer>String</d2p1:OutboundServer> <d2p1:OutboundServerPort>0</d2p1:OutboundServerPort> <d2p1:Password>String</d2p1:Password> <d2p1:RegistrationExpires>0</d2p1:RegistrationExpires> <d2p1:SipServer>String</d2p1:SipServer> <d2p1:SipServerPort>0</d2p1:SipServerPort> <d2p1:StunPort>0</d2p1:StunPort> <d2p1:StunServer>String</d2p1:StunServer> <d2p1:TransportType>UDP</d2p1:TransportType> <d2p1:UserDomain>String</d2p1:UserDomain> <d2p1:UserName>String</d2p1:UserName> </d2p1:ThirdPartyPhoneSystemSettings.ThirdPartySipSettings.ThirdPartySipAccountSettings> </d2p1:Accounts> </d2p1:SipSettings> <d2p1:Type>Demo</d2p1:Type> </d2p1:ThirdPartyPhoneSystemSettings> <d2p1:Type>PhoneNumber</d2p1:Type> <d2p1:UseExternal10DlcCampaign>false</d2p1:UseExternal10DlcCampaign> <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress> <d2p1:UserFirstName>String</d2p1:UserFirstName> <d2p1:UserLastName>String</d2p1:UserLastName> <d2p1:UserMode>SoftPhone</d2p1:UserMode> <d2p1:VoicemailGreetingId>String</d2p1:VoicemailGreetingId> </d2p1:EndpointInfo> </Items> <TotalCount>0</TotalCount> <TotalPages>0</TotalPages> </ListResponseOfEndpointInfoWeVlXEog>