API
The following operations are supported. For a formal definition, please review the Service Description.
-
assignChannel
Assigns a channel -
cancelAction
Cancels the requested action performed by the administrator. Restores the session to its previous state. -
changeCustomFieldValues
Sets the specified custom field's value for the given session -
closeSession
Closes the selected session -
createGroup
Creates a new node of group -
createUser
Creates a new node of user -
createUsers
Create Person nodes -
deleteNode
Deletes a node from the hierarchy -
generateEmailText
Retrieves the standard email text for the customer -
getAccount
Retrieves the properties of the currently logged-in user and his account -
getAccount_v2
Retrieves the properties of the currently logged-in user and his account -
getChat
Retrieves the chat log of any specific session of the currently logged-in user -
getCurrentUser
Gets informations of the current user -
getDateFormat
Retrieves the format of the Date for reporting -
getDelimiter
Retrieves the delimiter character sequence for text-based output -
getGroup
Gets informations of a node of group type -
getGroup_v2
Gets informations of a node of group type -
getGroup_v3
Gets informations of a node of group type -
getHierarchy
Retrieves the hierarchy of the currently logged-in account -
getHierarchy_v2
Retrieves the hierarchy of the currently logged-in account -
getNote
Retrieves the notes of any specific session of the currently logged-in user -
getOutput
Retrieves the output type for reporting -
getReport
Retrieves the report based on the previously set parameters -
getReportArea
Retrieves the report area -
getReportArea_v2
Retrieves the report area -
getReportArea_v3
Retrieves the report area -
getReportArea_v4
Retrieves the report area -
getReportArea_v5
Retrieves the report area -
getReportArea_v6
Retrieves the report area -
getReportArea_v7
Retrieves the report area -
getReportArea_v8
Retrieves the report area -
getReportArea_v9
Retrieves the report area -
getReportDate
Retrieves the start & end date range of future reports -
getReportDate_v2
Retrieves the start & end date and time range of future reports -
getReportTime
Retrieves the daily time range of future reports -
getReportType
Retrieves the type for reporting -
getReport_v2
Retrieves the report based on the previously set parameters -
getSession
Retrieves the current sessions of any hierarchy node -
getSession_V2
Retrieves the current sessions of any hierarchy node -
getSession_V3
Retrieves the current sessions of any hierarchy node -
getTimezone
Retrieves the deviation, in minutes, from UTC for reporting -
getUser
Gets informations of a node of user type -
getUser_v2
Gets informations of a node of user type -
getUser_v3
Gets informations of a node of user type -
holdSession
Puts the selected session on hold -
isAnyTechAvailableOnChannel
Returns whether a channel has technicians online or not -
login
Authenticates the user -
logout
Logs out the currently logged-in user -
moveNode
Moves a node in the hierarchy to be a child of a target node -
requestAuthCode
Generates an authentication code -
requestAuthCodeSSO
Generates an authentication code for SSO -
requestInvitationLink
Generates a session invitation link and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. -
requestLensPINCode
Generates a Rescue Lens PIN code and sets the custom fields related to a newly generated session -
requestLensPINCodeV2
Generates a Rescue Lens PIN code and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. -
requestLensPINCodeV3
Generates a Rescue Lens PIN code and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. Sends an invitation SMS to the phone number provided. -
requestLensPINCodeV4
Generates a Rescue Lens PIN code and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. Sends an invitation SMS to the phone number provided. -
requestPINCode
Generates a PIN code and sets the custom fields related to a newly generated session -
requestPINCodeV2
Generates a PIN code and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. -
requestPINCodeV3
Generates a PIN code and sets the custom fields related to a newly generated session. Pincode will be zero (left) padded. -
setDateFormat
Sets the format of the Date for reporting -
setDelimiter
Sets the delimiter character sequence for text-based output -
setGroup
Updates a Group node -
setGroup_v2
Updates a Group node -
setGroup_v3
Updates a Group node -
setOutput
Sets the output type for reporting -
setReportArea
Sets the report area -
setReportArea_v2
Sets the report area -
setReportArea_v3
Sets the report area -
setReportArea_v4
Sets the report area -
setReportArea_v5
Sets the report area -
setReportArea_v6
Sets the report area -
setReportArea_v7
Sets the report area -
setReportArea_v8
Sets the report area -
setReportArea_v9
Sets the report area -
setReportDate
Sets the start & end date range of future reports -
setReportDate_v2
Sets the start & end date range of future reports -
setReportTime
Sets the daily time range of future reports -
setReportType
Sets the report type -
setTimezone
Sets the deviation, in minutes, from UTC for reporting -
setUser
Updates a Person node -
setUserStatus_v7_1
Updates a technician's status -
setUser_v2
Updates a Person node -
startSession
Starts the selected session -
transferSession
Transfers the selected session -
unassignChannel
Unassigns a channel