ADAPI
All Classes Namespaces Functions Enumerations Enumerator Properties Events
Namespaces | Classes | Enumerations
ADAPI Namespace Reference

Classes

class  AgentPlace
 Agent Place class. Derived from AgentSession and provides high level API functionality. More...
 
class  AgentSession
 The agent session class. Manages connection to the server, authentication and transport. The AgentSession objects cannot be instantiated directly, create AgentPlace object instead. More...
 
class  AgentStateReason
 Describes the reason for ACD Not Ready state. More...
 
class  AudioNotification
 Audio notification information. More...
 
class  Call
 The class represents the voice call. More...
 
class  CallParty
 Class described the single party of phone call. More...
 
class  Contact
 Class describes single CRM Contact. More...
 
class  DirectoryCategory
 Class describes the directory category. More...
 
class  DirectoryItem
 Class described a single directory item. More...
 
class  Disposition
 Class describes the item disposition. More...
 
class  Favorite
 Class described a single item in the user's Favorites list. More...
 
class  Item
 Class describes one item (interaction) assigned to the user. This maybe phone call, chat session etc. More...
 
class  ListRecordAddress
 Calling list record address data More...
 
class  ListRecordData
 Calling list record data More...
 
class  PhoneCapabilities
 Class described the capabilities of the phone the user is logged in with. More...
 
class  Recent
 Class describes individual item in Recents list. More...
 
class  Service
 Class describes the Service object. More...
 
class  Team
 Class describes a team of users. More...
 
class  User
 Class describes single user. More...
 
class  UserState
 Describes user's state. More...
 
class  Workitem
 Outbound workitem data More...
 

Enumerations

enum  ResultCode {
  ResultCode.Success = 0, ResultCode.NotAllowed = 1, ResultCode.NogLogged = 2, ResultCode.InvalidArgs = 3,
  ResultCode.LoggedWithoutPhone = 4, ResultCode.Banned = 5, ResultCode.ForcedLogoutByOtherClient = 100, ResultCode.ForcedLogoutBySupervisor = 101,
  ResultCode.InvalidRequest = 102, ResultCode.PhoneNotRegistered = 103, ResultCode.PhoneNotInDialPlan = 104, ResultCode.TenantDisabled = 105,
  ResultCode.DestinationUserNotLogged = 106, ResultCode.UserDisabledOrDeleted = 107, ResultCode.UserAlreadyLoggedIn = 108, ResultCode.InvalidCredentials = 109,
  ResultCode.OtherUserLoggedWithPhone = 110, ResultCode.InvalidToken = 111, ResultCode.LoggedUsersLimitReached = 112, ResultCode.SipServerError = 200,
  ResultCode.UnknownError = 300
}
 Result codes. More...
 
enum  LicenseStatus { LicenseStatus.Valid = 0, LicenseStatus.Demo = 1, LicenseStatus.Invalid = 2 }
 License status. More...
 
