Bold360 and BoldChat Developer Center

Unsupported SOAP CustomerService Classes

The CustomerService class provides access to account data with queries that are functionally similar to those found in Boldchat client grids.

Remember: The data retrieval methods listed in this section will continue to function, but technical support is no longer available.

General Methods

OperatorsResult getOperators

OperatorsResult getOperators()

Gets agents belonging to the current account.

Returns:

An array of OperatorInfo instances.

OperatorInfo getOperatorByID

OperatorInfo getOperatorByID (Long operatorID)

Looks up an account agent given an ID.

Parameters:

operatorID: The unique ID of the agent.

Returns:

An instance of OperatorInfo .

OperatorDiscussionsResult getOperatorDiscussions

OperatorDiscussionsResult getOperatorDiscussions (Byte itemType, Long itemID)

Looks up agent discussion messages given and item ID and an item type.

Parameters:

itemID: The ID of the item that owns the agent 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

DepartmentsResult getDepartments()

Gets departments belonging to the current account.

Returns:

An array of DepartmentInfo instances.

DepartmentInfo getDepartmentByID

DepartmentInfo getDepartmentByID (Long departmentID)

Looks up a department given an ID.

Parameters:

departmentID: The unique ID of the department.

Returns:

An instance of DepartmentInfo .

DepartmentInfo getOperatorDepartments

DepartmentsResult getOperatorDepartments (Long operatorID)

Gets departments belonging to the agent whose ID is provided.

Returns:

An array of DepartmentInfo instances.

OperatorInfo getDepartmentOperators

OperatorsResult getDepartmentOperators (Long departmentID)

Gets agents belonging to the department whose ID is provided.

Returns:

An array of OperatorInfo instances.

OperatorClientsResult getOperatorClients

OperatorClientsResult getOperatorClients()

Gets agent clients currently logged in to the server.

Returns:

An array of OperatorClientInfo instances.

FoldersResult getFolders

FoldersResult getFolders()

Gets folders associated with the account.

Returns:

An array of FolderInfo records.

FoldersResult getChatFolders

FoldersResult getChatFolders()

Gets chat folders associated with the account.

Returns:

An array of FolderInfo records.

FoldersResult getContactFolders

FoldersResult getContactFolders()

Gets contact folders associated with the account.

Returns:

An array of FolderInfo records.

FoldersResult getEmailFolders

FoldersResult getEmailFolders()

Gets email folders associated with the account.

Returns:

An array of FolderInfo records.

FoldersResult getTicketFolders

FoldersResult getTicketFolders()

Gets ticket folders associated with the account.

Returns:

An array of FolderInfo records.

FoldersResult getVisitFolders

FoldersResult getVisitFolders()

Gets visit folders associated with the account.

Returns:

An array of FolderInfo records.

FolderInfo getFolderByID

FolderInfo getFolderByID (Long folderID)

Gets a folder record given its ID.

getLoginActivity

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 agent 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 be null.

toDate: The upper bound of the creation range. This may be null.

LoginActivityResult getLoginActivity

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 agent 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 be null.

toDate: The upper bound of the creation range. This may be null.

SetupItemsResult getSetupItems

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

Chat Methods

ChatsResult 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.

CustomFieldsResult getChatCustomFields

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

CustomFieldsResult getChatOperatorCustomFields (Long chatID)

Gets the custom fields of a chat, entered by the agent as part of the custom wrap-up.

Parameters:

chatID: A valid chat ID.

ChatMessagesResult 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.

ChatAssignmentsResult getChatAssignments

ChatAssignmentsResult getChatAssignments (Long chatID)

Looks up the chat assignments of a certain chat.

Parameters:

chatID: The ID of the chat.

ChatInfo getChatByID

ChatInfo getChatByID(Long chatID)

Gets a chat given its ID.

Parameters:

chatID: A valid chat ID.

Call Methods

CustomFieldsResult getCallCustomFields

CustomFieldsResult getCallCustomFields (Long callID)

Gets the custom fields of a call.

Parameters:

callID: A valid call ID.

CallsResult 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.

CallInfo getCallByID

CallInfo getCallByID(Long callID)

Gets a call given an ID.

Parameters:

callID: The unique ID identifying the call.

Contact Methods

ContactsResult 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.

ContactInfo getContactByID

ContactInfo getContactByID (Long contactID)

Gets a contact given its ID.

Parameters:

contactID: A valid contact ID.

Ticket Methods

TicketsResult 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.

TicketsResult 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.

TicketsResult 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.

TicketInfo getTicketByID

TicketInfo getTicketByID (Long ticketID)

Gets a ticket given its ID.

Parameters:

ticketID: A valid ticket ID.

Visit Methods

VisitsResult 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 .

Note: This method returns visits in descending order by Closed date.

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.

PageViewsResult 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.

VisitInfo getVisitByID

VisitInfo getVisitByID (Long visitID)

Gets a visit given its ID.

Parameters:

visitID: A valid visit ID.

Conversion Methods

ConversionsResult 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.

Email Methods

EmailThreadsResult 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.

EmailThreadsResult 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.

EmailThreadsResult 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.

EmailAttachmentResults getEmailAttachmentEntries

EmailAttachmentResults getEmailAttachmentEntries(Long emailID)

This method gets a list of email attachment entries belonging to an email.

Parameters:

emailID: The email ID.

EmailsResult 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.

EmailThreadInfo getEmailThreadByID

EmailThreadInfo getEmailThreadByID (Long emailThreadID)

Gets an email thread given its ID.

Parameters:

emailThreadID: A valid email thread ID.