https://portal.smartertools.com:443/Services2/svcCallLogs.asmx

This web service contains methods that add, edit, and delete call logs within SmarterTrack.

Functions
CreateCallLog2	Adds a new call log as if it was added from the management interface.
DeleteCallLog	Deletes an existing call log from SmarterTrack.
GetCallLog	Returns the properties of a single call log.
GetCallLogByGroup	Returns all call logs assigned to a specific group within a given time range.
GetCallLogByUser	Returns all call logs assigned to a specific agent within a given time range.
ModifyCallLog	Modifies the properties of an existing call log.

Depricated: CreateCallLog

CreateCallLog

View the full specification

OBSOLETE: CreateCallLog2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

CreateCallLog2

Adds a new call log as if it was added from the management interface. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`parameters`	String[]	A list of one or more items, in key=value form, to use with the creation of this call log. Subject, GroupID, and UserID are the only required parameters. Keys can be any of the following: Subject PhoneNumber CustomerName EmailAddress Description DateStart DateEnd GroupID UserID IncomingCall - True if item was an incoming call, false if it was outgoing.

Returns CallLogIdResult

CallLogIdResult		Description
`CallLogId`	Int32	The numeric ID of the call log.
`CallNumber`	String	The call number of the call log.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteCallLog

Deletes an existing call log from SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`logID`	Int32	The numeric ID of the call log to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetCallLog

Returns the properties of a single call log. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`logID`	Int32	The numeric ID of the call log for which you wish to retrieve properties.

Returns CallLogInfoResult

CallLogInfoResult		Description
`CallLog`	CallLogInfo	The call log details returned from the function.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CallLogInfo		Description
`AgentID`	Int32	The numeric user ID of an agent to which the call log is assigned.
`CallNumber`	String	The textual identifier of the call (call log number)
`CustomerName`	String	Name of the customer that the call was with.
`DateCreated`	DateTime	The date and time that the call log was created, in GMT.
`DateDeleted`	Nullable<DateTime>	If this field is not null, indicates when the call log was deleted, in GMT. If it is null, the call log is not deleted.
`Description`	String	Full description, or body, of the call log.
`EmailAddress`	String	Email address of the customer.
`EndTime`	DateTime	The date and time that the call ended, in GMT.
`GroupID`	Int32	The numeric group ID to which the call log is assigned.
`IncomingCall`	Boolean	True if the call was inbound. False if the call was outbound.
`LogID`	Int32	The numeric ID of this call log.
`PhoneNumber`	String	The phone number
`StartTime`	DateTime	The date and time that the call started, in GMT.
`Subject`	String	The subject of the call log.

GetCallLogByGroup

Returns all call logs assigned to a specific group within a given time range. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`groupID`	Int32	The numeric ID of the group for which you are retrieving call logs, as defined in the SmarterTrack database or a call to svcOrganization/GetAllGroups.
`dateCreatedStart`	DateTime	The start of the date range to search within.
`dateCreatedEnd`	DateTime	The end of the date range to search within.

Returns CallLogInfoResultArray

CallLogInfoResultArray		Description
`CallLogs`	CallLogInfo[]	The list of call log details returned from the function.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CallLogInfo		Description
`AgentID`	Int32	The numeric user ID of an agent to which the call log is assigned.
`CallNumber`	String	The textual identifier of the call (call log number)
`CustomerName`	String	Name of the customer that the call was with.
`DateCreated`	DateTime	The date and time that the call log was created, in GMT.
`DateDeleted`	Nullable<DateTime>	If this field is not null, indicates when the call log was deleted, in GMT. If it is null, the call log is not deleted.
`Description`	String	Full description, or body, of the call log.
`EmailAddress`	String	Email address of the customer.
`EndTime`	DateTime	The date and time that the call ended, in GMT.
`GroupID`	Int32	The numeric group ID to which the call log is assigned.
`IncomingCall`	Boolean	True if the call was inbound. False if the call was outbound.
`LogID`	Int32	The numeric ID of this call log.
`PhoneNumber`	String	The phone number
`StartTime`	DateTime	The date and time that the call started, in GMT.
`Subject`	String	The subject of the call log.

GetCallLogByUser

Returns all call logs assigned to a specific agent within a given time range. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userID`	Int32	The numeric ID of the user for which you are retrieving call logs, as defined in the SmarterTrack database or a call to svcOrganization/GetAllAgents. The user must have the 'agent' role.
`dateCreatedStart`	DateTime	The start of the date range to search within.
`dateCreatedEnd`	DateTime	The end of the date range to search within.

Returns CallLogInfoResultArray

CallLogInfoResultArray		Description
`CallLogs`	CallLogInfo[]	The list of call log details returned from the function.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CallLogInfo		Description
`AgentID`	Int32	The numeric user ID of an agent to which the call log is assigned.
`CallNumber`	String	The textual identifier of the call (call log number)
`CustomerName`	String	Name of the customer that the call was with.
`DateCreated`	DateTime	The date and time that the call log was created, in GMT.
`DateDeleted`	Nullable<DateTime>	If this field is not null, indicates when the call log was deleted, in GMT. If it is null, the call log is not deleted.
`Description`	String	Full description, or body, of the call log.
`EmailAddress`	String	Email address of the customer.
`EndTime`	DateTime	The date and time that the call ended, in GMT.
`GroupID`	Int32	The numeric group ID to which the call log is assigned.
`IncomingCall`	Boolean	True if the call was inbound. False if the call was outbound.
`LogID`	Int32	The numeric ID of this call log.
`PhoneNumber`	String	The phone number
`StartTime`	DateTime	The date and time that the call started, in GMT.
`Subject`	String	The subject of the call log.

ModifyCallLog

Modifies the properties of an existing call log. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`logID`	Int32	The numeric ID of the call log to modify.
`parameters`	String[]	A list of one or more items, in key=value form, to change in this call log. Keys can be any of the following: Subject PhoneNumber CustomerName EmailAddress Description DateStart DateEnd GroupID UserID IncomingCall - True if item was an incoming call, false if it was outgoing.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

https://portal.smartertools.com:443/Services2/svcChats.asmx

This web service contains methods that add, edit, and delete live chats within SmarterTrack.

WSDL Definition

Functions
AddChatNote	Adds a comment to an existing live chat.
AddChatTimeLog	Adds a time log to a chat.
CloseChatSession	Ends an active live chat session.
EditChatNote	Edits a chat comment.
GetAgentReceivingStatus	Returns the live chat receiving status for the agent specified in 'authUserName'.
GetAgentReceivingStatusAsAdmin	Use admin credentials to Get the Live Chats receiving status for the agent specified with agentUserName.
GetChatAttachments	Returns a list of attachments for a live chat.
GetChatConversation	Retrieves the specified live chat's message transcript.
GetChatCounts_Agent	Retrieves the total number of live chats for the authenticated agent, by brand, department, and group. Credentials passed to this function affect the results.
GetChatCounts_Global	Retrieves the total number of live chats by brand, department, group, and agent. Credentials passed to this function affect the results.
GetChatCustomFields	Returns a list of custom field values from the list of properties provided for the specified chat.
GetChatCustomFieldsList	Returns a list of all custom field properties and values for the specified chat.
GetChatEventHistory	Returns details about the history of actions taken on a specific live chat.
GetChatInfo	Retrieves information about a specific live chat by ID.
GetChatInfoByChatNumber	Retrieves information about a specific live chat by chat number.
GetChatNote	Returns details about a specific live chat comment.
GetChatNotes	Returns a list of comments attached to a specific live chat.
GetChatProperties	Returns a list of requested properties for the chat specified.
GetChatsBySearch	Retrieves a list of chats that match the provided search criteria.
GetChatTimeLog	Returns information about a time log entry within a chat.
GetChatTimeLogs	Gets a list of time logs attached to a chat.
GetCustomFieldControls	Returns the chat custom field template for the provided department.
HandOffActiveChats	Redistributes the live chats of the agent specified in 'authUserName' back to the department queue.
SetAgentReceivingStatus	Sets the receiving status of the agent specified in 'authUserName' for the passed groups.
SetAgentReceivingStatusForAllGroups	Sets the receiving status of all groups for the agent specified in 'authUserName'.
SetAgentReceivingStatusForAllGroupsAsAdmin	Use admin credentials to set the Live Chat receiving status for all groups for the agent with the supplied agentUserName.
SetChatCustomFields	Sets the values of the provided custom fields for the specified chat.
TransferChat	Transfers the specified chat to the group and agent provided.

AddChatNote

Adds a comment to an existing live chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`messageType`	String	The type of comment to add. This value can be any one of the following: Note Resolution TransferNote FollowUp
`noteText`	String	The body text of the comment.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddChatTimeLog

Adds a time log to a chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`subject`	String	The subject of the new time log entry.
`agentID`	Int32	The numeric ID of the agent being assigned to the time log.
`timeLogCategoryID`	Int32	The numeric ID of the time log category.
`description`	String	The body text for the time log.
`dateStartUTC`	DateTime	The date and time of the start of the time log, in GMT.
`dateEndUTC`	DateTime	The date and time of the end of the time log, in GMT.
`isBillable`	Boolean	True if the time log should be counted as billable.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CloseChatSession

Ends an active live chat session. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat to end.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

EditChatNote

Edits a chat comment. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`commentId`	Int32	The numeric ID of the comment.
`chatId`	Int32	The numeric ID of the live chat.
`messageType`	String	The type of comment to add. This value can be any one of the following: Note Resolution TransferNote FollowUp
`noteText`	String	The body text of the comment.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAgentReceivingStatus

Returns the live chat receiving status for the agent specified in 'authUserName'. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ReceivingStatusInfoArrayResult

ReceivingStatusInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`ReceivingStatus`	ReceivingStatusInfo[]	An array of statuses, as defined in the ReceivingStatusInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ReceivingStatusInfo		Description
`DepartmentId`	Int32	The numeric ID of the department.
`DepartmentName`	String	The name of the department.
`GroupId`	Int32	The numeric ID of the group.
`GroupName`	String	The name of the group.
`IsReceiving`	Boolean	True if the user is marked as receiving chats.

GetAgentReceivingStatusAsAdmin

Use admin credentials to Get the Live Chats receiving status for the agent specified with agentUserName. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`agentUserName`	String	Username of the Employee to get status.

Returns ReceivingStatusInfoArrayResult

ReceivingStatusInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`ReceivingStatus`	ReceivingStatusInfo[]	An array of statuses, as defined in the ReceivingStatusInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ReceivingStatusInfo		Description
`DepartmentId`	Int32	The numeric ID of the department.
`DepartmentName`	String	The name of the department.
`GroupId`	Int32	The numeric ID of the group.
`GroupName`	String	The name of the group.
`IsReceiving`	Boolean	True if the user is marked as receiving chats.

GetChatAttachments

Returns a list of attachments for a live chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns ChatAttachmentInfoArrayResult

ChatAttachmentInfoArrayResult		Description
`Files`	ChatAttachmentInfo[]	An array of attachments, as defined in the ChatAttachmentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatAttachmentInfo		Description
`downloadUrl`	String	The full URL that can be used to download the file.
`fileDateUtc`	DateTime	The date and time of the file, in GMT.
`fileId`	Int32	The numerical ID of the file in SmarterTrack.
`fileNameOnDisk`	String	The name of the file as it is saved in the file system by SmarterTrack.
`fileNameOriginal`	String	The name of the file as it was originally attached.
`fileSizeInBytes`	Int64	The size of the file, in bytes.
`sender`	String	The display name of the person who attached the file.
`senderUserId`	Int32	The numerical ID of the user who sent the attachment.

GetChatConversation

Retrieves the specified live chat's message transcript. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns ChatConversationResult

ChatConversationResult		Description
`ConversationListing`	ChatMessageInfo[]	An array of messages defining the conversation, as defined in the ChatMessageInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatMessageInfo		Description
`DateSentUtc`	DateTime	The date and time the message was sent, in GMT.
`FromIdUser`	Int32	The numerical ID of the user that sent the message.
`FromName`	String	The name of the user that sent the message.
`MessageId`	Int64	The numerical ID of the specific chat message.
`MessageText`	String	The body text of the message.
`MessageType`	String	The sender type of message. Can be one of the following: agent system user

GetChatCounts_Agent

Retrieves the total number of live chats for the authenticated agent, by brand, department, and group. Credentials passed to this function affect the results. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ChatCountInfoArrayResult

ChatCountInfoArrayResult		Description
`ChatCounts`	ChatCountInfo[]	An array of chat count details, as defined in the ChatCountInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatCountInfo		Description
`ActiveCount`	Int32	The number of active chats.
`BrandId`	Int32	The numerical ID of the brand.
`DepartmentId`	Int32	The numerical ID of the department.
`GroupId`	Int32	The numerical ID of the group.
`InactiveCount`	Int32	The number of inactive chats.
`UserId`	Int32	The numerical ID of the agent.

GetChatCounts_Global

Retrieves the total number of live chats by brand, department, group, and agent. Credentials passed to this function affect the results. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ChatCountInfoArrayResult

ChatCountInfoArrayResult		Description
`ChatCounts`	ChatCountInfo[]	An array of chat count details, as defined in the ChatCountInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatCountInfo		Description
`ActiveCount`	Int32	The number of active chats.
`BrandId`	Int32	The numerical ID of the brand.
`DepartmentId`	Int32	The numerical ID of the department.
`GroupId`	Int32	The numerical ID of the group.
`InactiveCount`	Int32	The number of inactive chats.
`UserId`	Int32	The numerical ID of the agent.

GetChatCustomFields

Returns a list of custom field values from the list of properties provided for the specified chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`requestedValues`	String[]	A list of custom field display names to retrieve.

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The function output as an array of strings.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetChatCustomFieldsList

Returns a list of all custom field properties and values for the specified chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The function output as an array of strings.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetChatEventHistory

Returns details about the history of actions taken on a specific live chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns ChatEventInfoArrayResult

ChatEventInfoArrayResult		Description
`Events`	ChatEventInfo[]	An array of event definitions, as defined in the ChatEventInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatEventInfo		Description
`Description`	String	The short description of the event.
`Details`	String	Details about the event.
`EventDateUtc`	DateTime	The date and time that the event was fired, in GMT.
`UserTakingAction`	String	The username of the person who caused the event to take place.

GetChatInfo

Retrieves information about a specific live chat by ID. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns ChatInfoResult

ChatInfoResult		Description
`Chat`	ChatInfo	Details about the chat, as defined in the ChatInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatInfo		Description
`ChatNumber`	String	The textual unique identifier of the live chat.
`CustomerDisplayName`	String	The display name for the end user.
`CustomerEmailAddress`	String	The email address of the end user.
`CustomerIp`	String	The IP Address of the end user.
`CustomerLanguage`	String	The language in use for the chat by the end user.
`DateDeletedUtc`	DateTime	If IsDeleted is true, contains the date and time that the chat was deleted, in GMT.
`DateEndedUtc`	DateTime	If IsActive is false, contains the date and time that the chat ended, in GMT.
`DateQueuedUtc`	DateTime	The date and time that the chat entered the system before it was assigned to an agent, in GMT.
`DateStartedUtc`	DateTime	The date and time that the chat started, in GMT.
`ID`	Int32	The numerical ID of the live chat.
`IdAgent`	Int32	The numerical ID of the agent assigned to the live chat.
`IdCustomer`	Int32	The numerical ID of the customer that is the end user for the chat.
`IdDepartment`	Int32	The numerical ID of the department to which the chat is assigned.
`IdGroup`	Int32	The numerical ID of the group to which the chat is assigned.
`IsActive`	Boolean	True if the chat is currently active.
`IsDeleted`	Boolean	True if the chat has been marked as deleted.
`LastReplyDateUtc`	DateTime	The date and time of the last message received for the chat, in GMT.
`ReplyCountIn`	Int32	The number of messages from the end user.
`ReplyCountOut`	Int32	The number of messages from agents.
`SessionLengthInSeconds`	Int32	The number of seconds that the chat has been / was active.

GetChatInfoByChatNumber

Retrieves information about a specific live chat by chat number. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatNumber`	String	The textual chat number that identifies the live chat.