enum  Privilege {
  Privilege.Acd = 1001, Privilege.CanViewAgents = 1002, Privilege.CanForceOtherAgentsState = 1003, Privilege.CanMonitorOrRecordCalls = 1004,
  Privilege.CanPullScreen = 1005, Privilege.CanViewQueue = 1006, Privilege.CanUseInternalChat = 1007, Privilege.CanHandleCustomerChats = 1023,
  Privilege.CanHandleEmails = 1037, Privilege.CanHandleLeads = 1047, Privilege.CanHandleSMS = 1033, Privilege.CanOperateCampaigns = 1027,
  Privilege.CanViewDirectory = 1030, Privilege.CanStartRecording = 1032, Privilege.CanStopRecording = 1039, Privilege.CanForcePopOutWindow = 1035,
  Privilege.CanConfigRealtimeMetrics = 1040, Privilege.CanConfigAlerts = 1041, Privilege.CanTransfer = 1042, Privilege.CanMakeExternalCalls = 1043,
  Privilege.CanSeeOtherAgentCases = 1051, Privilege.CanLogIntoAD = 1052, Privilege.CanMaskEmailContent = 1053, Privilege.CanUseRealtimeStatsAPI = 1054,
  Privilege.CanUseZendesk = 1055, Privilege.CanUseRightNow = 1058, Privilege.CanUseFullAD = 1056, Privilege.CanListenCRMLinkedRecordings = 1057,
  Privilege.CanViewAuditLogs = 1008, Privilege.CanConfigureCallCenter = 1009, Privilege.CanConfigureDirectory = 1010, Privilege.CanConfigureUsers = 1011,
  Privilege.CanUpdateUserSkills = 1012, Privilege.CanConfigureCallScenarios = 1013, Privilege.CanListenToCallRecordings = 1014, Privilege.CanConfigureRoles = 1015,
  Privilege.CanConfigurePhones = 1016, Privilege.CanSearchCalls = 1017, Privilege.CanConfigureAllTeams = 1018, Privilege.CanGenerateAndViewReports = 1019,
  Privilege.CanGradeCalls = 1020, Privilege.CanConfigureReportDefinitions = 1022, Privilege.CanSetSystemWideSupervisorAlert = 1021, Privilege.CanSetSystemWideSupervisorRealtimeMetrics = 1045,
  Privilege.CanPublishCannedChatResponses = 1024
}
 User privileges enumeration. More...
 
enum  DisplayNameFormat { DisplayNameFormat.FirstLast = 0, DisplayNameFormat.LastFirst = 1, DisplayNameFormat.LastCommaFirst = 2 }
 Display name format enumeration. More...
 
enum  AudioNotificationType {
  AudioNotificationType.Unknown, AudioNotificationType.CallWaitingInQueue, AudioNotificationType.InternalChat, AudioNotificationType.ExternalChat,
  AudioNotificationType.SoftphoneRing, AudioNotificationType.SoftphoneCallWaiting
}
 Audio notification type enumeration. More...
 
enum  MediaType {
  MediaType.Undefined, MediaType.Voice, MediaType.Chat, MediaType.Preview,
  MediaType.Email
}
 Media types enumeration. More...
 
enum  ContactSource { ContactSource.Internal, ContactSource.Salesforce, ContactSource.Zendesk, ContactSource.RightNow }
 Contact source enumeration. More...
 
enum  CustomerSegment { CustomerSegment.Undefined, CustomerSegment.Bronze, CustomerSegment.Silver, CustomerSegment.Gold }
 Customer segments enumeration. More...
 
enum  InteractionType {
  InteractionType.Undefined, InteractionType.DirectCall, InteractionType.Outbound, InteractionType.Scenario,
  InteractionType.FeaturePlayback, InteractionType.FeatureVoicemail, InteractionType.FeatureRecord, InteractionType.Chat
}
 Interaction types enumeration. More...
 
enum  AgentStateReasonType {
  AgentStateReasonType.Custom, AgentStateReasonType.NoAsnwer, AgentStateReasonType.ConnectionLoss, AgentStateReasonType.Break,
  AgentStateReasonType.LogoutPending
}
 Not Ready reason types enumeration. More...
 
enum  AgentState {
  AgentState.Undefined, AgentState.NotReady, AgentState.Ready, AgentState.Busy,
  AgentState.AfterCallWork
}
 Agent states enumeration. More...
 
enum  PresenceState { PresenceState.Undefined, PresenceState.Available, PresenceState.Away, PresenceState.Offline }
 User presence states enumeration. More...
 
enum  ItemState {
  ItemState.Undefined, ItemState.IVR, ItemState.Queued, ItemState.DeliveryPending,
  ItemState.Delivered, ItemState.Hold, ItemState.WrapUp, ItemState.WrapUpHold,
  ItemState.Preview, ItemState.Completed
}
 Item states enumeration. More...
 
