live chat,live help,live support Boldchat Web Service
API Reference
 
[ Programmer's Guide | API Reference Home ]


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

Data Classes
ClassDescription
CallInfoInstances of the CallInfo class contain information about one call.
CallsResultA CallsResult instance contains an array of CallInfo instances.
ChatInfoInstances of the ChatInfo class contain information about one chat.
ChatMessageInfoInstances of the ChatMessageInfo class contain information about one chat message. A chat message belongs to a single chat, identified by the chatID property.
ChatMessagesResultAn instance of the ChatMessagesResult class is returned by a call to getChatMessages .
ChatsResultA ChatsResult instance contains an array of ChatInfo instances.
ContactInfoA ContactInfo instance contains information about one contact.
ContactResultA ContactResult instance contains an ID that identifies one contact.
ContactsResultA ContactsResult instance contains an array of ContactInfo instances.
ConversionInfoA ConversionInfo instance contains information about one conversion. A conversion belongs to a single folder.
ConversionsResultThe ConversionsResult class encapsulates an array of conversions. Instances of this class are returned by conversion queries.
CustomFieldThe CustomField class represents a name-value pair. Custom fields can be configured to hold some of the results of a pre-chat survey.
CustomFieldsResultAn instance of the CustomFieldsResult class is returned by a call to getChatCustomFields or getCallCustomFields .
DepartmentInfoA DepartmentInfo instance contains information about one department.
DepartmentsResultThe DepartmentsResult class encapsulates an array of records.
EmailInfoA EmailInfo instance contains information about one email message. An email belongs to a single email thread.
EmailThreadInfoAn EmailThreadInfo instance contains information about one email thread. An email thread belongs to a single folder at any given time.
EmailThreadsResultThe EmailThreadsResult class encapsulates an array of email threads. Instances of this class are returned by service query methods.
EmailsResultThe EmailsResult class encapsulates an array of email message records. Instances of this class are returned by email query methods.
FolderInfoA FolderInfo instance contains information about one folder. A folder may be a child of another folder, identified by the parentFolderID property. Root folders will have a null parent. One root folder per service is created along with a Boldchat account.
FoldersResultThe FoldersResult class encapsulates an array of folder records. Instances of this class are returned by folder query methods.
GetCallsInfoInstances of GetCallsInfo are used as parameters in call queries.
GetChatMessagesInfoThe GetChatMessagesInfo class encapsulates a chat identfier. Instances of this class are used as service query parameters.
GetChatsInfoInstances of GetChatsInfo are used as parameters in chat queries.
GetContactsInfoInstances of GetContactsInfo are used as parameters in contacts queries.
GetConversionsInfoThe GetConversionsInfo class encapsulates a folder identifier. Instances of this class are used in conversions queries.
GetConversionsWithDateRangeInfoThe GetConversionsWithDateRangeInfo class encapsulates a folder identifier. Instances of this class are used in conversions queries.
GetEmailThreadsInfoThe GetEmailThreadsInfo class encapsulates a folder identifier. Instances of this class are used in email thread queries.
GetEmailThreadsWithDateRangeInfoThe GetEmailThreadsWithDateRangeInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in email thread queries.
GetEmailsInfoThe GetEmailsInfo class encapsulates an email thread identifier. Instances of this class are used in email queries.
GetInactiveCallsInfoThe GetInactiveCallsInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in the inactive chats query.
GetInactiveChatsInfoThe GetInactiveChatsInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in the inactive chats query.
GetPageViewsInfoThe GetPageViewsInfo class encapsulates a visit identifier. Instances of this class are used in the page views query.
GetTicketsInfoThe GetTicketsInfo class encapsulates a folder identifier. Instances of this class are used in ticket queries.
GetTicketsWithDateRangeInfoThe GetTicketsWithDateRangeInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in ticket queries.
GetVisitsInfoThe GetVisitsInfo class encapsulates a folder identifier. Instances of this class are used in visits queries.
GetVisitsWithDateRangeInfoThe GetVisitsWithDateRangeInfo class encapsulates a folder identifier. Instances of this class are used in visits queries.
LoginActivityInfoThe LoginActivityInfo class encapsulates historical information about a login event or session. Each LoginActivityInfo instance has a creation time and, if completed, an end time.
LoginActivityResultAn instance of the LoginActivityResult class is returned by a call to getLoginActivity .
OperatorClientInfoA OperatorClientInfo instance contains information about one operator client currently logged in.
OperatorClientsResultThe OperatorsResult class encapsulates an array of records.
OperatorInfoA OperatorInfo instance contains information about one operator.
OperatorsResultThe OperatorsResult class encapsulates an array of records.
PageViewInfoA PageViewInfo instance contains information about one page view. A page view belongs to a single visit.
PageViewsResultThe PageViewsResult class encapsulates an array of page views. Instances of this class are returned by the page views query.
SetupItemInfoA SetupItemInfo instance contains general information about a setup item. Examples of setup items are User Categories, chat window definitions, and Salesforce connectors.
SetupItemsResultThe SetupItemsResult class encapsulates an array of setup items, such as user categories or user statuses.
TicketInfoA TicketInfo instance contains information about one ticket. A ticket belongs to a single folder.
TicketsResultThe TicketsResult class encapsultes an array of tickets. Instances of this class are returned by ticket queries.
VisitInfoA VisitInfo instance contains information about one visit. A visit belongs to a single folder.
VisitsResultThe VisitsResult class encapsulates an array of visits. Instances of this class are returned by visit queries.