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... | |
|
strong |
Agent states enumeration.
|
strong |
|
strong |
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). |
|
strong |
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 |
|
strong |
Phone call states enumeration.
|
strong |
Contact source enumeration.
Enumerator | |
---|---|
Internal | Internal database. |
Salesforce | Salesforce. |
Zendesk | Zendesk. |
RightNow | RightNow. |
|
strong |
|
strong |
Item (interaction) direction enumeration.
Enumerator | |
---|---|
Unknown | Unknown direction. |
Inbound | Inbound item delivered to the user. |
Outbound | Outbound item initiated by the user. |
|
strong |
|
strong |
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. |
|
strong |
Disposition types enumeration. These dispositions can be set for the items by agent.
|
strong |
Interaction types enumeration.
|
strong |
Item states enumeration.
|
strong |
|
strong |
|
strong |
The mode call party is connected to call in.
|
strong |
Call or chat party role.
|
strong |
Softphone type enumeration.
|
strong |
|
strong |
|
strong |
|
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 |
|
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. |
|
strong |
Service media types enumeration.