enum  Direction { Direction.Unknown, Direction.Inbound, Direction.Outbound }
 Item (interaction) direction enumeration. More...
 
enum  CallState {
  CallState.Unknown, CallState.Dialing, CallState.Ringing, CallState.Established,
  CallState.Held, CallState.Disconnected
}
 Phone call states enumeration. More...
 
enum  CallDisconnectCause {
  CallDisconnectCause.Normal, CallDisconnectCause.Busy, CallDisconnectCause.DestinationUnknown, CallDisconnectCause.DestinationNotRegistered,
  CallDisconnectCause.Redirect, CallDisconnectCause.Timeout, CallDisconnectCause.DestinationNotInService, CallDisconnectCause.Cancelled,
  CallDisconnectCause.NoAnswer, CallDisconnectCause.Terminated, CallDisconnectCause.NetworkBusy, CallDisconnectCause.InvalidNumber,
  CallDisconnectCause.ServerUnavailable, CallDisconnectCause.Other, CallDisconnectCause.Conferenced
}
 Call disconnect causes enumeration. More...
 
enum  PhoneType {
  PhoneType.Unknown, PhoneType.Phone, PhoneType.Softphone, PhoneType.Scenario,
  PhoneType.DialOut, PhoneType.AccessNumber, PhoneType.Trunk, PhoneType.ScenarioBridge,
  PhoneType.ScenarioFeature
}
 Phone types enumeration. More...
 
enum  PartyRole {
  PartyRole.Party, PartyRole.Supervisor, PartyRole.Scenario, PartyRole.Bridge,
  PartyRole.Conference
}
 Call or chat party role. More...
 
enum  PartyConnectMode { PartyConnectMode.NotConnected, PartyConnectMode.SendOnly, PartyConnectMode.ReceiveOnly, PartyConnectMode.SendReceive }
 The mode call party is connected to call in. More...
 
enum  DispositionType {
  DispositionType.Success, DispositionType.Failure, DispositionType.Continue, DispositionType.DoNotCall,
  DispositionType.Spam
}
 Disposition types enumeration. These dispositions can be set for the items by agent. More...
 
enum  DispositionSystemType {
  DispositionSystemType.CallFailed, DispositionSystemType.RecordExpired, DispositionSystemType.Dropped, DispositionSystemType.Busy,
  DispositionSystemType.NoAnswer, DispositionSystemType.FaxModem, DispositionSystemType.AnsweringMachine, DispositionSystemType.Silence,
  DispositionSystemType.InvalidNumber, DispositionSystemType.OtherConnectionIssue, DispositionSystemType.Abandoned, DispositionSystemType.RemoteCongestion,
  DispositionSystemType.NoAgent, DispositionSystemType.NoDisposition, DispositionSystemType.Skipped, DispositionSystemType.SystemFailure,
  DispositionSystemType.AgentFailure, DispositionSystemType.FinalizedByDialRule, DispositionSystemType.MaxAttemptsReached, DispositionSystemType.DispositionNotFound,
  DispositionSystemType.PhoneNetworkUnavailable, DispositionSystemType.FastBusy, DispositionSystemType.Announcement, DispositionSystemType.NetworkAnnouncement
}
 Disposition system types enumeration. These dispositions are set for the items by the server based on automatic processing of the item. More...
 
enum  ServiceMediaType {
  ServiceMediaType.VoiceInbound, ServiceMediaType.VoiceOutbound, ServiceMediaType.VoiceBlended, ServiceMediaType.Chat,
  ServiceMediaType.Email, ServiceMediaType.Marketing
}
 Service media types enumeration. More...
 
enum  PopupAction { PopupAction.Answer, PopupAction.Hangup, PopupAction.Screen, PopupAction.Nothing }
 Inbound item popup completion actions enumeration. More...
 