Returns ChatInfoResult

ChatInfoResult		Description
`Chat`	ChatInfo	Details about the chat, as defined in the ChatInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatInfo		Description
`ChatNumber`	String	The textual unique identifier of the live chat.
`CustomerDisplayName`	String	The display name for the end user.
`CustomerEmailAddress`	String	The email address of the end user.
`CustomerIp`	String	The IP Address of the end user.
`CustomerLanguage`	String	The language in use for the chat by the end user.
`DateDeletedUtc`	DateTime	If IsDeleted is true, contains the date and time that the chat was deleted, in GMT.
`DateEndedUtc`	DateTime	If IsActive is false, contains the date and time that the chat ended, in GMT.
`DateQueuedUtc`	DateTime	The date and time that the chat entered the system before it was assigned to an agent, in GMT.
`DateStartedUtc`	DateTime	The date and time that the chat started, in GMT.
`ID`	Int32	The numerical ID of the live chat.
`IdAgent`	Int32	The numerical ID of the agent assigned to the live chat.
`IdCustomer`	Int32	The numerical ID of the customer that is the end user for the chat.
`IdDepartment`	Int32	The numerical ID of the department to which the chat is assigned.
`IdGroup`	Int32	The numerical ID of the group to which the chat is assigned.
`IsActive`	Boolean	True if the chat is currently active.
`IsDeleted`	Boolean	True if the chat has been marked as deleted.
`LastReplyDateUtc`	DateTime	The date and time of the last message received for the chat, in GMT.
`ReplyCountIn`	Int32	The number of messages from the end user.
`ReplyCountOut`	Int32	The number of messages from agents.
`SessionLengthInSeconds`	Int32	The number of seconds that the chat has been / was active.

GetChatNote

Returns details about a specific live chat comment. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`commentId`	Int32	The numeric ID of the comment.

Returns ChatCommentInfoResult

ChatCommentInfoResult		Description
`Comment`	ChatCommentInfo	The comment details, as defined in the ChatCommentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatCommentInfo		Description
`CommentId`	Int32	The numeric ID of the chat comment.
`CreationDateUtc`	DateTime	The date and time that the comment was added, in GMT.
`Description`	String	The body text of the comment.
`Direction`	Int32	This field is currently unused.
`Sender`	String	The username of the person who added the comment.
`Type`	Int32	This indicates the type of comment. Possible values are: 10 - Note 11 - Transfer Note 12 - Resolution

GetChatNotes

Returns a list of comments attached to a specific live chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns ChatCommentInfoArrayResult

ChatCommentInfoArrayResult		Description
`Comments`	ChatCommentInfo[]	An array of comments, as defined in the ChatCommentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatCommentInfo		Description
`CommentId`	Int32	The numeric ID of the chat comment.
`CreationDateUtc`	DateTime	The date and time that the comment was added, in GMT.
`Description`	String	The body text of the comment.
`Direction`	Int32	This field is currently unused.
`Sender`	String	The username of the person who added the comment.
`Type`	Int32	This indicates the type of comment. Possible values are: 10 - Note 11 - Transfer Note 12 - Resolution

GetChatProperties

Returns a list of requested properties for the chat specified. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`requestedValues`	String[]	A list of property keys to retrieve. Keys can be one or more of the following: BrandName CustomerEmailAddress CustomerName CustomerLanguage CustomerIP CustomerUsername DateDeletedUTC DateOpenedUTC DepartmentID GroupID IsDeleted IsIndexed ReplyCountIn ReplyCountOut ChatID ChatNumber IsActive UserID TimeLoggedMinutes

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The function output as an array of strings.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetChatsBySearch

Retrieves a list of chats that match the provided search criteria. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`searchCriteria`	String[]	An array of 'key=value' pairs that indicate the criteria for the search. Possible keys are: SearchString CustomerName DateStartUTC DateEndUTC DepartmentID GroupID IsActive IsDeleted IncludeQueue MaxResults SortOrder ChatNumber UserID

Returns ChatInfoArrayResult

ChatInfoArrayResult		Description
`Chats`	ChatInfo[]	An array of chat details, as defined in the ChatInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ChatInfo		Description
`ChatNumber`	String	The textual unique identifier of the live chat.
`CustomerDisplayName`	String	The display name for the end user.
`CustomerEmailAddress`	String	The email address of the end user.
`CustomerIp`	String	The IP Address of the end user.
`CustomerLanguage`	String	The language in use for the chat by the end user.
`DateDeletedUtc`	DateTime	If IsDeleted is true, contains the date and time that the chat was deleted, in GMT.
`DateEndedUtc`	DateTime	If IsActive is false, contains the date and time that the chat ended, in GMT.
`DateQueuedUtc`	DateTime	The date and time that the chat entered the system before it was assigned to an agent, in GMT.
`DateStartedUtc`	DateTime	The date and time that the chat started, in GMT.
`ID`	Int32	The numerical ID of the live chat.
`IdAgent`	Int32	The numerical ID of the agent assigned to the live chat.
`IdCustomer`	Int32	The numerical ID of the customer that is the end user for the chat.
`IdDepartment`	Int32	The numerical ID of the department to which the chat is assigned.
`IdGroup`	Int32	The numerical ID of the group to which the chat is assigned.
`IsActive`	Boolean	True if the chat is currently active.
`IsDeleted`	Boolean	True if the chat has been marked as deleted.
`LastReplyDateUtc`	DateTime	The date and time of the last message received for the chat, in GMT.
`ReplyCountIn`	Int32	The number of messages from the end user.
`ReplyCountOut`	Int32	The number of messages from agents.
`SessionLengthInSeconds`	Int32	The number of seconds that the chat has been / was active.

GetChatTimeLog

Returns information about a time log entry within a chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`timeLogId`	Int32	The numeric ID of the time log.

Returns TimeLogInfoResult

TimeLogInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`TimeLog`	TimeLogInfo	Details about a time log entry, as defined in the TimeLogInfo class.

TimeLogInfo		Description
`AgentID`	Int32	The numeric ID of the agent assigned to the time log.
`CallLogID`	Int32	The numeric ID of the call log attached to the time log, or 0 if none.
`CategoryName`	String	The display name of the time log category.
`ChatID`	Int32	The numeric ID of the chat attached to the time log, or 0 if none.
`DateEndUTC`	DateTime	The date and time of the end of the time log, in GMT.
`DateStartUTC`	DateTime	The date and time of the start of the time log, in GMT.
`Description`	String	The body text of the time log.
`ID`	Int32	The numeric ID of the time log.
`IsBillable`	Boolean	True if the time log is flagged as billable.
`IsDeleted`	Boolean	True if the time log is flagged as deleted.
`Subject`	String	The subject of the time log.
`TicketID`	Int32	The numeric ID of the ticket attached to the time log, or 0 if none.
`TimeLogCategoryID`	Int32	The numeric ID of the master category for the time log.

GetChatTimeLogs

Gets a list of time logs attached to a chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.

Returns TimeLogInfoArrayResult

TimeLogInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`TimeLogs`	TimeLogInfo[]	A list of time log details, as defined in the TimeLogInfo class.

TimeLogInfo		Description
`AgentID`	Int32	The numeric ID of the agent assigned to the time log.
`CallLogID`	Int32	The numeric ID of the call log attached to the time log, or 0 if none.
`CategoryName`	String	The display name of the time log category.
`ChatID`	Int32	The numeric ID of the chat attached to the time log, or 0 if none.
`DateEndUTC`	DateTime	The date and time of the end of the time log, in GMT.
`DateStartUTC`	DateTime	The date and time of the start of the time log, in GMT.
`Description`	String	The body text of the time log.
`ID`	Int32	The numeric ID of the time log.
`IsBillable`	Boolean	True if the time log is flagged as billable.
`IsDeleted`	Boolean	True if the time log is flagged as deleted.
`Subject`	String	The subject of the time log.
`TicketID`	Int32	The numeric ID of the ticket attached to the time log, or 0 if none.
`TimeLogCategoryID`	Int32	The numeric ID of the master category for the time log.

GetCustomFieldControls

Returns the chat custom field template for the provided department. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`departmentId`	Int32	The numeric ID of the department.

Returns CustomFieldInfoArrayResult

