Boldchat Web Service API Reference |
CustomerService
class provides access to
account data with queries that are functionally similar
to those found in Boldchat client grids.
General Method Summary | |
---|---|
OperatorsResult | getOperators()
Gets operators belonging to the current account. |
OperatorInfo | getOperatorByID(Long operatorID)
Looks up an account operator given an ID. |
OperatorDiscussionsResult | getOperatorDiscussions(Byte itemType, Long itemID)
Looks up operator discussion messages given and item ID and an item type. |
DepartmentsResult | getDepartments()
Gets departments belonging to the current account. |
DepartmentInfo | getDepartmentByID(Long departmentID)
Looks up a department given an ID. |
DepartmentsResult | getOperatorDepartments(Long operatorID)
Gets departments belonging to the operator whose ID is provided. |
OperatorsResult | getDepartmentOperators(Long departmentID)
Gets operators belonging to the department whose ID is provided. |
OperatorClientsResult | getOperatorClients()
Gets operator clients currently logged in to the server. |
FoldersResult | getFolders()
Gets folders associated with the account. |
FoldersResult | getChatFolders()
Gets chat folders associated with the account. |
FoldersResult | getContactFolders()
Gets contact folders associated with the account. |
FoldersResult | getEmailFolders()
Gets email folders associated with the account. |
FoldersResult | getTicketFolders()
Gets ticket folders associated with the account. |
FoldersResult | getVisitFolders()
Gets visit folders associated with the account. |
FolderInfo | getFolderByID(Long folderID)
Gets a folder record given its ID. |
LoginActivityResult | getLoginActivity(Long serviceTypeID, Calendar fromDate, Calendar toDate)
Gets a summary of login activity. |
SetupItemsResult | getSetupItems(Byte folderType)
Gets a collection of setup items with the given folder type. |
Chats Method Summary | |
---|---|
ChatsResult | getInactiveChats(GetInactiveChatsInfo getChatsInfo)
For a given folder, this method gets chats that are closed. |
NetPromoterScoreInfo | getNetPromoterScoreInfo(GetInactiveChatsInfo chatsQueryInfo)
Calculates the Net Promoter Score (NPS) for a range of inactive chats. |
CustomFieldsResult | getChatCustomFields(Long chatID)
Gets the custom fields of a chat, entered in the pre-chat or post-chat forms. |
CustomFieldsResult | getChatOperatorCustomFields(Long chatID)
Gets the custom fields of a chat, entered by the operator as part of the custom wrap-up. |
ChatMessagesResult | getChatMessages(GetChatMessagesInfo getChatMessagesInfo)
This method gets all chat messages belonging to a chat. |
ChatAssignmentsResult | getChatAssignments(Long chatID)
Looks up the chat assignments of a certain chat. |
ChatInfo | getChatByID(Long chatID)
Gets a chat given its ID. |
Calls Method Summary | |
---|---|
CustomFieldsResult | getCallCustomFields(Long callID)
Gets the custom fields of a call. |
CallsResult | getInactiveCalls(GetInactiveCallsInfo getCallsInfo)
For a given folder, this method returns a collection of calls that are closed. |
CallInfo | getCallByID(Long callID)
Gets a call given an ID. |
Contacts Method Summary | |
---|---|
ContactsResult | getContacts(GetContactsInfo getContactsInfo)
This method gets all contacts in a folder. |
ContactInfo | getContactByID(Long contactID)
Gets a contact given its ID. |
Tickets Method Summary | |
---|---|
TicketsResult | getOpenTickets(GetTicketsInfo getTicketsInfo)
For a given folder, this method gets tickets that are not closed. |
TicketsResult | getClosedTickets(GetTicketsWithDateRangeInfo getTicketsInfo)
For a given folder, this method gets tickets that are closed. |
TicketsResult | getTickets(GetTicketsWithDateRangeInfo getTicketsInfo)
This method gets all tickets in a folder. |
TicketInfo | getTicketByID(Long ticketID)
Gets a ticket given its ID. |
Visits Method Summary | |
---|---|
VisitsResult | getInactiveVisits(GetVisitsWithDateRangeInfo getVisitsInfo)
For a given folder, this method gets all visits that are closed. |
PageViewsResult | getPageViews(GetPageViewsInfo getPageViewsInfo)
This method gets all page views belonging to a visit. |
PageViewsResult | getVisitPageViews(GetVisitPageViewsInfo getPageViewsInfo)
This method gets all page views belonging to a visit. |
VisitInfo | getVisitByID(Long visitID)
Gets a visit given its ID. |
Conversions Method Summary | |
---|---|
ConversionsResult | getConversions(GetConversionsWithDateRangeInfo getConversionsInfo)
For a given folder, this method gets all conversions created in the given date range. |
Emails Method Summary | |
---|---|
EmailThreadsResult | getOpenEmailThreads(GetEmailThreadsInfo getEmailThreadsInfo)
For a given folder, this method gets all email threads that are not closed. |
EmailThreadsResult | getClosedEmailThreads(GetEmailThreadsWithDateRangeInfo getEmailThreadsInfo)
For a given folder, this method gets all email threads that are closed. |
EmailThreadsResult | getEmailThreads(GetEmailThreadsWithDateRangeInfo getEmailThreadsInfo)
This method gets all email threads in a folder. |
EmailAttachmentResults | getEmailAttachmentEntries(Long emailID)
This method gets a list of email attachment entries belonging to an email. |
EmailsResult | getEmails(GetEmailsInfo getEmailsInfo)
This method gets all emails belonging to an email thread. |
EmailThreadInfo | getEmailThreadByID(Long emailThreadID)
Gets an email thread given its ID. |
Method Detail |
---|
OperatorsResult getOperators()
Gets operators belonging to the current account.
Returns:An array of OperatorInfo instances.
OperatorInfo getOperatorByID(Long operatorID)
Looks up an account operator given an ID.
Parameters:operatorID - The unique ID of the operator.
Returns:An instance of OperatorInfo .
OperatorDiscussionsResult getOperatorDiscussions(Byte itemType, Long itemID)
Looks up operator discussion messages given and item ID and an item type.
Parameters:itemID - The ID of the item that owns the operator discussion messages.
itemType - The type of item. It can be one of the following:
- 2 - Contacts
- 3 - Tickets
- 5 - Chats
- 4 - Email Threads
- 7 - Reports
- 57 - Active Assists
- 73 - SMS
- 82 - Twitter
DepartmentsResult getDepartments()
Gets departments belonging to the current account.
Returns:An array of DepartmentInfo instances.
DepartmentInfo getDepartmentByID(Long departmentID)
Looks up a department given an ID.
Parameters:departmentID - The unique ID of the department.
Returns:An instance of DepartmentInfo .
DepartmentsResult getOperatorDepartments(Long operatorID)
Gets departments belonging to the operator whose ID is provided.
Returns:An array of DepartmentInfo instances.
OperatorsResult getDepartmentOperators(Long departmentID)
Gets operators belonging to the department whose ID is provided.
Returns:An array of OperatorInfo instances.
OperatorClientsResult getOperatorClients()
Gets operator clients currently logged in to the server.
Returns:An array of OperatorClientInfo instances.
FoldersResult getFolders()
Gets folders associated with the account.
Returns:An array of FolderInfo records.
FoldersResult getChatFolders()
Gets chat folders associated with the account.
Returns:An array of FolderInfo records.
FoldersResult getContactFolders()
Gets contact folders associated with the account.
Returns:An array of FolderInfo records.
FoldersResult getEmailFolders()
Gets email folders associated with the account.
Returns:An array of FolderInfo records.
FoldersResult getTicketFolders()
Gets ticket folders associated with the account.
Returns:An array of FolderInfo records.
FoldersResult getVisitFolders()
Gets visit folders associated with the account.
Returns:An array of FolderInfo records.
ChatsResult getInactiveChats(GetInactiveChatsInfo getChatsInfo)
For a given folder, this method gets chats that are closed. Account folders can be obtained by invoking getFolders .
Parameters:getChatsInfo - An instance ofGetInactiveChatsInfo
containing a folder ID, and optionally start and end dates.
Returns:An instance ofChatsResult
containing an array of chat records.
NetPromoterScoreInfo getNetPromoterScoreInfo(GetInactiveChatsInfo chatsQueryInfo)
Calculates the Net Promoter Score (NPS) for a range of inactive chats.
Parameters:chatsQueryInfo - An instance ofGetInactiveChatsInfo
containing a folder ID, and optionally start and end dates.
Returns:An instance ofNetPromoterScoreInfo
containing the NPS and answer category counts.
CustomFieldsResult getChatCustomFields(Long chatID)
Gets the custom fields of a chat, entered in the pre-chat or post-chat forms.
Parameters:chatID - A valid chat ID.
CustomFieldsResult getChatOperatorCustomFields(Long chatID)
Gets the custom fields of a chat, entered by the operator as part of the custom wrap-up.
Parameters:chatID - A valid chat ID.
CustomFieldsResult getCallCustomFields(Long callID)
Gets the custom fields of a call.
Parameters:callID - A valid call ID.
CallsResult getInactiveCalls(GetInactiveCallsInfo getCallsInfo)
For a given folder, this method returns a collection of calls that are closed. Account folders can be obtained by invoking getFolders .
Parameters:getCallsInfo - An object with query parameters.
ContactsResult getContacts(GetContactsInfo getContactsInfo)
This method gets all contacts in a folder. Account folders can be obtained by invoking getFolders .
Parameters:getContactsInfo - An instance ofGetContactsInfo
containing a folder ID.
Returns:An instance ofContactsResult
containing an array of contact records.
TicketsResult getOpenTickets(GetTicketsInfo getTicketsInfo)
For a given folder, this method gets tickets that are not closed. Account folders can be obtained by invoking getFolders .
Parameters:getTicketsInfo - An instance ofGetTicketsInfo
containing a folder ID.
Returns:An instance ofTicketsResult
containing an array of ticket records.
TicketsResult getClosedTickets(GetTicketsWithDateRangeInfo getTicketsInfo)
For a given folder, this method gets tickets that are closed. Account folders can be obtained by invoking getFolders .
Parameters:getTicketsInfo - An instance ofGetTicketsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofTicketsResult
containing an array of ticket records.
TicketsResult getTickets(GetTicketsWithDateRangeInfo getTicketsInfo)
This method gets all tickets in a folder. Account folders can be obtained by invoking getFolders .
Parameters:getTicketsInfo - An instance ofGetTicketsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofTicketsResult
containing an array of ticket records.
VisitsResult getInactiveVisits(GetVisitsWithDateRangeInfo getVisitsInfo)
For a given folder, this method gets all visits that are closed. Account folders can be obtained by invoking getFolders .Note: This method returns visits in descending order by Closed date.
Parameters:getVisitsInfo - An instance ofGetVisitsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofVisitsResult
containing an array of visit records.
ConversionsResult getConversions(GetConversionsWithDateRangeInfo getConversionsInfo)
For a given folder, this method gets all conversions created in the given date range. Account folders can be obtained by invoking getFolders .
Parameters:getConversionsInfo - An instance ofGetConversionsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofConversionsResult
containing an array of conversion records.
EmailThreadsResult getOpenEmailThreads(GetEmailThreadsInfo getEmailThreadsInfo)
For a given folder, this method gets all email threads that are not closed. Account folders can be obtained by invoking getFolders .
Parameters:getEmailThreadsInfo - An instance ofGetEmailThreadsInfo
containing a folder ID.
Returns:An instance ofEmailThreadsResult
containing an array of email thread records.
EmailThreadsResult getClosedEmailThreads(GetEmailThreadsWithDateRangeInfo getEmailThreadsInfo)
For a given folder, this method gets all email threads that are closed. Account folders can be obtained by invoking getFolders .
Parameters:getEmailThreadsInfo - An instance ofGetEmailThreadsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofEmailThreadsResult
containing an array of email thread records.
EmailThreadsResult getEmailThreads(GetEmailThreadsWithDateRangeInfo getEmailThreadsInfo)
This method gets all email threads in a folder. Account folders can be obtained by invoking getFolders .
Parameters:getEmailThreadsInfo - An instance ofGetEmailThreadsWithDateRangeInfo
containing a folder ID and optionally start and end dates.
Returns:An instance ofEmailThreadsResult
containing an array of email thread records.
ChatMessagesResult getChatMessages(GetChatMessagesInfo getChatMessagesInfo)
This method gets all chat messages belonging to a chat.
Parameters:getChatMessagesInfo - An instance ofGetChatMessageInfo
containing a chat identifier.
Returns:AChatMessagesResult
instance containing an array of chat message records.
ChatAssignmentsResult getChatAssignments(Long chatID)
Looks up the chat assignments of a certain chat.
Parameters:chatID - The ID of the chat.
EmailAttachmentResults getEmailAttachmentEntries(Long emailID)
This method gets a list of email attachment entries belonging to an email.
Parameters:emailID - The email ID.
EmailsResult getEmails(GetEmailsInfo getEmailsInfo)
This method gets all emails belonging to an email thread.
Parameters:getEmailsInfo - An instance ofGetEmailsInfo
containing an email thread identifier.
Returns:AEmailsResult
instance containing an array of email records.
PageViewsResult getPageViews(GetPageViewsInfo getPageViewsInfo)
This method gets all page views belonging to a visit.
Parameters:getPageViewsInfo - An instance ofGetPageViewsInfo
containing a visit identifier.
Returns:APageViewsResult
instance containing an array of page view records.
PageViewsResult getVisitPageViews(GetVisitPageViewsInfo getPageViewsInfo)
This method gets all page views belonging to a visit.
Parameters:getPageViewsInfo - An instance ofGetPageViewsInfo
containing a visit identifier.
Returns:APageViewsResult
instance containing an array of page view records.
ChatInfo getChatByID(Long chatID)
Gets a chat given its ID.
Parameters:chatID - A valid chat ID.
CallInfo getCallByID(Long callID)
Gets a call given an ID.
Parameters:callID - The unique ID identifying the call.
ContactInfo getContactByID(Long contactID)
Gets a contact given its ID.
Parameters:contactID - A valid contact ID.
TicketInfo getTicketByID(Long ticketID)
Gets a ticket given its ID.
Parameters:ticketID - A valid ticket ID.
EmailThreadInfo getEmailThreadByID(Long emailThreadID)
Gets an email thread given its ID.
Parameters:emailThreadID - A valid email thread ID.
VisitInfo getVisitByID(Long visitID)
Gets a visit given its ID.
Parameters:visitID - A valid visit ID.
FolderInfo getFolderByID(Long folderID)
Gets a folder record given its ID.
LoginActivityResult getLoginActivity(Long serviceTypeID, Calendar fromDate, Calendar toDate)
Gets a summary of login activity. Each entry represents an action such as logging in or changing the operator status to Away or Available.
Parameters:serviceTypeID - The service type ID (1 = Chats, 7 = Calls).
fromDate - The lower bound of the creation range. This may benull
.
toDate - The upper bound of the creation range. This may benull
.
SetupItemsResult getSetupItems(Byte folderType)
Gets a collection of setup items with the given folder type.
Parameters:folderType - The folder type, which may be:
- 8 - Chat Canned Messages
- 9 - Email Canned Messages
- 11 - Contact User Categories
- 12 - Chat Button Defs
- 13 - Chat Invitation Defs
- 14 - Chat Window Defs
- 16 - Email Accounts
- 18 - Contact User Statuses
- 19 - Website Defs
- 20 - Chat User Categories
- 21 - Chat User Statuses
- 22 - Email User Categories
- 23 - Email User Statuses
- 24 - Ticket User Categories
- 25 - Ticket User Statuses
- 29 - Chat Invitations
- 30 - Contact Custom Fields 1
- 31 - Contact Custom Fields 2
- 32 - Chat Custom Fields 1
- 33 - Chat Custom Fields 2
- 34 - Email Custom Fields 1
- 35 - Email Custom Fields 2
- 36 - Ticket Custom Fields 1
- 37 - Ticket Custom Fields 2
- 42 - Call User Categories
- 43 - Call User Statuses
- 44 - Call Custom Fields 1
- 45 - Call Custom Fields 2
- 48 - Call Button Defs
- 49 - Call Window Defs
- 55 - Salesforce Connectors
- 65 - Knowledge Bases