enum  PhoneDeviceType {
  PhoneDeviceType.None, PhoneDeviceType.SoftUnsecure, PhoneDeviceType.SoftSecure, PhoneDeviceType.HardDefault,
  PhoneDeviceType.HardCustom, PhoneDeviceType.External, PhoneDeviceType.Nailed
}
 Softphone type enumeration. More...
 

Enumeration Type Documentation

◆ AgentState

enum ADAPI.AgentState
strong

Agent states enumeration.

Enumerator
Undefined 

State is undefined.

NotReady 

Agent is logged in but cannot take interactions from the queue. The reason can be additionally specified.

Ready 

Agent is ready to take interactions from the queue.

Busy 

Agent is busy working with customers.

AfterCallWork 

Agent is doing after call work (completing interaction activity).

◆ AgentStateReasonType

Not Ready reason types enumeration.

Enumerator
Custom 

Custom reason.

NoAsnwer 

The last attempt to deliver the interaction from the queue to an agent failed.

ConnectionLoss 

User's client application lost connection to the server.

Break 

After call break.

LogoutPending 

User session is loggin out.

◆ AudioNotificationType

Audio notification type enumeration.

Enumerator
Unknown 

Unknown.

CallWaitingInQueue 

Call which matches user's skillset is waiting in queue.

InternalChat 

Internal chat incoming.

ExternalChat 

External chat incoming.

SoftphoneRing 

New voice call incoming.

SoftphoneCallWaiting 

New voice call incoming when another voice call is active (call waiting).

◆ CallDisconnectCause

Call disconnect causes enumeration.

Enumerator
Normal 

Normal clearing

Busy 

Destination busy (SIP 486, 603)

DestinationUnknown 

Destination unknown (SIP 404, 604 or dial plan)

DestinationNotRegistered 

Destination not registered (SIP 404)

Redirect 

SIP 301, 302

Timeout 

SIP transaction timeout

DestinationNotInService 

Number not in service (SIP 480)

Cancelled 

Pending outbound call cancelled by client

NoAnswer 

No answer within specified timeout

Terminated 

Answered inbound or outbound call disconnected by server

NetworkBusy 

Network busy (SIP 503)

InvalidNumber 

Invalid number (SIP 404, cause = 1)

ServerUnavailable 
Other 

All other causes

Conferenced 

Call is dropped by SE because peer leg is merged into conference

◆ CallState

enum ADAPI.CallState
strong

Phone call states enumeration.

Enumerator
Unknown 

Unknown state.

Dialing 

Outgbound call is dialing but not answered by destination party yet.

Ringing 

Inbound call is delivered but not answered yet.

Established 

Inbound or outbound call is connected.

Held 

Inbound or outbound call is on hold locally.

Disconnected 

Inbound or outbound call is disconnected.

◆ ContactSource

enum ADAPI.ContactSource
strong

Contact source enumeration.

Enumerator
Internal 

Internal database.

Salesforce 

Salesforce.

Zendesk 

Zendesk.

RightNow 

RightNow.

◆ CustomerSegment

enum ADAPI.CustomerSegment
strong

Customer segments enumeration.

Enumerator
Undefined 

Undefined.

Bronze 

Bronze.

Silver 

Silver.

Gold 

Gold.

◆ Direction

enum ADAPI.Direction
strong

Item (interaction) direction enumeration.

Enumerator
Unknown 

Unknown direction.

Inbound 

Inbound item delivered to the user.

Outbound 

Outbound item initiated by the user.

◆ DisplayNameFormat

Display name format enumeration.

Enumerator
FirstLast 

First name then last name.

LastFirst 

Last name then fitst name.

LastCommaFirst 

Last name then comma then first name.

◆ DispositionSystemType

Disposition system types enumeration. These dispositions are set for the items by the server based on automatic processing of the item.

Enumerator
CallFailed 

Outbound call cannot be initiated.

RecordExpired 

The outbound call record is expired and will not be attempted again.

Dropped 