CustomFieldInfoArrayResult		Description
`CustomFields`	CustomFieldInfo[]	An array of custom fields, as defined in the CustomFieldInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CustomFieldInfo		Description
`CustomFieldId`	Int32	The numeric ID of the custom field.
`CustomTemplateId`	Int32	The numeric ID of the custom field template.
`DisplayName`	String	The friendly name fo the custom field.
`IsRequiredByAgents`	Boolean	True if it is required to fill out this custom field before performing an action to an item.
`IsRequiredByAgentsToClose`	Boolean	True if it is required to fill out this custom field before closing an item.
`IsRequiredByUsers`	Boolean	True if it is required to fill out this custom field before an item can be started.
`IsVisibleToAgents`	Boolean	True if the custom field is visible to agents in the custom fields tab.
`IsVisibleToUsers`	Boolean	True if the custom field is visible to end-users in the portal.
`SortOrder`	Int32	The display sort order of this custom field in relation to others.

HandOffActiveChats

Redistributes the live chats of the agent specified in 'authUserName' back to the department queue. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetAgentReceivingStatus

Sets the receiving status of the agent specified in 'authUserName' for the passed groups. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`receivingStatusArr`	ReceivingStatusInfo[]	An array of status to change, as defined in the ReceivingStatusInfo class.

ReceivingStatusInfo		Description
`DepartmentId`	Int32	The numeric ID of the department.
`DepartmentName`	String	The name of the department.
`GroupId`	Int32	The numeric ID of the group.
`GroupName`	String	The name of the group.
`IsReceiving`	Boolean	True if the user is marked as receiving chats.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetAgentReceivingStatusForAllGroups

Sets the receiving status of all groups for the agent specified in 'authUserName'. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`receiveChats`	Boolean	True to enable all groups for chat for the agent. False to disable them.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetAgentReceivingStatusForAllGroupsAsAdmin

Use admin credentials to set the Live Chat receiving status for all groups for the agent with the supplied agentUserName. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`agentUserName`	String	Username of the agent to change status.
`recieveChats`	Boolean

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetChatCustomFields

Sets the values of the provided custom fields for the specified chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat.
`customFieldValues`	String[]	A list of 'name=value' pairs of fields to set. Name is the display name of the custom field to set.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TransferChat

Transfers the specified chat to the group and agent provided. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatId`	Int32	The numeric ID of the live chat to transfer.
`targetGroupID`	Int32	The numeric ID of the group to transfer to.
`targetAgentID`	Int32	The numeric ID of the agent to transfer to.
`transferComment`	String	If specified, adds a transfer comment to the live chat before transferring.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

https://portal.smartertools.com:443/Services2/svcIntegrations.asmx

This web service contains methods that that are used by external integrations, like WHMCS.

WSDL Definition

Functions
WhmcsEnsureUsersCreated	Used by WHMCS to bulk-create users.

WhmcsEnsureUsersCreated

Used by WHMCS to bulk-create users. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`users`	WhmcsEnsureUsersCreatedUserItem[]	A list of property sets for the users to be created.

WhmcsEnsureUsersCreatedUserItem		Description
`DisplayName`	String
`EmailAddress`	String
`IsEmailVerified`	Boolean
`Password`	String
`RolesToAdd`	Int32[]
`Username`	String
`WhmcsUserId`	Int32

Returns WhmcsEnsureUsersCreatedResult

WhmcsEnsureUsersCreatedResult		Description
`Items`	WhmcsEnsureUsersCreatedResultItem[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

WhmcsEnsureUsersCreatedResultItem		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Success`	Boolean
`UserId`	Nullable<Int32>
`Username`	String
`WhmcsUserId`	Int32

https://portal.smartertools.com:443/Services2/svcKB.asmx

This web service contains methods that modify the knowledge base within SmarterTrack.

WSDL Definition

Functions
GetArticle	Retrieves details of a specific knowledge base article.
GetArticles	Retrieves a list of knowledge base articles in the system.
GetFolders	Retrieves a list of knowledge base categories in the system.
SearchKBArticles	Retrieves a list of knowledge base articles in the system using an advanced search.
SearchKBArticlesUnderFolder	Retrieves a list of knowledge base articles under a specific folder using an advanced search.

GetArticle

Retrieves details of a specific knowledge base article. View the full specification

Inputs

Input Parameters		Description
`adminUsername`	String	The username that should be used to call this function. Privacy and draft settings will take into account the username when returning results.
`adminPassword`	String	The password of the user referenced in adminUsername.
`articleID`	Int32	The numerical ID of the article.

Returns KBArticleResult

KBArticleResult		Description
`Body`	String	The body text of the article.
`DateCreatedUTC`	DateTime	The date that the article was created (in GMT).
`DateLastReviewedUTC`	DateTime	The date that the article was last reviewed (in GMT).
`DateModifiedUTC`	DateTime	The date that the article was last modified (in GMT).
`IsDeleted`	Boolean	True if the article is marked as deleted.
`IsDraft`	Boolean	True if the article is marked as a draft.
`IsFlaggedForReview`	Boolean	True if the article is flagged for review.
`IsPrivate`	Boolean	True if the article is private (viewable by employees only).
`KBArticleID`	Int32	The numerical ID of the kb article, as defined in SmarterTrack.
`KBCategoryID`	Int32	The numerical ID of the kb category (folder) that contains this article.
`Language`	String	The Language of the KB Article.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`OtherKeywords`	String	Any other keywords that can be searched upon to return this article.
`OtherVars`	String[]	This variable is reserved for future use.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Score`	Int32	The total score of all the feedback votes on this article.
`ScoreVotes`	Int32	The count of feedback votes on this article.
`ShortSummary`	String	A short description of the article, used in article listings (NOW UNUSED)
`Subject`	String	The subject of the KB article.

GetArticles

Retrieves a list of knowledge base articles in the system. View the full specification

Inputs

Input Parameters		Description
`adminUsername`	String	The username that should be used to call this function. Privacy and draft settings will take into account the username when returning results.
`adminPassword`	String	The password of the user referenced in adminUsername.
`folderID`	Int32	The numerical ID of the folder to list, as defined in the GetFolders function. A value of 0 indicates retrieve all articles in SmarterTrack.
`includePrivate`	Boolean	True to include private articles in the result set. False to exclude them.

Returns KBArticlesResult

KBArticlesResult		Description
`Articles`	KBArticlesResultPart[]	A list of kb article details, as defined in the KBArticlesResultPart class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

KBArticlesResultPart		Description
`BodySnippet`	String	A short snippet of the article or the summary, if one is defined.
`DateCreatedUTC`	DateTime	The DateTimeUTC value of when the article was created.
`DateLastReviewedUTC`	DateTime	The DateTimeUTC value of when the article was last reviewed.
`DateModifiedUTC`	DateTime	The DateTimeUTC value of when the article was last modified.
`IsDeleted`	Boolean	The boolean value for whether the article is deleted or not.
`IsDraft`	Boolean	The boolean value for whether the article is a draft or not.
`IsFlaggedForReview`	Boolean	The boolean value for whether the article is flagged for review or not.
`IsPrivate`	Boolean	The boolean value for whether the article is private or not.
`KBArticleID`	Int32	The numerical ID of the kb article as defined in SmarterTrack.
`KBCategoryID`	Int32	The ID of the Category the article corresponds to.
`Language`	String	The Language of the KB Article.
`Relevance`	Double	The relevance of the search result. Higher values indicate better relevance.
`Score`	Int32	The total score of all the feedback votes on this article.
`ScoreVotes`	Int32	The count of feedback votes on this article.
`Subject`	String	The subject of the kb article.
`Url`	String	The URL of the kb article.

GetFolders

Retrieves a list of knowledge base categories in the system. View the full specification

Inputs

Input Parameters		Description
`adminUsername`	String	The username that should be used to call this function. Privacy and draft settings will take into account the username when returning results.
`adminPassword`	String	The password of the user referenced in adminUsername.
`parentFolderID`	Int32	All folders underneath the one passed in this variable will be listed. Pass 0 to list all folders under the root.

Returns KBFolderResult

KBFolderResult		Description
`Folders`	KBFolderResultPart[]	A list of folder details, as defined in the KBFolderResultPart class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

KBFolderResultPart		Description
`IsPrivate`	Boolean	True if the folder is private (viewable only to employees).
`KbFolderID`	Int32	The numerical ID of the folder.
`Name`	String	The friendly name of the folder.

SearchKBArticles

Retrieves a list of knowledge base articles in the system using an advanced search. View the full specification

Inputs

Input Parameters		Description
`adminUsername`	String	The username that should be used to call this function. Privacy and draft settings will take into account the username when returning results.
`adminPassword`	String	The password of the user referenced in adminUsername.
`searchTerms`	String	The criteria used to perform an advanced search of the system. This field is similar to the search string field when performing an advanced search in the management interface.
`maxResults`	Int32	Maximum number of knowledge base articles returned by this search.
`includePrivate`	Boolean	True to include private articles in the result set. False to exclude them.

Returns KBArticlesResult

KBArticlesResult		Description
`Articles`	KBArticlesResultPart[]	A list of kb article details, as defined in the KBArticlesResultPart class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

KBArticlesResultPart		Description
`BodySnippet`	String	A short snippet of the article or the summary, if one is defined.
`DateCreatedUTC`	DateTime	The DateTimeUTC value of when the article was created.
`DateLastReviewedUTC`	DateTime	The DateTimeUTC value of when the article was last reviewed.
`DateModifiedUTC`	DateTime	The DateTimeUTC value of when the article was last modified.
`IsDeleted`	Boolean	The boolean value for whether the article is deleted or not.
`IsDraft`	Boolean	The boolean value for whether the article is a draft or not.
`IsFlaggedForReview`	Boolean	The boolean value for whether the article is flagged for review or not.
`IsPrivate`	Boolean	The boolean value for whether the article is private or not.
`KBArticleID`	Int32	The numerical ID of the kb article as defined in SmarterTrack.
`KBCategoryID`	Int32	The ID of the Category the article corresponds to.
`Language`	String	The Language of the KB Article.
`Relevance`	Double	The relevance of the search result. Higher values indicate better relevance.
`Score`	Int32	The total score of all the feedback votes on this article.
`ScoreVotes`	Int32	The count of feedback votes on this article.
`Subject`	String	The subject of the kb article.
`Url`	String	The URL of the kb article.

SearchKBArticlesUnderFolder

Retrieves a list of knowledge base articles under a specific folder using an advanced search. View the full specification

Inputs

Input Parameters		Description
`adminUsername`	String	The username that should be used to call this function. Privacy and draft settings will take into account the username when returning results.
`adminPassword`	String	The password of the user referenced in adminUsername.
`searchTerms`	String	The criteria used to perform an advanced search of the system. This field is similar to the search string field when performing an advanced search in the management interface.
`kbFolderID`	Int32	The numerical ID of the folder to list, as defined in the GetFolders function. A value of 0 indicates the root folder.
`maxResults`	Int32	Maximum number of knowledge base articles returned by this search.
`includePrivate`	Boolean	True to include private articles in the result set. False to exclude them.

Returns KBArticlesResult

KBArticlesResult		Description
`Articles`	KBArticlesResultPart[]	A list of kb article details, as defined in the KBArticlesResultPart class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

KBArticlesResultPart		Description
`BodySnippet`	String	A short snippet of the article or the summary, if one is defined.
`DateCreatedUTC`	DateTime	The DateTimeUTC value of when the article was created.
`DateLastReviewedUTC`	DateTime	The DateTimeUTC value of when the article was last reviewed.
`DateModifiedUTC`	DateTime	The DateTimeUTC value of when the article was last modified.
`IsDeleted`	Boolean	The boolean value for whether the article is deleted or not.
`IsDraft`	Boolean	The boolean value for whether the article is a draft or not.
`IsFlaggedForReview`	Boolean	The boolean value for whether the article is flagged for review or not.
`IsPrivate`	Boolean	The boolean value for whether the article is private or not.
`KBArticleID`	Int32	The numerical ID of the kb article as defined in SmarterTrack.
`KBCategoryID`	Int32	The ID of the Category the article corresponds to.
`Language`	String	The Language of the KB Article.
`Relevance`	Double	The relevance of the search result. Higher values indicate better relevance.
`Score`	Int32	The total score of all the feedback votes on this article.
`ScoreVotes`	Int32	The count of feedback votes on this article.
`Subject`	String	The subject of the kb article.
`Url`	String	The URL of the kb article.

https://portal.smartertools.com:443/Services2/svcNotifications.asmx

The notifications Web service is used to manage notifications and alerts that are normally displayed in the management interface. SmarterNotify uses this Web service to communicate with SmarterTrack servers.

WSDL Definition

Functions
DismissAllReminders	Dismiss all active reminders for the specified user.
DismissReminder	Dismiss an active reminder for the specified user.
GetAllReminders	Gets a list of all active reminders for the user specified.
GetNewReminderCount	Get the total number of new reminders available for the specified user.
GetReminder	Gets the active reminder details for the reminder specified by the username.
GetReminderCount	Get the total number of active reminders available for the specified user.
PingService	Pings the web service with the specified credentials to test connectivity.
SnoozeNotification	Snoozes the specified reminder.

DismissAllReminders

Dismiss all active reminders for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DismissReminder

Dismiss an active reminder for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`reminderID`	String	The numeric ID of the reminder to dismiss.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAllReminders

Gets a list of all active reminders for the user specified. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns RemindersResult

RemindersResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Reminders`	ReminderValue[]
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ReminderValue		Description
`ReminderAttributes`	ReminderValuePair[]

