Boldchat Web Service API Reference

Boldchat Web Service
API Reference

[ Programmer's Guide | API Reference Home ]

Class CustomerService

The 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 login records belonging to the current account.
OperatorInfo	getOperatorByID(Long operatorID) Looks up an account operator given an ID.
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.

Chats Method Summary
ChatsResult	getInactiveChats(GetInactiveChatsInfo getChatsInfo) For a given folder, this method gets chats that are closed.
CustomFieldsResult	getChatCustomFields(Long chatID) Gets the custom fields of a chat.
ChatMessagesResult	getChatMessages(GetChatMessagesInfo getChatMessagesInfo) This method gets all chat messages belonging to a 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.
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.
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

getOperators

OperatorsResult getOperators()

Gets login records belonging to the current account.
Returns:
An array of OperatorInfo instances.

getOperatorByID

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 .

getOperatorClients

OperatorClientsResult getOperatorClients()

Gets operator clients currently logged in to the server.
Returns:
An array of OperatorClientInfo instances.

getFolders

FoldersResult getFolders()

Gets folders associated with the account.
Returns:
An array of FolderInfo records.

getChatFolders

FoldersResult getChatFolders()

Gets chat folders associated with the account.
Returns:
An array of FolderInfo records.

getContactFolders

FoldersResult getContactFolders()

Gets contact folders associated with the account.
Returns:
An array of FolderInfo records.

getEmailFolders

FoldersResult getEmailFolders()

Gets email folders associated with the account.
Returns:
An array of FolderInfo records.

getTicketFolders

FoldersResult getTicketFolders()

Gets ticket folders associated with the account.
Returns:
An array of FolderInfo records.

getVisitFolders

FoldersResult getVisitFolders()

Gets visit folders associated with the account.
Returns:
An array of FolderInfo records.

getInactiveChats

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 of GetInactiveChatsInfo containing a folder ID, and optionally start and end dates.

Returns:
An instance of ChatsResult containing an array of chat records.

getChatCustomFields

CustomFieldsResult getChatCustomFields(Long chatID)

Gets the custom fields of a chat.
Parameters:
chatID - A valid chat ID.

getCallCustomFields

CustomFieldsResult getCallCustomFields(Long callID)

Gets the custom fields of a call.
Parameters:
callID - A valid call ID.

getInactiveCalls

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.

getContacts

ContactsResult getContacts(GetContactsInfo getContactsInfo)

This method gets all contacts in a folder. Account folders can be obtained by invoking getFolders .
Parameters:
getContactsInfo - An instance of GetContactsInfo containing a folder ID.

Returns:
An instance of ContactsResult containing an array of contact records.

getOpenTickets

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 of GetTicketsInfo containing a folder ID.

Returns:
An instance of TicketsResult containing an array of ticket records.

getClosedTickets

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 of GetTicketsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of TicketsResult containing an array of ticket records.

getTickets

TicketsResult getTickets(GetTicketsWithDateRangeInfo getTicketsInfo)

This method gets all tickets in a folder. Account folders can be obtained by invoking getFolders .
Parameters:
getTicketsInfo - An instance of GetTicketsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of TicketsResult containing an array of ticket records.

getInactiveVisits

VisitsResult getInactiveVisits(GetVisitsWithDateRangeInfo getVisitsInfo)

For a given folder, this method gets all visits that are closed. Account folders can be obtained by invoking getFolders .
Parameters:
getVisitsInfo - An instance of GetVisitsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of VisitsResult containing an array of visit records.

getConversions

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 of GetConversionsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of ConversionsResult containing an array of conversion records.

getOpenEmailThreads

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 of GetEmailThreadsInfo containing a folder ID.

Returns:
An instance of EmailThreadsResult containing an array of email thread records.

getClosedEmailThreads

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 of GetEmailThreadsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of EmailThreadsResult containing an array of email thread records.

getEmailThreads

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 of GetEmailThreadsWithDateRangeInfo containing a folder ID and optionally start and end dates.

Returns:
An instance of EmailThreadsResult containing an array of email thread records.

getChatMessages

ChatMessagesResult getChatMessages(GetChatMessagesInfo getChatMessagesInfo)

This method gets all chat messages belonging to a chat.
Parameters:
getChatMessagesInfo - An instance of GetChatMessageInfo containing a chat identifier.

Returns:
A ChatMessagesResult instance containing an array of chat message records.

getEmails

EmailsResult getEmails(GetEmailsInfo getEmailsInfo)

This method gets all emails belonging to an email thread.
Parameters:
getEmailsInfo - An instance of GetEmailsInfo containing an email thread identifier.

Returns:
A EmailsResult instance containing an array of email records.

getPageViews

PageViewsResult getPageViews(GetPageViewsInfo getPageViewsInfo)

This method gets all page views belonging to a visit.
Parameters:
getPageViewsInfo - An instance of GetPageViewsInfo containing a visit identifier.

Returns:
A PageViewsResult instance containing an array of page view records.