The call was dropped by customer.

Busy 

The customer's phone is busy.

NoAnswer 

The customer did not answer a call within specified timeout.

FaxModem 

Fas or modem tone was detected.

AnsweringMachine 

Call was answered by answering machine.

Silence 

Call was answered, but no voice was detected.

InvalidNumber 

Call cannot be dialed because the phone network reported number as invalid.

OtherConnectionIssue 

Other (unspecified) phone call failures.

Abandoned 

A call was answered by customer but was abandoned (disconnected) before it was delivered to an agent.

RemoteCongestion 

Outbound call cannot be established because phone network is overloaded.

NoAgent 

The system was unable to find an agent for the item.

NoDisposition 

No specific disposition is set.

Skipped 

Agent chose to skip the item.

SystemFailure 

Other system failure.

AgentFailure 

???

FinalizedByDialRule 

The item was finalized based on dial rules specified in configuration.

MaxAttemptsReached 

The maximum number of attempts of handling the item is exceeded.

DispositionNotFound 

Agent provided disposition which was not found in configuration.

PhoneNetworkUnavailable 

Outbound call cannot be initiated because phone network is unavailable.

FastBusy 

The customer's phone responsed with fast busy tone.

Announcement 

The outbound call was answered by automatic announcement system.

NetworkAnnouncement 

The phone network announcement was detected for outbound call.

◆ DispositionType

enum ADAPI.DispositionType
strong

Disposition types enumeration. These dispositions can be set for the items by agent.

Enumerator
Success 

The item is successfully completed and does not need further processing.

Failure 

The item is unsuccessfully completed and does not need further processing.

Continue 

The attempt is done but item needs further processing.

DoNotCall 

Customer requested to stop calling him.

Spam 

The item is categorized as spam.

◆ InteractionType

enum ADAPI.InteractionType
strong

Interaction types enumeration.

Enumerator
Undefined 

Undefined interaction type.

DirectCall 

Direct (non-scenario) call.

Outbound 

Outbound campaign call.

Scenario 

Inbound scenario.

FeaturePlayback 

Prompt playback feature.

FeatureVoicemail 

Voicemail feature.

FeatureRecord 

Record greeting feature.

Chat 

Chat interaction.

◆ ItemState

enum ADAPI.ItemState
strong

Item states enumeration.

Enumerator
Undefined 

Unknown state.

IVR 

Going through IVR steps.

Queued 

In the queue waiting for the next available agent.

DeliveryPending 

Being delivered to an agent (agent is notified about incoming item but has not accepted it yet).

Delivered 

Delivered to an agent and agent is actively working with it.

Hold 

Delivered to an agent but agent is not actively working with it (call on hold).

WrapUp 

Media part is finished (call disconnected) but agent is actively performing after-call work.

WrapUpHold 

Media part is finished (call disconnected) and agent is holding item for after-call work.

Preview 

Agent is previewing before taking over (reserved for future use).

Completed 

Completed and being destroyed.

◆ LicenseStatus

enum ADAPI.LicenseStatus
strong

License status.

Enumerator
Valid 

Valid license.

Demo 

Demo license.

Invalid 

Unlicensed use.

◆ MediaType

enum ADAPI.MediaType
strong

Media types enumeration.

Enumerator
Undefined 

Undefined media type.

Voice 

Voice media (phone).

Chat 

Web or mobile chat media.

Preview 

Outbound preview media.

Email 

Email media.

◆ PartyConnectMode

The mode call party is connected to call in.

Enumerator
NotConnected 

Party is not connected to the bridge.

SendOnly 

Party is in send only mode (other parties can hear this party, this party cannot hear other parties).

ReceiveOnly 

Party is in receive only mode (this party can hear other parties, other parties can not hear this party).

SendReceive 

Party is in full duplex mode (this party can hear other parties, other parties also can hear this party).

◆ PartyRole

enum ADAPI.PartyRole
strong