ReminderValuePair		Description
`Key`	ReminderAttributes
`OtherKey`	String
`Val`	String

ReminderAttributes Enum
0	ReminderID
1	UserID
2	Subject
3	PhonicSubject
4	CategoryType
5	BodyText
6	SnoozeTimeUTC
7	TimeOccurredUTC
8	Other

GetNewReminderCount

Get the total number of new reminders available for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`lastCheckDateUTC`	String	The last date your program checked for new reminders. Only reminders added since this date are returned.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns IntRequestResult

IntRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResult`	Int32
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetReminder

Gets the active reminder details for the reminder specified by the username. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`reminderID`	String	The numeric ID of the reminder to retrieve.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns ReminderResult

ReminderResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Reminder`	ReminderValue
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ReminderValue		Description
`ReminderAttributes`	ReminderValuePair[]

ReminderValuePair		Description
`Key`	ReminderAttributes
`OtherKey`	String
`Val`	String

ReminderAttributes Enum
0	ReminderID
1	UserID
2	Subject
3	PhonicSubject
4	CategoryType
5	BodyText
6	SnoozeTimeUTC
7	TimeOccurredUTC
8	Other

GetReminderCount

Get the total number of active reminders available for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns IntRequestResult

IntRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResult`	Int32
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

PingService

Pings the web service with the specified credentials to test connectivity. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.

Returns IsAvailableResult

IsAvailableResult		Description
`IsAvailable`	Boolean

SnoozeNotification

Snoozes the specified reminder. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`dataUsername`	String	The user of the account to check. Only system administrators can check accounts other than their own.
`reminderID`	String	The numeric ID of the reminder to snooze.
`snoozeSeconds`	Int32	Number of seconds to snooze.
`customVariables`	InputValue[]	Reserved for future use.

InputValue		Description
`InputAttributes`	InputValuePair[]

InputValuePair		Description
`Key`	String
`Val`	String

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

https://portal.smartertools.com:443/Services2/svcOrganization.asmx

This web service contains methods that modify the configuration of departments, groups, users, etc within SmarterTrack.

WSDL Definition

Functions
AddMemberToOrganization	Adds a member to an Organization.
AddRole	Adds a role to SmarterTrack.
AddRoleToUser	Assigns a role to the specified user.
CreateOrganization	Adds a Organization to SmarterTrack.
CreateUser	Adds a user to SmarterTrack without any roles. Typically, you should follow this function with one or more calls to the AddRoleToUser function.
CreateUser2	Adds a user to SmarterTrack with the Everyone and Registered User roles. Typically, you would follow this function with one or more calls to the AddRoleToUser function.
DeleteUser	Permanently removes an existing user from the system. The primary administrator, queue, and internal system users cannot be removed.
EditOrganization	Edit a Organization in SmarterTrack.
GetActiveChatAgentsForGroup	Returns a list of agents who are marked as active for live chats for the specified group.
GetActiveItemCounts	Get All current Active Item counts for all Active Agents.
GetActiveTicketAgentsForGroup	Returns a list of agents who are actively receiving tickets for the specified group.
GetAgentsForDepartment	Returns a list of all agents in the department specified.
GetAgentsForGroup	Returns a list of agents that are members of the given Group.
GetAllAgents	Retrieves a list of all users marked as agents in SmarterTrack.
GetAllBrands	Returns a list of all Brands defined in SmarterTrack.
GetAllCustomFields	Gets a list of all custom fields in the system.
GetAllDepartments	Returns a list of all departments defined in SmarterTrack.
GetAllGroups	Returns a list of all groups defined in SmarterTrack.
GetAllMembersInOrganization	Gets a list of all Organization Members in an Organization.
GetAllOrganizations	Retrieves a list of Organizations in SmarterTrack.
GetAllReports	Returns a list of all Report GUIDs and their titles.
GetAllRoles	Returns all roles along with their IDs.
GetAllTimeLogCategories	Get a list of all time log categories defined in SmarterTrack.
GetAllUserRoles	Returns all roles of specified user.
GetAvailableChatAgentsForGroup	Returns a list of agents who are actively receiving live chats for the specified group.
GetDailyTotals	Returns Daily counts per User for tickets, chats, call logs, and average response time.
GetDepartmentsForBrand	Returns a list of all Departments for the given Brand.
GetDeptsForUserTicketSubmission	Get All Available Departments where Portal Ticket Submission Requires is set to anonymous or registered users.
GetGroupsForDepartment	Get a list of all Groups for the given Department.
GetGroupsForUser	Returns a list of Groups that the given user belongs to.
GetOrganizationByID	Gets a Organization in SmarterTrack by ID.
GetOrganizationByName	Gets a Organization in SmarterTrack by Name.
GetQueueUser	Returns the user account that is associated with the queue.
GetServerName	Retrieves the friendly name for this installation of SmarterTrack (Used with cross installation ticket transfers).
GetUserCustomFields	Returns a list of custom field values from the list of properties provided for the specified user.
GetUserCustomFieldsList	Returns a list of all custom field properties and values for the specified user.
GetUsersProperties	Retrieves a list of requested properties for a user.
GetUsersPropertiesbyUsername	Retrieves a list of requested properties for a user by username.
RemoveMemberFromOrganization	Remove a Member from an Organization.
RemoveOrganization	Remove an Organization.
RemoveRole	Removes a role from SmarterTrack.
RemoveRoleFromUser	Unassigns a role from a specified user.
SendUserVerificationEmail	Sends a user Verification Email. Typically follows CreateUser if email isnt verified.
SetCallLogPermissions	Sets role permissions for Call Logs.
SetDistributionPermissions	Set role permissions for item distribution (tickets, chats, etc).
SetEventPermissions	Set role permissions for Events.
SetKBPermissions	Sets role permissions for KB Articles.
SetLiveChatPermissions	Sets role permissions for Live Chats.
SetNewsPermissions	Sets role permissions for News Items.
SetReportPermissions	Set role permissions for Reports.
SetTaskPermissions	Sets role permissions for Tasks.
SetTicketPermissions	Sets role permissions for Tickets.
SetUserCustomFields	Sets the values of the provided custom field properties for the specified user.
SetUsersProperties	Sets specific property values of the specified user.
SetWhosOnPermissions	Sets role permissions for Who's On.
ValidateAgent	Validates an agent's credentials.

Depricated: SetManageAreaPermissions

AddMemberToOrganization

Adds a member to an Organization. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationID`	Int32	ID of the Organization to add the member to.
`type`	Int32	How you want to add the member. values are: 1=UserName, 2=Email, 3=Domain, 4=Phone Number
`value`	String	Value of the member type.

Returns OrganizationInfoMemberResult

OrganizationInfoMemberResult		Description
`ID`	Int32	Holds Organization Member ID
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddRole

Adds a role to SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`roleName`	String	The name of the role to add to the system.
`employeeRole`	Boolean	True if the role is intended for use by employees that access the management interface. False if the role is primarily for end users.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddRoleToUser

Assigns a role to the specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userID`	Int32	The numerical ID of the user.
`roleID`	Int16	The numerical ID of the role. These can be found in the st_Roles table.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CreateOrganization

Adds a Organization to SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`values`	String[]	Properties and values you wish to set for the Organization in 'key=value' pairs. Key can be any of the following: Name Website PhoneNumber

Returns OrganizationInfoResult

OrganizationInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organization`	OrganizationInfo	Details about the Organization, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

CreateUser

Adds a user to SmarterTrack without any roles. Typically, you should follow this function with one or more calls to the AddRoleToUser function. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`username`	String	The login username for the user.
`password`	String	The login password for the user.
`email`	String	The email address that should be associated to the user account.
`isEmailVerified`	Boolean	True if the email address should be considered verified.
`displayName`	String	The friendly name of the user (typically their full name).

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CreateUser2

Adds a user to SmarterTrack with the Everyone and Registered User roles. Typically, you would follow this function with one or more calls to the AddRoleToUser function. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`username`	String	The login username for the user.
`password`	String	The login password for the user.
`email`	String	The email address that should be associated to the user account.
`isEmailVerified`	Boolean	True if the email address should be considered verified.
`displayName`	String	The friendly name of the user (typically their full name).

Returns UserInfoResult

UserInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserID`	Int32	Holds user ID

DeleteUser

Permanently removes an existing user from the system. The primary administrator, queue, and internal system users cannot be removed. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

EditOrganization

Edit a Organization in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationID`	Int32	ID of the Organization.
`valuesToChange`	String[]	Properties and values you wish to set for the Organization in 'key=value' pairs. Key can be any of the following: Name Website PhoneNumber

Returns OrganizationInfoResult

OrganizationInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organization`	OrganizationInfo	Details about the Organization, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

GetActiveChatAgentsForGroup

Returns a list of agents who are marked as active for live chats for the specified group. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`GroupID`	Int32	The numerical ID of the group.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetActiveItemCounts

Get All current Active Item counts for all Active Agents. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`useAuthenticatedAgent`	Boolean

Returns ActiveItemArrayResult

ActiveItemArrayResult		Description
`ActiveItems`	ActiveItem[]	An array of ActiveItemResult
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ActiveItem		Description
`ActiveLiveChatsCount`	Int32	Number of Active Live Chats assigned to Corresponding Agent
`ActiveTicketsCount`	Int32	Number of Active Tickets assigned to Corresponding Agent
`Agent`	AgentInfo	Details about the user, as defined in the AgentInfo class.
`InProgressTasksCount`	Int32	Number of Tasks In Progress and assigned to Corresponding Agent

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetActiveTicketAgentsForGroup

Returns a list of agents who are actively receiving tickets for the specified group. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`GroupID`	Int32	The numerical ID of the group.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetAgentsForDepartment

Returns a list of all agents in the department specified. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`DepartmentID`	Int32	The numerical ID of the department. Department IDs are available from the GetAllDepartments function.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetAgentsForGroup

Returns a list of agents that are members of the given Group. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`GroupID`	Int32	The numerical ID of the group. Group IDs are available from the GetAllGroups function.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetAllAgents

Retrieves a list of all users marked as agents in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetAllBrands

Returns a list of all Brands defined in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns BrandInfoArrayResult

BrandInfoArrayResult		Description
`Brands`	BrandInfo[]	A list of details about each brand, as defined in the BrandInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

BrandInfo		Description
`ID`	Int32	The numerical ID of the brand, as defined in SmarterTrack.
`Name`	String	The friendly name of the brand.

GetAllCustomFields

Gets a list of all custom fields in the system. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns CustomFieldInfoArrayResult

CustomFieldInfoArrayResult		Description
`CustomFields`	CustomFieldInfo[]	An array of details about custom fields, as defined in the CustomFieldInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CustomFieldInfo		Description
`DataType`	String	The type of data field used for the custom field. Can be one of the following: SingleLineText MultipleLineText Choice ChoiceWithFillIn Number Date Time DateTime Boolean URL PictureURL
`DefaultValue`	String	The default value for the custom field.
`DisplayName`	String	The display name of the custom field.
`ID`	Int32	The numerical ID of the custom field, as defined in SmarterTrack.
`IsGlobal`	Boolean	True if the field is an organizational custom field, used for departments and users. False if it is specific to individual tickets, chats, etc.
`ValueOptions`	String[]	If DataType is Choice or ChoiceWithFillIn, this contains the possible values that can be chosen from.

GetAllDepartments

Returns a list of all departments defined in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns DepartmentInfoArrayResult

DepartmentInfoArrayResult		Description
`Departments`	DepartmentInfo[]	A list of department details, as defined in the DepartmentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DepartmentInfo		Description
`ID`	Int32	The numerical ID of the department, as defined in SmarterTrack.
`Name`	String	The friendly name for the department.

GetAllGroups

Returns a list of all groups defined in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns GroupInfoArrayResult

GroupInfoArrayResult		Description
`Groups`	GroupInfo[]	A list of details about the groups, as defined in the GroupInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GroupInfo		Description
`ID`	Int32	The numerical ID of the group, as defined in SmarterTrack.
`Name`	String	The friendly name of the group.

GetAllMembersInOrganization

Gets a list of all Organization Members in an Organization. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationID`	Int32	ID of the Organization to get Organization Members from.

