Enterprise
After calling a given web method, if you don't receive the desired return value(s), check the object's errors collection for details. This errors collection will contain both validation/access rights oriented messages as well as system failure messages deemed safe for end user consumption. All "get" oriented web methods will return null if no records are found to match the search criteria. All "delete" or "save" oriented web methods return a boolean value. If "false", you'll want to check the errors collection for possible validation errors.
The following operations are supported. For a formal definition, please review the Service Description.
-
CreateTicket
DEPRECIATED! Creates new ticket. Custom1ID, Custom2ID,... values may be retrieved in Admin Panel->Ticket System->Customization->Labels and Fields, if custom fields are not used please provide 0 values for Custom*ID fields and empty strings for their corresponding values. Call this method if originator IP address is not known. -
CreateTicketWithIP
DEPRECIATED! Creates new ticket. Custom1ID, Custom2ID,... values may be retrieved in Admin Panel->Ticket System->Customization->Labels and Fields, if custom fields are not used please provide 0 values for Custom*ID fields and empty strings for their corresponding values. Call this method if originator IP address is known. -
GetChatTranscript
Returns XML containing Chat Transcript for the VisitorID provided -
GetContactList_Chat
Returns XML containing entire Contact list for visitors who had initiated a chat session with your support staff for the date period provided. The following information is returned: VisitorID,Host Name,IP Address,Visit Time,Detail 1,Detail 2,Detail 3,Detail 4,Agent Email,Department,Chat time,Wait time,Tags,Country,Chat launched at,SurveySubmissionID,Survey name,Survey comment,Survey Question 1, Survey Question 2, Survey Question 3, Survey Question 4, Survey Question 5 -
GetDailyChatters
Returns XML containing all Customers information who initiated a chat session for the date provided. The following information is returned: VisitorID, Country, Hostname, Referrer, Department, Chat Time(EST), Visitor Notes, Pre-Chat info, Custom Info. Use VisitorID to get Chat Transcript by calling GetChatTranscript method. -
GetDailyContactListWithNavHistory
Important: Report must be executed after 3AM EST and the provided date must be previous day's date. Returns XML containing all Contact Info collected along with pages visited for all visitors who initiated chat session for the date provided. The following information is returned: VisitorID, ChatID, VisitTime, VisitedPage, Detail1, Detail2, Detail3,Detail4,AgentEmail. -
GetDailyTickets
Returns XML containing all Tickets information that were created/updated on the date provided. The following information is returned: TicketID, Submission Date, Current Status, VisitorID, Customer name, Customer Email, Ticket Title, Question, Priority, Category, Ticket Log(Notes, Solutions), Custom Fields Submitted, Visitor Notes, Visitor Custom Info. -
GetEnterpriseVersion
Returns the current version number for the web service. Use this to ensure other applications have the proper reference. - GetNChatSessionsByDate
- GetNUniqueVisitorsByDate
- GetTicketsByCustomerEmailDS
- GetTicketsByCustomerEmailXML
-
IsDepartmentOnline
Returns the online/offline status for the department. Returns [true] if there are Online operators in the department, and [false] if all operators in the department are Offline -
NewTicket
Creates new ticket. Custom1ID, Custom2ID,... values may be retrieved in Admin Panel->Ticket System->Customization->Labels and Fields, if custom fields are not used please provide 0 values for Custom*ID fields and empty strings for their corresponding values.
For AssignTo please use 0 to leave ticket unassigned, OperatorID from Admin Panel->Account Setup->Operators screen to assign the ticket to an operator or DepartmentID*-1 (negative DepartmentID) from Admin Panel->Account Setup->Departments screen to assign the ticket to a department