Call or chat party role.

Enumerator
Party 

Party is phone or trunk (for call) or person (for chat).

Supervisor 

Party is supervisor monitoring the interaction.

Scenario 

Party is scenario.

Bridge 

Party is bridge.

Conference 

Party is conference link between two bridges (scenarios). Other parties are linked to conference party.

◆ PhoneDeviceType

enum ADAPI.PhoneDeviceType
strong

Softphone type enumeration.

Enumerator
None 

No phone device.

SoftUnsecure 

Default softphone in unsecure mode.

SoftSecure 

Default softphone in secure mode.

HardDefault 

Default hardphone.

HardCustom 

Custom hardphone (phone number should be specified separately).

External 

External phone number (phone number should be specified separately).

Nailed 

Nailed connection.

◆ PhoneType

enum ADAPI.PhoneType
strong

Phone types enumeration.

Enumerator
Unknown 

Unknown type.

Phone 

Hard phone.

Softphone 

Soft phone.

Scenario 

Scenario.

DialOut 

Dial out.

AccessNumber 

Access number.

Trunk 

Trunk.

ScenarioBridge 

Scenario (conference) bridge.

ScenarioFeature 

Internal scenario feature.

◆ PopupAction

enum ADAPI.PopupAction
strong

Inbound item popup completion actions enumeration.

Enumerator
Answer 

User clicked the "Answer" button.

Hangup 

User clicked the "Hangup" button.

Screen 

User clicked the "See Screen" button.

Nothing 

The popup was closed without user's input.

◆ PresenceState

enum ADAPI.PresenceState
strong

User presence states enumeration.

Enumerator
Undefined 

Undefined state.

Available 

User is available.

Away 

User is online but away from hist workplace.

Offline 

User is offline.

◆ Privilege

enum ADAPI.Privilege
strong

User privileges enumeration.

Enumerator
Acd 

Allows to receive interactions from the queue.

CanViewAgents 

Allows supervisor to see other users and their state. Restricted users can only view users in the teams they supervise.

CanForceOtherAgentsState 

Allows supervisor to change state of other agents (force Ready or logout). Restricted users can only force state of users in the teams they supervise.

CanMonitorOrRecordCalls 

Allows supervisor to monitor calls of other users. Restricted users can only monitor/record calls for users in the teams they supervise.

CanPullScreen 

Allows supervisor to pull the screen shown on monitored user’s desktop. Restricted users can only pull screen of users in the teams they supervise.

CanViewQueue 

Allows supervisor to see the status of queues handled by his teams. Restricted users can only view queue metrics for services associated with the teams they supervise.

CanUseInternalChat 

Allows to communicate to other users via chat.

CanHandleCustomerChats 

Allows to receive web chat interactions.

CanHandleEmails 

Allows to receive email interactions.

CanHandleLeads 

Allows to receive sales lead interactions.

CanHandleSMS 

Allows to receive SMS.

CanOperateCampaigns 

Allows to operate outbound campaigns.

CanViewDirectory 

Allows to view directory entries.

CanStartRecording 

Allows to start recording of interactions.

CanStopRecording 

Allows to start recording of interactions.

CanForcePopOutWindow 

???.

CanConfigRealtimeMetrics 

Allows to configure realtime metrics.

CanConfigAlerts 

Allows to configure alerts.

CanTransfer 

Allows to transfer calls.

CanMakeExternalCalls 

Allows to initiate external calls.

CanSeeOtherAgentCases 

Allows to see other agent cases.

CanLogIntoAD 

Allows to log into agent desktop.

CanMaskEmailContent 

Allows to mask email content.

CanUseRealtimeStatsAPI 

Allows to use realtime statistics API.

CanUseZendesk 

Allows to use Zendesk integration.

CanUseRightNow 

Allows to use RightNow integration.

CanUseFullAD 

Allows to use full Agent Desktop.

CanListenCRMLinkedRecordings 