Returns OrganizationMemberInfoArrayResult

OrganizationMemberInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`OrganizationMembers`	OrganizationMemberInfo[]	An array of details about the organization member, as defined in the OrganizationMemberInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationMemberInfo		Description
`ID`	Int32	The ID of the Organization Member.
`Type`	Int32	The type of field used for the member. Can be one of the following: 1 = UserName 2 = Email 3 = Domain 4 = Phone Number
`Value`	String	Value of the Organization Member.

GetAllOrganizations

Retrieves a list of Organizations in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns OrganizationInfoArrayResult

OrganizationInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organizations`	OrganizationInfo[]	A list of organization detail records, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

GetAllReports

Returns a list of all Report GUIDs and their titles. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ReportInfoResultArray

ReportInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Reports`	ReportInfo[]	A list of details about the reports, as defined in the ReportInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ReportInfo		Description
`ReportID`	String	The numerical ID of the report, as defined in SmarterTrack.
`ReportName`	String	The friendly name of the report.

GetAllRoles

Returns all roles along with their IDs. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns RoleInfoResultArray

RoleInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Roles`	RoleInfo[]	A list of role details, as defined in the RoleInfo class.

RoleInfo		Description
`IsEmployee`	Boolean	True if the role is used for employees. False if the role is used for end users.
`RoleID`	Int16	The numerical ID of the role, as defined in SmarterTrack.
`RoleName`	String	The friendly name for the role.

GetAllTimeLogCategories

Get a list of all time log categories defined in SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns TimeLogCategoryInfoArrayResult

TimeLogCategoryInfoArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`TimeLogCategories`	TimeLogCategoryInfo[]	A list of time log category details, as defined in the TimeLogCategoryInfo class.

TimeLogCategoryInfo		Description
`CategoryName`	String	The friendly name of the time log category.
`Description`	String	A description of the time log category.
`ID`	Int32	The numerical ID of the time log category, as defined in SmarterTrack.

GetAllUserRoles

Returns all roles of specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userID`	Int32	The numerical ID of the user.

Returns RoleInfoResultArray

RoleInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Roles`	RoleInfo[]	A list of role details, as defined in the RoleInfo class.

RoleInfo		Description
`IsEmployee`	Boolean	True if the role is used for employees. False if the role is used for end users.
`RoleID`	Int16	The numerical ID of the role, as defined in SmarterTrack.
`RoleName`	String	The friendly name for the role.

GetAvailableChatAgentsForGroup

Returns a list of agents who are actively receiving live chats for the specified group. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`GroupID`	Int32	The numerical ID of the group.

Returns AgentInfoArrayResult

AgentInfoArrayResult		Description
`Agents`	AgentInfo[]	A list of agent detail records, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetDailyTotals

Returns Daily counts per User for tickets, chats, call logs, and average response time. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`useAuthenticatedUser`	Boolean

Returns DailyStatItemArrayResult

DailyStatItemArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`StatItems`	DailyStatItem[]	An array of DailyStatItems

DailyStatItem		Description
`Agent`	AgentInfo	Details about the user, as defined in the AgentInfo class.
`AverageTicketResponseTime`	Double	Average ticket response time for a Corresponding Agent for a given day
`DailyCallLogCount`	Int32	Number of new Call Logs assigned to Corresponding Agent for a given day
`DailyChatCount`	Int32	Number of new Live Chats assigned to Corresponding Agent for a given day
`DailyTicketCount`	Int32	Number of new Tickets assigned to Corresponding Agent for a given day

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetDepartmentsForBrand

Returns a list of all Departments for the given Brand. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`BrandID`	Int32	The numerical ID of the brand. A list of all brand IDs can be obtained from the GetAllBrands function.

Returns DepartmentInfoArrayResult

DepartmentInfoArrayResult		Description
`Departments`	DepartmentInfo[]	A list of department details, as defined in the DepartmentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DepartmentInfo		Description
`ID`	Int32	The numerical ID of the department, as defined in SmarterTrack.
`Name`	String	The friendly name for the department.

GetDeptsForUserTicketSubmission

Get All Available Departments where Portal Ticket Submission Requires is set to anonymous or registered users. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns DepartmentInfoArrayResult

DepartmentInfoArrayResult		Description
`Departments`	DepartmentInfo[]	A list of department details, as defined in the DepartmentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DepartmentInfo		Description
`ID`	Int32	The numerical ID of the department, as defined in SmarterTrack.
`Name`	String	The friendly name for the department.

GetGroupsForDepartment

Get a list of all Groups for the given Department. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`DepartmentID`	Int32	The numerical ID of the department. Department IDs are available from the GetAllDepartments function.

Returns GroupInfoArrayResult

GroupInfoArrayResult		Description
`Groups`	GroupInfo[]	A list of details about the groups, as defined in the GroupInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GroupInfo		Description
`ID`	Int32	The numerical ID of the group, as defined in SmarterTrack.
`Name`	String	The friendly name of the group.

GetGroupsForUser

Returns a list of Groups that the given user belongs to. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`UserID`	Int32	The numerical ID of the user.

Returns GroupInfoArrayResult

GroupInfoArrayResult		Description
`Groups`	GroupInfo[]	A list of details about the groups, as defined in the GroupInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GroupInfo		Description
`ID`	Int32	The numerical ID of the group, as defined in SmarterTrack.
`Name`	String	The friendly name of the group.

GetOrganizationByID

Gets a Organization in SmarterTrack by ID. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationID`	Int32	ID of the Organization.

Returns OrganizationInfoResult

OrganizationInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organization`	OrganizationInfo	Details about the Organization, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

GetOrganizationByName

Gets a Organization in SmarterTrack by Name. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationName`	String

Returns OrganizationInfoResult

OrganizationInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organization`	OrganizationInfo	Details about the Organization, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

GetQueueUser

Returns the user account that is associated with the queue. View the full specification

Inputs

Input Parameters		Description
`agentUserName`	String	The username for an agent authorized to call this function.
`agentPassword`	String	The password for the agent.

Returns AgentRoleInfo

AgentRoleInfo		Description
`Agent`	AgentInfo	Details about the user, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Roles`	Int16[]	A list of role names that the agent belongs to.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

GetServerName

Retrieves the friendly name for this installation of SmarterTrack (Used with cross installation ticket transfers). View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns StringRequestResult

StringRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResult`	String	The output of the function call as a string.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetUserCustomFields

Returns a list of custom field values from the list of properties provided for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user.
`requestedCustomFields`	String[]	The names of custom fields to retrieve for the user, as returned by the function GetAllCustomFields

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The output of the function call, as a string array.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetUserCustomFieldsList

Returns a list of all custom field properties and values for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user.

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The output of the function call, as a string array.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetUsersProperties

Retrieves a list of requested properties for a user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user.
`requestedValues`	String[]	The names of the properties you wish to inspect. This can contain one or more of the following: Username Password Email IsEmailVerified DisplayName DisplayNameForChat AvatarUrl TimeZoneIndex AuthenticationType ActiveDirectoryDomain DateLastLogin

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The output of the function call, as a string array.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetUsersPropertiesbyUsername

Retrieves a list of requested properties for a user by username. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`username`	String	The username and password of the user.
`requestedValues`	String[]	The names of the properties you wish to inspect. This can contain one or more of the following: Username Password Email IsEmailVerified DisplayName DisplayNameForChat TimeZoneIndex userid AuthenticationType ActiveDirectoryDomain DateLastLogin

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResults`	String[]	The output of the function call, as a string array.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveMemberFromOrganization

Remove a Member from an Organization. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationMemberID`	Int32	ID of the Organization member to remove.

Returns OrganizationInfoMemberResult

OrganizationInfoMemberResult		Description
`ID`	Int32	Holds Organization Member ID
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveOrganization

Remove an Organization. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`organizationID`	Int32	ID of the Organization to remove.

Returns OrganizationInfoResult

OrganizationInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Organization`	OrganizationInfo	Details about the Organization, as defined in the OrganizationInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

OrganizationInfo		Description
`Name`	String	Name of the Organization.
`OrganizationID`	Int32	The ID of the Organization.
`PhoneNumber`	String	Phone Number of the Organization.
`Website`	String	Website of the Organization.

RemoveRole

Removes a role from SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`roleID`	Int16	The numerical ID of the role to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveRoleFromUser

Unassigns a role from a specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userID`	Int32	The numerical ID of the user.
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SendUserVerificationEmail

Sends a user Verification Email. Typically follows CreateUser if email isnt verified. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user to send Verification Email.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetCallLogPermissions

Sets role permissions for Call Logs. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Create Modify Delete View
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDistributionPermissions

Set role permissions for item distribution (tickets, chats, etc). View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Transfer AgentTransfer AgentStatus
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetEventPermissions

Set role permissions for Events. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Manage
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetKBPermissions

Sets role permissions for KB Articles. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Create Modify Delete MarkReviewed View
`roleID`	Int16	The numerical ID of the role.
`categoryID`	Int32	The numerical ID of the KB Category.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetLiveChatPermissions

Sets role permissions for Live Chats. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: InstantMessages ChatRooms CreateChatRooms ViewQueue
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetManageAreaPermissions

Set role permissions for Management Area. This function has no effect. View the full specification

OBSOLETE: Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

SetNewsPermissions

Sets role permissions for News Items. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Create Modify Delete MarkReviewed View
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetReportPermissions

Set role permissions for Reports. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are the Guids of reports in the system, as returned by the GetAllReports function, or as listed in the top of its definition file in the App_Data folder.
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetTaskPermissions

Sets role permissions for Tasks. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: Create Modify Delete View ChangeDates
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetTicketPermissions

Sets role permissions for Tickets. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: MarkAsDeleted ViewQueue
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetUserCustomFields

Sets the values of the provided custom field properties for the specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user to modify.
`customFieldValues`	String[]	The custom fields to set for the user, formatted as 'key=value' pairs. Key should be the name of the custom field, as returned by the function GetAllCustomFields.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetUsersProperties

Sets specific property values of the specified user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userId`	Int32	The numerical ID of the user.
`userPropertyValues`	String[]	Properties and values you wish to set for the user in 'key=value' pairs. Key can be any of the following: Username Password ForcePasswordReset Email IsEmailVerified DisplayName DisplayNameForChat AvatarSource AuthenticationType 0: Password 1: Active Directory 2: External Login Provider ActiveDirectoryDomain

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetWhosOnPermissions

Sets role permissions for Who's On. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`allowedPermissions`	String[]	A list of permissions that are allowed by this role. Possible values are: View
`roleID`	Int16	The numerical ID of the role.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ValidateAgent

Validates an agent's credentials. View the full specification

Inputs

Input Parameters		Description
`agentUserName`	String	The username for an agent.
`agentPassword`	String	The password for the agent.

Returns AgentRoleInfo

AgentRoleInfo		Description
`Agent`	AgentInfo	Details about the user, as defined in the AgentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Roles`	Int16[]	A list of role names that the agent belongs to.

AgentInfo		Description
`DisplayName`	String	The display name for the user.
`ID`	Int32	The numerical ID of the user, as defined in the SmarterTrack database.
`UserName`	String	The login username for the user.

https://portal.smartertools.com:443/Services2/svcTasks.asmx

This web service contains methods that add, edit, or delete tasks within SmarterTrack.

WSDL Definition

Functions
CreateTask	Adds a new task as if it was added from the management interface.
DeleteTask	Deletes a task from SmarterTrack.
GetTaskByID	Retrieves details about a specific task.
GetTasksByCallLogID	Returns a list of all tasks associated to a specified call log.
GetTasksByChatID	Returns a list of all tasks associated to a specified live chat.
GetTasksByTicketID	Returns a list of all tasks associated to a specified ticket.
GetTasksByUser	Returns a list of all tasks assigned to a specified agent.
UpdateTask	Modifies the properties of an existing task.

CreateTask

Adds a new task as if it was added from the management interface. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`parameters`	String[]	A list of 'key=value' pairs of data items to set for the new task. Subject is a required key. The possible keys that can be submitted to this function are: Subject TaskPriority TaskStatus UserID Description DateStart DateEnd ReminderMinutes RelatedItem

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteTask

Deletes a task from SmarterTrack. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`taskID`	Int32	The numeric ID of the task.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetTaskByID

Retrieves details about a specific task. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`taskID`	Int32	The numeric ID of the task.

Returns TaskInfoResult

TaskInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Task`	TaskInfo	Details about a task, as defined in the TaskInfo class.

TaskInfo		Description
`CallLogID`	Nullable<Int32>	If set, the numeric ID of the call log to which this task is assigned.
`ChatID`	Nullable<Int32>	If set, the numeric ID of the chat to which this task is assigned.
`DateDue`	Nullable<DateTime>	If set, the date and time that the task is due, in GMT.
`DateStart`	Nullable<DateTime>	If set, the date and time that the task starts, in GMT.
`Description`	String	The body text of the task.
`OriginalEstimate`	Nullable<Int32>	If set, the original estimate of time that relates to the corresponding estimate type
`OriginalEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of original estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`RemainingEstimate`	Nullable<Int32>	If set, the remaining estimate of time that relates to the corresponding estimate type
`RemainingEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of remainging estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`ReminderMinutes`	Nullable<Int32>	If set, the number of minutes before the task is due that a reminder will be triggered.
`Subject`	String	The subject of the task.
`TaskID`	Int32	The numeric ID of the task within SmarterStats.
`TaskPriorityID`	Int32	The numeric ID of the priority for the task. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`TaskStatusID`	Int32	The numeric ID of the status for the task. Default status IDs are: 1 = Active (No Longer Supported) 2 = Closed (No Longer Supported) 3 = Under Consideration 4 = In Progress 5 = On Hold 6 = In Review 7 = Completed 8 = Rejected 9 = Approved
`TicketID`	Nullable<Int32>	If set, the numeric ID of the ticket to which this task is assigned.
`UserID`	Nullable<Int32>	If set, the numeric ID of the agent assigned to the task.

GetTasksByCallLogID

Returns a list of all tasks associated to a specified call log. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`callLogID`	Int32	The numeric ID of the call log.

Returns TaskInfoResultArray

TaskInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Tasks`	TaskInfo[]	A list of task details, as defined in the TaskInfo class.

TaskInfo		Description
`CallLogID`	Nullable<Int32>	If set, the numeric ID of the call log to which this task is assigned.
`ChatID`	Nullable<Int32>	If set, the numeric ID of the chat to which this task is assigned.
`DateDue`	Nullable<DateTime>	If set, the date and time that the task is due, in GMT.
`DateStart`	Nullable<DateTime>	If set, the date and time that the task starts, in GMT.
`Description`	String	The body text of the task.
`OriginalEstimate`	Nullable<Int32>	If set, the original estimate of time that relates to the corresponding estimate type
`OriginalEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of original estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`RemainingEstimate`	Nullable<Int32>	If set, the remaining estimate of time that relates to the corresponding estimate type
`RemainingEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of remainging estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`ReminderMinutes`	Nullable<Int32>	If set, the number of minutes before the task is due that a reminder will be triggered.
`Subject`	String	The subject of the task.
`TaskID`	Int32	The numeric ID of the task within SmarterStats.
`TaskPriorityID`	Int32	The numeric ID of the priority for the task. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`TaskStatusID`	Int32	The numeric ID of the status for the task. Default status IDs are: 1 = Active (No Longer Supported) 2 = Closed (No Longer Supported) 3 = Under Consideration 4 = In Progress 5 = On Hold 6 = In Review 7 = Completed 8 = Rejected 9 = Approved
`TicketID`	Nullable<Int32>	If set, the numeric ID of the ticket to which this task is assigned.
`UserID`	Nullable<Int32>	If set, the numeric ID of the agent assigned to the task.

GetTasksByChatID

Returns a list of all tasks associated to a specified live chat. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`chatID`	Int32	The numeric ID of the live chat.

Returns TaskInfoResultArray

TaskInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Tasks`	TaskInfo[]	A list of task details, as defined in the TaskInfo class.

TaskInfo		Description
`CallLogID`	Nullable<Int32>	If set, the numeric ID of the call log to which this task is assigned.
`ChatID`	Nullable<Int32>	If set, the numeric ID of the chat to which this task is assigned.
`DateDue`	Nullable<DateTime>	If set, the date and time that the task is due, in GMT.
`DateStart`	Nullable<DateTime>	If set, the date and time that the task starts, in GMT.
`Description`	String	The body text of the task.
`OriginalEstimate`	Nullable<Int32>	If set, the original estimate of time that relates to the corresponding estimate type
`OriginalEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of original estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`RemainingEstimate`	Nullable<Int32>	If set, the remaining estimate of time that relates to the corresponding estimate type
`RemainingEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of remainging estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`ReminderMinutes`	Nullable<Int32>	If set, the number of minutes before the task is due that a reminder will be triggered.
`Subject`	String	The subject of the task.
`TaskID`	Int32	The numeric ID of the task within SmarterStats.
`TaskPriorityID`	Int32	The numeric ID of the priority for the task. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`TaskStatusID`	Int32	The numeric ID of the status for the task. Default status IDs are: 1 = Active (No Longer Supported) 2 = Closed (No Longer Supported) 3 = Under Consideration 4 = In Progress 5 = On Hold 6 = In Review 7 = Completed 8 = Rejected 9 = Approved
`TicketID`	Nullable<Int32>	If set, the numeric ID of the ticket to which this task is assigned.
`UserID`	Nullable<Int32>	If set, the numeric ID of the agent assigned to the task.

GetTasksByTicketID

Returns a list of all tasks associated to a specified ticket. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketID`	Int32	The numeric ID of the ticket.

Returns TaskInfoResultArray

TaskInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Tasks`	TaskInfo[]	A list of task details, as defined in the TaskInfo class.

TaskInfo		Description
`CallLogID`	Nullable<Int32>	If set, the numeric ID of the call log to which this task is assigned.
`ChatID`	Nullable<Int32>	If set, the numeric ID of the chat to which this task is assigned.
`DateDue`	Nullable<DateTime>	If set, the date and time that the task is due, in GMT.
`DateStart`	Nullable<DateTime>	If set, the date and time that the task starts, in GMT.
`Description`	String	The body text of the task.
`OriginalEstimate`	Nullable<Int32>	If set, the original estimate of time that relates to the corresponding estimate type
`OriginalEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of original estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`RemainingEstimate`	Nullable<Int32>	If set, the remaining estimate of time that relates to the corresponding estimate type
`RemainingEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of remainging estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`ReminderMinutes`	Nullable<Int32>	If set, the number of minutes before the task is due that a reminder will be triggered.
`Subject`	String	The subject of the task.
`TaskID`	Int32	The numeric ID of the task within SmarterStats.
`TaskPriorityID`	Int32	The numeric ID of the priority for the task. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`TaskStatusID`	Int32	The numeric ID of the status for the task. Default status IDs are: 1 = Active (No Longer Supported) 2 = Closed (No Longer Supported) 3 = Under Consideration 4 = In Progress 5 = On Hold 6 = In Review 7 = Completed 8 = Rejected 9 = Approved
`TicketID`	Nullable<Int32>	If set, the numeric ID of the ticket to which this task is assigned.
`UserID`	Nullable<Int32>	If set, the numeric ID of the agent assigned to the task.

GetTasksByUser

Returns a list of all tasks assigned to a specified agent. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`userID`	Int32	The numeric ID of the agent.

Returns TaskInfoResultArray

TaskInfoResultArray		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Tasks`	TaskInfo[]	A list of task details, as defined in the TaskInfo class.

TaskInfo		Description
`CallLogID`	Nullable<Int32>	If set, the numeric ID of the call log to which this task is assigned.
`ChatID`	Nullable<Int32>	If set, the numeric ID of the chat to which this task is assigned.
`DateDue`	Nullable<DateTime>	If set, the date and time that the task is due, in GMT.
`DateStart`	Nullable<DateTime>	If set, the date and time that the task starts, in GMT.
`Description`	String	The body text of the task.
`OriginalEstimate`	Nullable<Int32>	If set, the original estimate of time that relates to the corresponding estimate type
`OriginalEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of original estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`RemainingEstimate`	Nullable<Int32>	If set, the remaining estimate of time that relates to the corresponding estimate type
`RemainingEstimateType`	Nullable<Int32>	If set, the Numeric ID of the type of remainging estimate, Default Type IDs are: 1 = Minutes 2 = Hours 3 = Days 4 = Weeks
`ReminderMinutes`	Nullable<Int32>	If set, the number of minutes before the task is due that a reminder will be triggered.
`Subject`	String	The subject of the task.
`TaskID`	Int32	The numeric ID of the task within SmarterStats.
`TaskPriorityID`	Int32	The numeric ID of the priority for the task. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`TaskStatusID`	Int32	The numeric ID of the status for the task. Default status IDs are: 1 = Active (No Longer Supported) 2 = Closed (No Longer Supported) 3 = Under Consideration 4 = In Progress 5 = On Hold 6 = In Review 7 = Completed 8 = Rejected 9 = Approved
`TicketID`	Nullable<Int32>	If set, the numeric ID of the ticket to which this task is assigned.
`UserID`	Nullable<Int32>	If set, the numeric ID of the agent assigned to the task.

UpdateTask

Modifies the properties of an existing task. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`taskID`	Int32	The numeric ID of the task.
`parameters`	String[]	A list of 'key=value' pairs of data items to modify in the task. The possible keys that can be submitted to this function are: Subject TaskPriorityID TaskStatusID UserID Description DateStart DateEnd ReminderMinutes RelatedItem

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

https://portal.smartertools.com:443/Services2/svcTickets.asmx

This web service contains methods that add, edit, or delete tickets within SmarterTrack.

WSDL Definition