Allows to listen for CRM linked recordings.

CanViewAuditLogs 

Allows user to view Audit Log.

CanConfigureCallCenter 

Allows user to edit settings in Call Center Configuration section.

CanConfigureDirectory 

Allows user to Configure directory.

CanConfigureUsers 

Allows user to create/update/delete users. This includes assigning roles. Users may only assign roles with privileges they possess, except that supervisor may assign role Acd without possessing it. Restricted users can only create users in the teams they supervise. (Note this also implies indirect capability of creating/updating/deleting entries of type softphone in dial plan.)

CanUpdateUserSkills 

Allows user to change other users’ skills. Restricted users may only change skills for users in the teams they supervise.

CanConfigureCallScenarios 

Allows user to create/update/delete call scenarions, as well as change their launch conditions (not this implies capability to create/update/delete dial plan entries of type Scenario).

CanListenToCallRecordings 

Allows user to listen to call recordings. Restricted users may only listen to call recordings of the users in the teams they supervise.

CanConfigureRoles 

Allows user to create/update/delete roles, including those already assigned. Only the person with this privilege may add/edit/delete roles.

CanConfigurePhones 

Allows user to create/update/delete hardphones, dialouts and applications. In addition, it allows pointingexternal numbers to internal numbers.

CanSearchCalls 

Allows user to search to call history. Restricted users may only search and view calls of the users in the teams they supervise.

CanConfigureAllTeams 

Removes restrictions from restricted privileges to supervised teams, its users and associated services. Allows creating teams, assigning users to them and between them.

CanGenerateAndViewReports 

Allow user to generate and view reports. Restricted users may only generate and view reports for users and teams they supervise and their associated services.

CanGradeCalls 

Allows user to grade calls during monitoring and while listening to recordings. Restricted users may only grade calls of the users in the teams they supervise.

CanConfigureReportDefinitions 

Allows user to upload and change report definitions.

CanSetSystemWideSupervisorAlert 

Allows user to propagate realtime display panel threshold settings system-wide.

CanSetSystemWideSupervisorRealtimeMetrics 

???

CanPublishCannedChatResponses 

Allows user to publish standard chat responses system-wide and to edit published responses

◆ ResultCode

enum ADAPI.ResultCode
strong

Result codes.

Enumerator
Success 

Success.

NotAllowed 

The request requires a privilege which is not granted to the logged user.

NogLogged 

API is not logged in.

InvalidArgs 

Invalid argument(s).

LoggedWithoutPhone 

Invalid argument(s).

Banned 

The requested feature is banned by caller.

ForcedLogoutByOtherClient 

Session forcefully logged out from another client.

ForcedLogoutBySupervisor 

Session forcefully logged out by supervisor.

InvalidRequest 

Invalid (unknown) request is sent.

PhoneNotRegistered 

Agent's phone si not registered with the server.

PhoneNotInDialPlan 

The phone number provided during login does not exist in confiruration.

TenantDisabled 

User's tenant is disabled in configuration.

DestinationUserNotLogged 

The user message is sent to is not logged into the system.

UserDisabledOrDeleted 

User is disabled or deleted from configuration.

UserAlreadyLoggedIn 

This use is already logged in.

InvalidCredentials 

Invalid login credentials.

OtherUserLoggedWithPhone 

There is already other user logged with the specified phone number.

InvalidToken 

Token is invalid or expired.

LoggedUsersLimitReached 

Unabled to lo the user because tenant's limit is exceeded.

SipServerError 

Generic SIP server error.

UnknownError 

Unknown error.

◆ ServiceMediaType

Service media types enumeration.

Enumerator
VoiceInbound 

Inbound voice service.

VoiceOutbound 

Outbound voice service.

VoiceBlended 

Blended (inbound and outbound) voice service.

Chat 

Chat service.

Email 

E-mail service.

Marketing 

Marketing (Leads) service.