Functions
AddMessageToTicket	Adds a new message to an existing ticket.
AddMessageToTicketFromUser	Adds a new message to an existing ticket from a user.
AddMessageToTicketWithAttachments	Adds a new message to an existing ticket, as if it came in on a specific date. Emails the message to the specified addresses.
AddMessageToTicketWithBcc	Adds a new message to an existing ticket with BCC address(es). Emails the message to the specified addresses.
AddMessageToTicketWithBccFromUser	Adds a new message to an existing ticket from a user with BCC address(es). Emails the message to the specified addresses.
AddMessageToTicketWithDate	Adds a new message to an existing ticket, as if it came in on a specific date.
AddMessageToTicketWithDateAndBcc	Adds a new message to an existing ticket with BCC address(es), as if it came in on a specific date. Emails the message to the specified addresses.
AddMessageToTicketWithDateAndBccFromUser	Adds a new message to an existing ticket, as if it came in on a specific date. Emails the message to the specified addresses.
AddMessageToTicketWithDateFromUser	Adds a new message to an existing ticket, as if it came in on a specific date.
AddRelatedItem	Adds a related item to a ticket, chat, or call.
AddTicketAttachment	Adds an attachment to a ticket.
AddTicketNote	Adds a comment to the specified ticket. This function encodes text, so HTML is not allowed.
AddTicketNoteHtml	Adds a comment to the specified ticket. This function does NOT encode text. HTML is allowed.
AddTicketNoteHtmlWithDate	Adds a comment to the specified ticket as if it came in on a specified date. This function does NOT encode text. HTML is allowed.
AddTicketTimeLog	Adds a new time log to a ticket.
AppendToTicketAttachment	Appends data to an existing attachment.
CloseTicket	Changes the status of a ticket to closed, and optionally adds a closing comment.
CreateIncomingTicket	Creates a new inbound ticket as if it was created by an end user. Also allows multiple fields to be set.
CreateIncomingTicketWithMessageAttachment	Creates a new inbound ticket as if it was created by an end user with attachments in the message. Also allows multiple fields to be set.
CreateOutboundTicket	Creates a new outbound ticket as if it was created by an agent with attachments in the message. Also allows multiple fields to be set.
CreateTicket	Creates a new outbound ticket as if it was sent from an agent.
CreateTicketWithCC	Creates a new outbound ticket as if it was sent from an agent. Also allows specifying additional email addresses to be included.
CreateTicketWithDate	Creates a new outbound ticket as if it was sent from an agent. Also allows the setting of key dates for the ticket.
CreateTicketWithDateAndCC	Creates a new outbound ticket as if it was sent from an agent. Also allows the setting of key dates for the ticket and specifying additional email addresses to be included.
DeleteTicket	Marks the given ticket as deleted.
EditTicketNote	Edits the properties of a comment.
EditTicketNoteHTML	Edits the properties of a comment. This function does NOT encode text. HTML is allowed.
GetAgentReceivingStatus	Get the tickets receiving status for the agent authenticated with authUserName.
GetAgentReceivingStatusAsAdmin	Use admin credentials to Get the tickets receiving status for the agent specified with agentUserName.
GetAgentsSignature	Gets the signature for the agent authenticated with authUserName for the specified department and group.
GetCustomFieldControls	Get the custom field template for the given department.
GetGroupTicketInfo	Returns the number of open tickets by group for the agent authenticated with the authUserName parameter.
GetTicketAttachments	Returns a list of attachments for a ticket.
GetTicketConversationPartList	Returns a list of conversation parts (messages, comments, etc.) for a given ticket.
GetTicketConversationPartListFromTicketNumber	Returns a list of conversation parts (messages, comments, etc.) for a given ticket.
GetTicketCount	Returns the total number of open tickets for the agent authenticated with the authUserName parameter.
GetTicketCounts_Agent	Returns agent ticket counts by brand, department, and group for the agent authenticated with the authUserName parameter.
GetTicketCounts_Global	Returns global ticket counts by brand, department, group and agent.
GetTicketCustomFields	Returns a list of custom field values from the list of requested fields for the specified ticket.
GetTicketCustomFieldsList	Returns a list of all custom field properties and values for the specified ticket.
GetTicketEventHistory	Returns the history details of a ticket.
GetTicketInfo	Get details about a ticket for the given numeric ticket ID.
GetTicketInfoByTicketNumber	Get details about a ticket for the given textual ticket number.
GetTicketMessageAttachmentInfo	Returns a list of attachments for a ticket message.
GetTicketMessageHtml	Returns the body text for a specific ticket message formatted as HTML.
GetTicketMessagePlainText	Returns the body text for a specific ticket message formatted as plain text.
GetTicketNote	Returns details about the specified note.
GetTicketProperties	Returns a list of requested properties for the ticket specified.
GetTicketPropertiesList	Returns a list of all properties for the specified ticket.
GetTicketRelatedItemInfoArrayResult	Returns a list of related items Ids (Ticket Ids, Chat Ids, Call Log Ids) for a given ticket.
GetTicketsBySearch	Returns a list of tickets that match the given search criteria.
GetTicketStatus	Returns the current status of a specific ticket.
GetTicketStatusInternal	Returns the current SmarterTrack status of a specific ticket.
GetTicketTimeLog	Gets details about a time log entry.
GetTicketTimeLogs	Returns a list of time logs for a ticket.
GetTicketURL	Retrieves a URL that can be used to direct users to view a ticket in the portal.
HandOffActiveTickets	Hands-off all active tickets assigned to the agent authenticated with authUserName.
HandOffActiveTicketsAsAdmin	Use admin credentials to Hands-off all active tickets for agent specified with agentUserName.
PingService	Pings the web service with the specified credentials to test connectivity.
RemoveFollowUp	Removes the follow-up for a ticket.
SetAgentReceivingStatus	Set the tickets receiving status for the agent authenticated with authUserName.
SetAgentReceivingStatusAsAdmin	Use admin credentials to set the tickets receiving status for the agent specified with agentUsername.
SetAgentReceivingStatusForAllGroups	Set the tickets receiving status for all groups the agent authenticated with authUserName belongs to.
SetAgentReceivingStatusForAllGroupsAsAdmin	Use admin credentials to set the tickets receiving status for all groups for the agent with the supplied agentUserName.
SetAttachmentForUseInMessages	Uploads a file or continues an existing file that was already partially uploaded. Returns the GUID that identifies the upload to use in other calls.
SetFollowUp	Marks the ticket as requiring follow-up, and optionally adds a comment to the ticket.
SetTicketCustomFields	Sets the values of the specific custom fields for a ticket.
SetTicketProperties	Sets the provided property values of the specified ticket.
TransferTicket	Transfers the specified ticket to the group and agent provided (ticket will be placed in queue if an agent is not specified).
TransferTicketToInstance	Transfers the specified ticket to the group and agent provided in another instance of SmarterTrack (ticket will be placed in queue if an agent is not specified).

Depricated: CreateTicketFromCustomer, CreateTicketFromCustomerWithCC, CreateTicketFromCustomerWithDate, CreateTicketFromCustomerWithDateAndCC, CreateTicketFromCustomerWithGroup, CreateTicketFromCustomerWithGroupWithCC

AddMessageToTicket

Adds a new message to an existing ticket. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`sendEmail`	Boolean	True to send a copy of the message through email.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddMessageToTicketFromUser

Adds a new message to an existing ticket from a user. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`sendEmail`	Boolean	True to send a copy of the message through email.
`userID`	Nullable<Int32>	Send in a user id, is nullable

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddMessageToTicketWithAttachments

Adds a new message to an existing ticket, as if it came in on a specific date. Emails the message to the specified addresses. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`bccAddress`	String	The email address(es) of any BCCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`dateMessageReceived`	DateTime	The date and time that the message should appear to be sent, in GMT.
`userID`	Nullable<Int32>	Send in a user id, is nullable
`attachmentIds`	String[]	An array of attachments ids for the ticket message.

Returns TicketPartInfoResult

TicketPartInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Part`	TicketPartInfo	Details about the ticket part, as defined in the TicketPartInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketPartInfo		Description
`CreationDateUtc`	DateTime	The date and time the part was created, in GMT.
`Description`	String	The subject text of the part.
`Direction`	Int32	Indicates whether the message was inbound or outbound. Possible values are: 0 = End User to Agent 1 = Agent to End User
`IsDraft`	Boolean	Whether or not the item is a draft.
`PartId`	Int64	The numeric ID of the ticket part.
`Recipient`	String	The name of the recipient of the part.
`Sender`	String	The name of the sender of the part.
`Type`	Int32	The type of part this is. Possible values are: 1 = Message 10 = Note 11 = Transfer Note 12 = Resolution

AddMessageToTicketWithBcc

Adds a new message to an existing ticket with BCC address(es). Emails the message to the specified addresses. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`bccAddress`	String	The email address(es) of any BCCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddMessageToTicketWithBccFromUser

Adds a new message to an existing ticket from a user with BCC address(es). Emails the message to the specified addresses. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`bccAddress`	String	The email address(es) of any BCCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`userID`	Nullable<Int32>	Send in a user id, is nullable

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddMessageToTicketWithDate

Adds a new message to an existing ticket, as if it came in on a specific date. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`sendEmail`	Boolean	True to send a copy of the message through email.
`dateMessageReceived`	DateTime	The date and time that the message should appear to be sent, in GMT.

Returns TicketPartInfoResult

TicketPartInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Part`	TicketPartInfo	Details about the ticket part, as defined in the TicketPartInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketPartInfo		Description
`CreationDateUtc`	DateTime	The date and time the part was created, in GMT.
`Description`	String	The subject text of the part.
`Direction`	Int32	Indicates whether the message was inbound or outbound. Possible values are: 0 = End User to Agent 1 = Agent to End User
`IsDraft`	Boolean	Whether or not the item is a draft.
`PartId`	Int64	The numeric ID of the ticket part.
`Recipient`	String	The name of the recipient of the part.
`Sender`	String	The name of the sender of the part.
`Type`	Int32	The type of part this is. Possible values are: 1 = Message 10 = Note 11 = Transfer Note 12 = Resolution

AddMessageToTicketWithDateAndBcc

Adds a new message to an existing ticket with BCC address(es), as if it came in on a specific date. Emails the message to the specified addresses. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`bccAddress`	String	The email address(es) of any BCCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`dateMessageReceived`	DateTime	The date and time that the message should appear to be sent, in GMT.

Returns TicketPartInfoResult

TicketPartInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Part`	TicketPartInfo	Details about the ticket part, as defined in the TicketPartInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketPartInfo		Description
`CreationDateUtc`	DateTime	The date and time the part was created, in GMT.
`Description`	String	The subject text of the part.
`Direction`	Int32	Indicates whether the message was inbound or outbound. Possible values are: 0 = End User to Agent 1 = Agent to End User
`IsDraft`	Boolean	Whether or not the item is a draft.
`PartId`	Int64	The numeric ID of the ticket part.
`Recipient`	String	The name of the recipient of the part.
`Sender`	String	The name of the sender of the part.
`Type`	Int32	The type of part this is. Possible values are: 1 = Message 10 = Note 11 = Transfer Note 12 = Resolution

AddMessageToTicketWithDateAndBccFromUser

Adds a new message to an existing ticket, as if it came in on a specific date. Emails the message to the specified addresses. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`bccAddress`	String	The email address(es) of any BCCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`dateMessageReceived`	DateTime	The date and time that the message should appear to be sent, in GMT.
`userID`	Nullable<Int32>	Send in a user id, is nullable

Returns TicketPartInfoResult

TicketPartInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Part`	TicketPartInfo	Details about the ticket part, as defined in the TicketPartInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketPartInfo		Description
`CreationDateUtc`	DateTime	The date and time the part was created, in GMT.
`Description`	String	The subject text of the part.
`Direction`	Int32	Indicates whether the message was inbound or outbound. Possible values are: 0 = End User to Agent 1 = Agent to End User
`IsDraft`	Boolean	Whether or not the item is a draft.
`PartId`	Int64	The numeric ID of the ticket part.
`Recipient`	String	The name of the recipient of the part.
`Sender`	String	The name of the sender of the part.
`Type`	Int32	The type of part this is. Possible values are: 1 = Message 10 = Note 11 = Transfer Note 12 = Resolution

AddMessageToTicketWithDateFromUser

Adds a new message to an existing ticket, as if it came in on a specific date. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`fromAddress`	String	The email address of the sender of the message.
`toAddress`	String	The email address(es) of the recipient of the message.
`ccAddress`	String	The email address(es) of any CCs for the message.
`subject`	String	The subject of the message.
`body`	String	The body text of the message.
`isHtml`	Boolean	True if the body text specified in 'body' is HTML. False if it is plain text.
`toCustomer`	Boolean	True if the message was from agent to end user. False if the message was from end user to agent.
`sendEmail`	Boolean	True to send a copy of the message through email.
`dateMessageReceived`	DateTime	The date and time that the message should appear to be sent, in GMT.
`userID`	Nullable<Int32>	Send in a user id, is nullable

Returns TicketPartInfoResult

TicketPartInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Part`	TicketPartInfo	Details about the ticket part, as defined in the TicketPartInfo class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketPartInfo		Description
`CreationDateUtc`	DateTime	The date and time the part was created, in GMT.
`Description`	String	The subject text of the part.
`Direction`	Int32	Indicates whether the message was inbound or outbound. Possible values are: 0 = End User to Agent 1 = Agent to End User
`IsDraft`	Boolean	Whether or not the item is a draft.
`PartId`	Int64	The numeric ID of the ticket part.
`Recipient`	String	The name of the recipient of the part.
`Sender`	String	The name of the sender of the part.
`Type`	Int32	The type of part this is. Possible values are: 1 = Message 10 = Note 11 = Transfer Note 12 = Resolution

AddRelatedItem

Adds a related item to a ticket, chat, or call. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	TicketNumber
`relatedItemNumber`	String	The numeric ID of the related item.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddTicketAttachment

Adds an attachment to a ticket. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`ticketMessageId`	Int64	The numeric ID of the ticket message, or 0 to assign a ticket-wide attachment.
`fileName`	String	The original name of the file to add.
`data`	Byte[]	The bytes of data for the attachment. If data is long, it may be necessary to send some data with this function and then repeatedly call AppendToTicketAttachment for the remainder of the data.
`fileLength`	Int32	The size of the file (in bytes).
`dateCreatedUTC`	DateTime	The date and time the file was created, in GMT.

Returns TicketAttachmentInfoResult

TicketAttachmentInfoResult		Description
`File`	TicketAttachmentInfo	Details about the attachment, as defined in the TicketAttachmentInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

TicketAttachmentInfo		Description
`downloadUrl`	String	The URL that can be used to directly download the file from SmarterTrack.
`fileDateUtc`	DateTime	The write date and time on the file, in GMT.
`fileId`	Int32	The numeric ID of the attachment.
`fileNameOnDisk`	String	The filename as it is stored on the hard disk by SmarterTrack.
`fileNameOriginal`	String	The filename as it appeared originally outside of SmarterTrack.
`fileSizeInBytes`	Int64	The size of the file, in bytes.
`sender`	String	The display name of the user that uploaded the file.
`senderUserId`	Int32	The numeric ID of the user that uploaded the file.
`ticketMessageId`	Int64	The numeric ID of the ticket message to which this item is attached. If more than one message contains the same attachment, this will be the most recent one.

AddTicketNote

Adds a comment to the specified ticket. This function encodes text, so HTML is not allowed. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique ticket number to add a comment to.
`messageType`	String	The type of comment to add to the system. Possible values are Note Resolution TransferNote FollowUp
`notetext`	String	The body text of the note, in plain text.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddTicketNoteHtml

Adds a comment to the specified ticket. This function does NOT encode text. HTML is allowed. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique ticket number to add a comment to.
`messageType`	String	The type of comment to add to the system. Possible values are Note Resolution TransferNote FollowUp
`notetext`	String	The body text of the note, in HTML.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddTicketNoteHtmlWithDate

Adds a comment to the specified ticket as if it came in on a specified date. This function does NOT encode text. HTML is allowed. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique ticket number to add a comment to.
`messageType`	String	The type of comment to add to the system. Possible values are Note Resolution TransferNote FollowUp
`notetext`	String	The body text of the note, in HTML.
`dateEnteredUTC`	DateTime	The date and time of the note, in GMT.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddTicketTimeLog

Adds a new time log to a ticket. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketId`	Int32	The numeric ID of the ticket.
`subject`	String	The subject of the ticket.
`agentID`	Int32	The numeric ID of the agent assigned to the time log.
`timeLogCategoryID`	Int32	The numeric master category ID.
`description`	String	The description of the time log.
`dateStartUTC`	DateTime	The date and time work began for this time log, in GMT.
`dateEndUTC`	DateTime	The date and time work ended for this time log, in GMT.
`isBillable`	Boolean	True if the time log should be recorded as billable.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AppendToTicketAttachment

Appends data to an existing attachment. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketAttachmentId`	Int32	The numeric ID of the attachment to add to.
`data`	Byte[]	The bytes of data to add to the attachment. If data is long, it may be necessary to call this function multiple times.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CloseTicket

Changes the status of a ticket to closed, and optionally adds a closing comment. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ticketNumber`	String	The textual unique number associated to a ticket.
`closingComment`	String	If set, specifies text to store in a final comment on the ticket.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CreateIncomingTicket

Creates a new inbound ticket as if it was created by an end user. Also allows multiple fields to be set. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`data`	TicketCreationData	Class containing information about the new ticket as well as information about the ticket it is being created from.

TicketCreationData		Description
`agentID`	Nullable<Int32>	The numeric ID of the user to whom the ticket should be assigned. [DEFAULTS TO AUTO ASSIGN]
`body`	String	The body text of the new ticket.
`ccEmailAddress`	String	The email address(es) of any CCs for the message.
`creationDate`	Nullable<DateTime>	The date and time the ticket is created. [DEFAULTS TO CURRENT DATE AND TIME]
`departmentID`	Nullable<Int32>	The numeric ID of the department in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`displayName`	String	The display name of the end user.
`followUpComment`	String	A comment to the ticket specifying why the follow-up was added.
`followUpDate`	Nullable<DateTime>	The date and time on which the follow - up should be triggered, in GMT. [IF SET, STARTS TICKET IN FOLLOWUP MODE]
`groupID`	Nullable<Int32>	The numeric ID of the group in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`isHtml`	Nullable<Boolean>	True if the 'body' parameter is HTML. False if it is plain text.
`pinToAgent`	Nullable<Boolean>	True to pin the ticket to the agent specified in newAgentId. [DEFAULTS TO FALSE]
`priority`	Nullable<Int32>	The priority of the new ticket. Possible values are 1 = Low 2 = Normal [DEFAULT] 3 = High 4 = Urgent
`sendAutoResponder`	Nullable<Boolean>	True to send an autoresponder after the ticket is created. [DEFAULTS TO FALSE]
`senderEmailAddress`	String	The email address of the end user. [REQUIRED]
`status`	Nullable<Int32>	The status of the new ticket. Possible values are 1 = Open [DEFAULT] 2 = Waiting 3 = Closed
`subject`	String	The subject of the ticket. [REQUIRED]

Returns TicketInfoResult

TicketInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Ticket`	TicketInfo	Details about the ticket, as defined in the TicketInfo class.

TicketInfo		Description
`CustomerEmailAddress`	String	The email address of the end user.
`FollowUpDateUtc`	Nullable<DateTime>	The date and time for when the ticket follow-up is needed. Is null if there is no follow up date.
`ID`	Int32	The numeric ID of the ticket.
`IdAgent`	Int32	The numeric ID of the agent assigned to the ticket.
`IdCustomer`	Int32	The numeric ID of the end user that submitted the ticket.
`IdDepartment`	Int32	The numeric ID of the department to which the ticket is assigned.
`IdGroup`	Int32	The numeric ID of the group to which the ticket is assigned.
`IsActive`	Boolean	True if the ticket is active. False if the ticket is waiting or closed.
`IsDeleted`	Boolean	True if the ticket is marked as deleted.
`IsOpen`	Boolean	True if the ticket is open or waiting. False if it is closed.
`IsPinnedToAgent`	Boolean	True if the ticket is pinned to the agent specified in IdAgent.
`IsSpam`	Boolean	True if the ticket is marked as spam. If IsDeleted is false, this flag should be ignored.
`LastReplyDateUtc`	DateTime	The date and time of the last reply to the ticket, in GMT.
`Priority`	Int32	The priority of the ticket. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`ReplyCountIn`	Int32	The total number of messages from the end user.
`ReplyCountOut`	Int32	The total number of messages from agents.
`RequiresFollowUp`	Boolean	True if the ticket is marked as needing follow-up.
`ShowInFollowUpView`	Boolean	True if the ticket should appear in the follow-up section of SmarterTrack.
`Subject`	String	The subject of the ticket.
`TicketNumber`	String	The text-based unique ticket number.

CreateIncomingTicketWithMessageAttachment

Creates a new inbound ticket as if it was created by an end user with attachments in the message. Also allows multiple fields to be set. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`data`	TicketCreationDataWithAttachments	Class containing information about the new ticket as well as information about the ticket it is being created from.

TicketCreationDataWithAttachments		Description
`agentID`	Nullable<Int32>	The numeric ID of the user to whom the ticket should be assigned. [DEFAULTS TO AUTO ASSIGN]
`attachmentIds`	String[]	The ids of attachments for the ticket message. [DEFAULTS TO EMPTY STRING ARRAY]
`body`	String	The body text of the new ticket.
`ccEmailAddress`	String	The email address(es) of any CCs for the message.
`creationDate`	Nullable<DateTime>	The date and time the ticket is created. [DEFAULTS TO CURRENT DATE AND TIME]
`departmentID`	Nullable<Int32>	The numeric ID of the department in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`displayName`	String	The display name of the end user.
`followUpComment`	String	A comment to the ticket specifying why the follow-up was added.
`followUpDate`	Nullable<DateTime>	The date and time on which the follow - up should be triggered, in GMT. [IF SET, STARTS TICKET IN FOLLOWUP MODE]
`groupID`	Nullable<Int32>	The numeric ID of the group in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`isHtml`	Nullable<Boolean>	True if the 'body' parameter is HTML. False if it is plain text.
`pinToAgent`	Nullable<Boolean>	True to pin the ticket to the agent specified in newAgentId. [DEFAULTS TO FALSE]
`priority`	Nullable<Int32>	The priority of the new ticket. Possible values are 1 = Low 2 = Normal [DEFAULT] 3 = High 4 = Urgent
`sendAutoResponder`	Nullable<Boolean>	True to send an autoresponder after the ticket is created. [DEFAULTS TO FALSE]
`senderEmailAddress`	String	The email address of the end user. [REQUIRED]
`status`	Nullable<Int32>	The status of the new ticket. Possible values are 1 = Open [DEFAULT] 2 = Waiting 3 = Closed
`subject`	String	The subject of the ticket. [REQUIRED]

Returns TicketInfoResult

TicketInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Ticket`	TicketInfo	Details about the ticket, as defined in the TicketInfo class.

TicketInfo		Description
`CustomerEmailAddress`	String	The email address of the end user.
`FollowUpDateUtc`	Nullable<DateTime>	The date and time for when the ticket follow-up is needed. Is null if there is no follow up date.
`ID`	Int32	The numeric ID of the ticket.
`IdAgent`	Int32	The numeric ID of the agent assigned to the ticket.
`IdCustomer`	Int32	The numeric ID of the end user that submitted the ticket.
`IdDepartment`	Int32	The numeric ID of the department to which the ticket is assigned.
`IdGroup`	Int32	The numeric ID of the group to which the ticket is assigned.
`IsActive`	Boolean	True if the ticket is active. False if the ticket is waiting or closed.
`IsDeleted`	Boolean	True if the ticket is marked as deleted.
`IsOpen`	Boolean	True if the ticket is open or waiting. False if it is closed.
`IsPinnedToAgent`	Boolean	True if the ticket is pinned to the agent specified in IdAgent.
`IsSpam`	Boolean	True if the ticket is marked as spam. If IsDeleted is false, this flag should be ignored.
`LastReplyDateUtc`	DateTime	The date and time of the last reply to the ticket, in GMT.
`Priority`	Int32	The priority of the ticket. Default priority IDs are: 1 = Low 2 = Normal 3 = High 4 = Urgent
`ReplyCountIn`	Int32	The total number of messages from the end user.
`ReplyCountOut`	Int32	The total number of messages from agents.
`RequiresFollowUp`	Boolean	True if the ticket is marked as needing follow-up.
`ShowInFollowUpView`	Boolean	True if the ticket should appear in the follow-up section of SmarterTrack.
`Subject`	String	The subject of the ticket.
`TicketNumber`	String	The text-based unique ticket number.

CreateOutboundTicket

Creates a new outbound ticket as if it was created by an agent with attachments in the message. Also allows multiple fields to be set. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`data`	TicketCreationDataWithAttachmentsOutbound	Class containing information about the new ticket as well as information about the ticket it is being created from.

TicketCreationDataWithAttachmentsOutbound		Description
`attachmentIds`	String[]	An array of attachments ids for the ticket message.
`body`	String	The body text of the new ticket.
`ccAddresses`	String	The email address(es) of any CCs for the message.
`dateOpenedUTC`	DateTime	The date and time that the ticket should store as its creation date, in GMT.
`departmentID`	Nullable<Int32>	The numeric ID of the department in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`groupID`	Nullable<Int32>	The numeric ID of the group in which the ticket should be created. [EITHER DEPARTMENTID OR GROUPID IS REQUIRED]
`isHtml`	Boolean	True if the 'body' parameter is HTML. False if it is plain text.
`sendEmail`	Boolean	True to send an email for this ticket out to the end user.
`setWaiting`	Boolean	True to set the ticket status to 'waiting on customer'.
`subject`	String	The subject of the ticket.
`toAddress`	String	The email address of the end user.
`userIdOfAgent`	Int32	The numeric ID of the user to whom the ticket should be assigned. Pass 0 to auto-assign.

Returns StringRequestResult

StringRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`RequestResult`	String	Results of the function, as a string.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

CreateTicket

Creates a new outbound ticket as if it was sent from an agent. View the full specification

Inputs

Input Parameters		Description
`authUserName`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`departmentID`	Int32	The numeric ID of the department in which the ticket should be created.
`groupId`	Int32	The numeric ID of the group in which the ticket should be created.
`userIdOfAgent`	Int32	The numeric ID of the user to whom the ticket should be assigned. Pass 0 to auto-assign.
`toAddress`	String	The email address of the end user.
`subject`	String	The subject of the ticket.
`body`	String	The body text of the new ticket.
`isHtml`	Boolean	True if the 'body' parameter is HTML. False if it is plain text.
`setWaiting`	Boolean	True to set the ticket status to 'waiting on customer'.
`sendEmail`	Boolean	True to send an email for this ticket out to the end user.