Unsupported SOAP Service Classes

Class CallInfo

Instances of the CallInfo class contain information about one call.

`String`	`notes` Agent notes about the call.
`Calendar`	`answered` The Answered timestamp.
`Long`	`chatID` The chat ID.
`String`	`chatName` The name of the chat customer, if any.
`String`	`city` The customer's city.
`Calendar`	`closed` The Closed timestamp, if the chat is inactive.
`String`	`countryCode` The ISO 3166-1 country code.
`Calendar`	`created` The Created timestamp.
`Long`	`customField1ID` The first custom field ID.
`Long`	`customField2ID` The second custom field ID.
`Long`	`departmentID` The department ID.
`Calendar`	`dueDate` The due date.
`Calendar`	`ended` Gets the Ended timestamp of the chat. In chats that have started, this field is set only after the chat has ended.
`Calendar`	`flagged` The flagged timestamp.
`Long`	`folderID` The folder ID.
`String`	`initialQuestion` Gets the initial question, which is normally obtained either in the pre-chat survey or an auto-invite.
`String`	`iP` The customer's IP address.
`String`	`languageCode` The customer's ISO-639-1 language code.
`Long`	`lastAssignedByOperatorID` The ID of the agent that last assigned a chat.
`Long`	`operatorID` The ID of the agent the chat is assigned to.
`Integer`	`operatorMessageCount` The count of messages sent by the agent.
`Byte`	`pageType` The current page type. 0 - The "final" page type (where the call window is closed) 1 - The pre-call survey form 2 - The call page 3 - The call was killed 4 - The post-call survey form 5 - The unavailable email form 6 - The unavailable email submitted notice page 7 - The "browser unsupported" page 9 - The post-call survey submitted notice page 10 - The call was blocked 11 - The call was scheduled 12 - The call was canceled 13 - The call is joining
`String`	`regionCode` The customer's region code.
`Long`	`relatedToItemID` The ID of the item the chat is related to.
`Byte`	`relatedToItemType` The type of item the chat is related to. 2 - Contact 3 - Ticket
`String`	`reverseIP` The customer's reverse IP.
`Calendar`	`started` Gets the Started timestamp of the chat. The Started timestamp is set when the chat window is shown (not when the pre-chat survey is shown, for example).
`String`	`surveyComments` The post-chat survey comments.
`Integer`	`surveyKnowledge` The "knowledge" evaluation from the post-chat survey.
`Integer`	`surveyOverall` The "overall" evaluation from the post-chat survey.
`Integer`	`surveyProfessionalism` The "professionalism" evaluation from the post-chat survey.
`Integer`	`surveyResponsiveness` The "responsiveness" evaluation from the post-chat survey.
`Integer`	`unrespondedMessageCount` The number of customer messages without an answer.
`Calendar`	`updated` Gets the Updated timestamp, which is the last time the chat record was updated.
`Long`	`userCategoryID` The user category ID.
`Long`	`userStatusID` The user status ID.
`String`	`visitEmailAddress` The customer's email address.
`Long`	`visitID` The visit ID.
`String`	`visitInfo` The visit info field.
`Long`	`visitorClientID`
`Integer`	`visitorMessageCount` The number of customer messages.
`String`	`visitPhone` The customer's phone number
`String`	`visitRef` The VisitRef field.
`Long`	`websiteDefID` The website definition ID.
`Calendar`	`windowClosed` The WindowClosed timestamp.
`Long`	`visitorID` The ID of the customer.

Class CallsResult

A CallsResult instance contains an array of CallInfo instances.

CallInfo[]

calls

An array of calls.

boolean

truncated

True if the number of results was truncated.

Class ChatAssignmentInfo

Instances of the ChatAssignmentInfo class contain information about one chat assignment. A chat assignment belongs to a single chat, identified by the chatID property.

`Long`	`chatAssignmentID` The unique ID the chat assignment belongs to
`Byte`	`assignmentType` The type of Assignment that took place: 0 - Operator Assigned 1 - ACD Assigned
`Long`	`operatorID` The unique ID of the agent the chat assignment belongs to.
`Long`	`chatID` The unique ID of the chat the chat assignment belongs to.
`Integer`	`assignmentNumber` Sequential number of an Assignment event taking place on a Chat Record.
`Calendar`	`started` The Started timestamp of the chat assignment.
`Calendar`	`answered` The Answered timestamp of the chat assignment.
`Calendar`	`ended` The timestamp when the chat assignment ended.
`Integer`	`operatorAnswerChatCount` The number of agent answers within the chat assignment.
`Integer`	`operatorEndChatCount` The number of active chats assigned to and accepted by the operator, who is currently assigned to the chat (identified by the ChatID parameter). This value is calculated when the chat ends. Only those chats are included that were accepted by the operator (for example, chats assigned by ACD but not accepted are not included) AND are active at the time of ending the current chat. The current chat is also included in the value. Before the chat ends, this value is zero.
`Long`	`accountID` The account ID of the agent the current chat assignment belongs to
`Calendar`	`created` The Created timestamp of the chat assignment
`Calendar`	`updated` The Updated timestamp of the chat assignment
`Long`	`folderID` The folder ID the chat belongs to
`Long`	`websiteDefID` The website definition ID the chat assignment belongs to
`Byte`	`clientType` The client type of the chat the chat assignment belongs to
`Byte`	`fromAssignmentType` The assignment type of the chat assignment
`Long`	`fromOperatorID` Internal ID of the Operator/Agent who assigned the chat.
`Long`	`assignmentByOperatorID` The ID of the agent who assigned the current chat to someone else
`Long`	`fromDepartmentID` Internal ID of the Department where the chat is assigned from.
`Long`	`departmentID` The department ID the chat assignment belongs to
`Long`	`toOperatorID` Internal ID of the Operator/Agent who the chat is currently assigned to.
`Long`	`toAssignmentByOperatorID` Internal ID of the agent who initiated the Assignment event of the chat.
`Long`	`toDepartmentID` Internal ID of the Department who the chat is currently assigned to.
`Integer`	`visitorMessageCount` The customer message count of the chat assignment
`Integer`	`operatorMessageCount` The agent message count of the chat assignment
`Integer`	`endedVisitorMessageCount` The ended customer message count of the chat assignment
`Integer`	`endedOperatorMessageCount` The ended agent message count of the chat assignment

Class ChatAssignmentsResult

The ChatAssignmentsResult class encapsulates an array of ChatAssignmentInfo records.

ChatAssignmentInfo[]

chatAssignments

An array of chat assignment info

Class ChatInfo

Instances of the ChatInfo class contain information about one chat.

`Calendar`	`answered` The Answered timestamp.
`Long`	`chatID` The chat ID.
`String`	`chatName` The name of the chat customer, if any.
`Byte`	`chatStatusType` The chat status. 0 - None 1 - Last page was the pre-chat form 2 - Last page was the chat page 3 - The pre-chat form was closed 5 - Last page was the post-chat form 6 - The post-chat form was submitted 7 - The chat was unavailable 8 - An unavailable email was sent 10 - The chat was blocked 11 - The chat was unavailable because of the ACD queue size 12 - The chat was unavailable due to agent hours 14 - The chat was unavailable because of the ACD queue size, and an unavailable email was sent 15 - The chat was unavailable due to agent hours, and an unavailable email was sent 18 - The chat was not validated and so was blocked
`Byte`	`chatType` The chat type. 0 - The chat was initiated by clicking a chat button 2 - The chat was initiated by an agent inviting the customer 3 - The chat was initiated by clicking a chat button and unavailable 4 - The chat was the result of an auto-invitation 5 - The chat was initiated by clicking a chat button and blocked 6 - The chat was "recovered." Previously chat had been unavailable. 8 - The chat was initiated via the chat API
`String`	`chatUrl` The URL of the chat page.
`Long`	`chatWindowDefID` The ID of the chat window definition.
`String`	`city` The customer's city.
`Calendar`	`closed` The Closed timestamp, if the chat is inactive.
`String`	`countryCode` The ISO 3166-1 country code.
`Calendar`	`created` The Created timestamp.
`Long`	`customField1ID` The first custom field ID.
`Long`	`customField2ID` The second custom field ID.
`Long`	`departmentID` The department ID.
`Calendar`	`dueDate` The due date.
`Calendar`	`ended` Gets the Ended timestamp of the chat. In chats that have started, this field is set only after the chat has ended.
`Calendar`	`flagged` The flagged timestamp.
`Long`	`folderID` The folder ID.
`String`	`initialQuestion` Gets the initial question, which is normally obtained either in the pre-chat survey or an auto-invite.
`String`	`iP` The customer's IP address.
`String`	`languageCode` The customer's ISO-639-1 language code.
`Long`	`lastAssignedByOperatorID` The ID of the agent that last assigned a chat.
`Byte`	`lastMessagePersonType` The person type corresponding to the last chat message added to the chat. 0 - Agent (Operator) 1 - Customer (Visitor)
`String`	`lastName` The last name of the chat customer.
`Long`	`operatorID` The ID of the agent the chat is assigned to.
`Integer`	`operatorMessageCount` The count of messages sent by the agent.
`Byte`	`pageType` The current page type. 0 - The "final" page type (where the chat window is closed) 1 - The main chat page 5 - The post-chat survey form 6 - The pre-chat survey form 7 - The unavailable email form 9 - The "browser unsupported" page 10 - The post-chat survey submitted notice page 11 - The unavailable email submitted notice page 12 - The "no operators" page shown when there's no unavailable email form. 14 - The "chat not validated" page shown when validation fails.
`String`	`regionCode` The customer's region code.
`Long`	`relatedToItemID` The ID of the item the chat is related to.
`Byte`	`relatedToItemType` The type of item the chat is related to. 2: Contact 3: Ticket
`String`	`reverseIP` The customer's reverse IP.
`Calendar`	`started` Gets the Started timestamp of the chat. The Started timestamp is set when the chat window is shown (not when the pre-chat survey is shown, for example).
`String`	`surveyComments` The post-chat survey comments.
`Integer`	`surveyKnowledge` The "knowledge" evaluation from the post-chat survey.
`Integer`	`surveyOverall` The "overall" evaluation from the post-chat survey.
`Integer`	`surveyProfessionalism` The "professionalism" evaluation from the post-chat survey.
`Integer`	`surveyResponsiveness` The "responsiveness" evaluation from the post-chat survey.
`Integer`	`unrespondedMessageCount` The number of customer messages without an answer.
`Calendar`	`updated` Gets the Updated timestamp, which is the last time the chat record was updated.
`Long`	`userCategoryID` The user category ID.
`Long`	`userStatusID` The user status ID.
`String`	`visitEmailAddress` The customer's email address.
`Long`	`visitID` The visit ID.
`String`	`visitInfo` The visit info field.
`Long`	`visitorClientID`
`Integer`	`visitorMessageCount` The number of customer messages.
`String`	`visitPhone` The customer's phone number
`String`	`visitRef` The VisitRef field.
`Long`	`websiteDefID` The website definition ID.
`Calendar`	`windowClosed` The WindowClosed timestamp.
`Long`	`visitorID` The ID of the customer.

Class ChatMessageInfo

Instances of the ChatMessageInfo class contain information about one chat message. A chat message belongs to a single chat, identified by the chatID property.

`Long`	`chatID`
`Calendar`	`created` The Created timestamp of the chat message.
`Long`	`chatMessageID` The unique ID of the chat message.
`String`	`name` The name of the person who posted the message.
`Long`	`personID` The ID of the person who posted the message.
`Byte`	`personType` The type of person who posted the message. 0 - Agent (Operator) 1 - Customer (Visitor)
`String`	`text` The text of the message.

Class ChatMessagesResult

An instance of the ChatMessagesResult class is returned by a call to getChatMessages .

ChatMessageInfo[]

chatMessages

An array of chat messages.

Class ChatsResult

A ChatsResult instance contains an array of ChatInfo instances.

ChatInfo[]

chats

An array of chats.

boolean

truncated

True if the number of results was truncated.

Class ContactInfo

A ContactInfo instance contains information about one contact.

`String`	`address1` The address1.
`String`	`address2` The address2.
`String`	`businessName` The businessName.
`String`	`city` The city.
`Long`	`contactID` The contactID.
`String`	`countryCode` The countryCode.
`Calendar`	`created` The created.
`Long`	`createdByOperatorID` The createdByOperatorID.
`Long`	`customField1ID` The customField1ID.
`Long`	`customField2ID` The customField2ID.
`Long`	`departmentID` The departmentID.
`Calendar`	`dueDate` The dueDate.
`String`	`firstName` The firstName.
`Calendar`	`flagged` The flagged.
`Long`	`folderID` The folderID.
`String`	`fullName` The fullName.
`Long`	`lastAssignedByOperatorID` The lastAssignedByOperatorID.
`String`	`lastName` The lastName.
`String`	`notes` The notes.
`Long`	`operatorID` The agentID.
`String`	`postalCode` The postalCode.
`String`	`primaryEmailAddress` The primaryEmailAddress.
`String`	`primaryPhoneNumber` The primaryPhoneNumber.
`String`	`primaryUserName` The primaryUserName.
`String`	`state` The state.
`Calendar`	`updated` The updated.
`Long`	`userCategoryID` The userCategoryID.
`Long`	`userStatusID` The userStatusID.
`String`	`websiteUrl` The websiteUrl.

Class ContactResult

A ContactResult instance contains an ID that identifies one contact.

long

contactID

The contactID.

Class ContactsResult

A ContactsResult instance contains an array of ContactInfo instances.

ContactInfo[]

contacts

An array of contacts.

boolean

truncated

True if the results are truncated.

Class ConversionInfo

A ConversionInfo instance contains information about one conversion. A conversion belongs to a single folder.

`Long`	`conversionID` The conversion ID
`Long`	`visitID` The visit ID
`Long`	`websiteDefID` The website definition ID
`Long`	`operatorID` The agent assigned credit for this conversion
`Long`	`refererID` The referrer ID
`Long`	`conversionCodeID` The conversion code
`Long`	`chatInvitationTemplateVariantID` The chat invitation credited with this conversion
`Long`	`callInvitationTemplateVariantID` The call invitation credited with this conversion
`Long`	`folderID` The folder this conversion is in
`Long`	`visitorID` The ID of the customer
`Long`	`lastAssignedByOperatorID` The agent who assigned credit for this conversion to the operatorID associated with this conversion
`String`	`countryCode` The country code of the customer
`String`	`regionCode` The region code of the customer
`String`	`conversionRef` The value of the conversion reference optionally passed through in the conversion code for this conversion
`String`	`conversionInfo` The value of the conversion info optionally passed through in the conversion code for this conversion
`String`	`refererUrl` The referring location given credit for referring the customer to the site initially to make the conversion
`String`	`entryUrl` The initial landing page of the customer after being referred from the refererUrl location
`String`	`refererQuery` The search query, if recognized, given by the refererUrl used to refer the customer to the site
`Calendar`	`created` The time this conversion was created
`Calendar`	`visitCreated` The time the visit on which the conversion occurred was created
`Calendar`	`operatorActionTime` The time the agent assigned to this conversion interacted with the customer causing the conversion
`Double`	`conversionAmount` The value given to this conversion
`Byte`	`inviteStatusType` The invitation status of the visit when the conversion occurred.
`Byte`	`chatStatusType` The chat status of the visit when the conversion occurred. 0 - None 1 - Last page was the pre-chat form 2 - Last page was the chat page 3 - The pre-chat form was closed 5 - Last page was the post-chat form 6 - The post-chat form was submitted 7 - The chat was unavailable 8 - An unavailable email was sent 10 - The chat was blocked 11 - The chat was unavailable because of the ACD queue size 12 - The chat was unavailable due to agent hours 13 - The chat was blocked and an unavailable email was sent 14 - The chat was unavailable because of the ACD queue size, and an unavailable email was sent 15 - The chat was unavailable due to agent hours, and an unavailable email was sent
`Byte`	`callStatusType` The call status of the visit when the conversion occurred
`Byte`	`operatorStatusType` The type of interaction the agent had with the customer. 0: Chat in Previous Visit 1: Call in Previous Visit 2: Chat in Current Visit 3: Call in Current Visit
`Byte`	`operatorActionType` How the customer initiated their interaction with the agent. 0: Button Click 2: Agent Invited 4: Auto Invited
`Integer`	`visitCount` The total number of visits to the site prior to conversion
`Integer`	`pageViewCount` The total number of page views on the active visit prior to conversion
`Integer`	`operatorCount` The total number of agents that could have been given credit for this conversion

Class ConversionsResult

The ConversionsResult class encapsulates an array of conversions. Instances of this class are returned by conversion queries.

ConversionInfo[]

conversions

The array of conversions.

boolean

truncated

True if the results were truncated.

Class CustomField

The CustomField class represents a name-value pair. Custom fields can be configured to hold some of the results of a pre-chat survey.

Class CustomFieldsResult

An instance of the CustomFieldsResult class is returned by a call to getChatCustomFields or getCallCustomFields .

CustomField[]

customFields

An array of custom fields.

Class DepartmentInfo

A DepartmentInfo instance contains information about one department.

`Long`	`departmentID` The department ID.
`String`	`email` The department's email address.
`String`	`name` The department's name.
`Long`	`rolloverDepartmentID` The rollover department ID.

Class DepartmentsResult

The DepartmentsResult class encapsulates an array of DepartmentInfo records.

boolean

truncated

True if the results should be considered truncated.

DepartmentInfo[]

departments

An array of departments.

Class EmailAttachmentInfo

Instances of the EmailAttachmentInfo class contain information about one email attachment mapping. An email assignment mapping belongs to a single email, identified by the emailID property.

`Long`	`emailAttachmentMappingID`
`Long`	`emailID` The unique ID of the email the email attachment mapping belongs to
`Long`	`emailAttachmentID` The unique ID of the email attachment the email attachment mapping belongs to
`String`	`fileName`
`Calendar`	`created`
`Calendar`	`deleted`
`String`	`contentType`
`String`	`contentDisposition`
`String`	`encoding`
`String`	`contentID`
`Long`	`accountID`
`Boolean`	`visible`

Class EmailAttachmentResults

The EmailAttachmentResults class encapsulates an array of EmailAttachmentInfo records.

EmailAttachmentInfo[]

mappings

An array of email attachment info

Class EmailInfo

A EmailInfo instance contains information about one email message. An email belongs to a single email thread.

`Long`	`emailThreadID` The ID of the email thread this email belongs to.
`Calendar`	`created` The Created timestamp of the email.
`Long`	`operatorID` The agent ID assigned to the email.
`String`	`subject` The subject of the email.
`Long`	`emailAccountID` The email account identifier.
`String`	`fromFullEmailAddress` The email address of the sender.
`String`	`toFullEmailAddress` The email address of the intended recipient.
`String`	`ccFullEmailAddress` The carbon-copy email address.
`String`	`bccFullEmailAddress` The blind carbon-copy email address.
`String`	`body` The plain text body of an email.
`String`	`html` The HTML text of the email.
`String`	`contentType` The Content-Type header of the email.
`String`	`messageID` The Message-ID header of the email.
`String`	`replyTo` The Reply-To header of the email.
`String`	`bodyCharset` The charset that is currently used to encode the text of the email.
`String`	`htmlCharset` The charset that use currently used to encode the HTML version of the email.
`String`	`bodyOrigCharset` The charset that was originally used to encode the text of the email.
`String`	`htmlOrigCharset` The charset that was originally used to encode the HTML version of the email.
`String`	`headers` The email headers.
`Long`	`emailID` The unique email identifier in the system.
`Byte`	`emailType` The type of email. 0 - Draft 1 - Inbound 2 - Outbound 3 - Spam 4 - Bounce
`Integer`	`attachmentCount` The attachment count of the email.
`Calendar`	`sentDate` The date the email was sent.

Class EmailsResult

The EmailsResult class encapsulates an array of email message records. Instances of this class are returned by email query methods.

EmailInfo[]

emails

An array of emails.

Class EmailThreadInfo

An EmailThreadInfo instance contains information about one email thread. An email thread belongs to a single folder at any given time.

`Calendar`	`answered` The Answered timestamp.
`Long`	`emailThreadID` The email thread ID.
`Byte`	`emailThreadType` The email thread type. 1 - Inbound 2 - Outbound 4 - System
`Calendar`	`closed` The Closed timestamp. A `null` value means that the email thread is open.
`Calendar`	`created` The Created timestamp.
`Long`	`customField1ID` The first custom field ID.
`Long`	`customField2ID` The second custom field ID.
`Long`	`departmentID` The department ID of the email thread.
`Calendar`	`dueDate` The DueDate timestamp.
`Calendar`	`ended` The Ended timestamp.
`Calendar`	`flagged` The Flagged timestamp.
`Long`	`folderID` The ID of the folder the email thread belongs to.
`Long`	`lastAssignedByOperatorID` The ID of the agent who last assigned the email thread.
`Long`	`operatorID` The ID of the agent assigned to this email thread.
`Long`	`relatedToItemID` The ID of the item this email thread is related to.
`Byte`	`relatedToItemType` Gets the item type of the item this email thread is related to.
`Calendar`	`updated` The Updated timestamp.
`Long`	`userCategoryID` The user category ID of the email thread.
`Long`	`userStatusID` The user status ID of the email thread.

Class EmailThreadsResult

The EmailThreadsResult class encapsulates an array of email threads. Instances of this class are returned by service query methods.

EmailThreadInfo[]

emailThreads

An array of email threads.

boolean

truncated

True if the results were truncated.

Class FolderInfo

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

`Long`	`folderID` The unique ID of this folder.
`String`	`name` The name of the folder.
`Byte`	`folderType` The folder type. 2 - Contact 3 - Ticket 4 - Email Thread 5 - Chat 6 - Visit 7 - Report 50 - Call 73 - SMS 82 - Twitter
`Long`	`parentFolderID` The ID of the parent folder.

Class FoldersResult

The FoldersResult class encapsulates an array of folder records. Instances of this class are returned by folder query methods.

FolderInfo[]

folders

An array of folders.

Class GetCallsInfo

Instances of GetCallsInfo are used as parameters in call queries.

long

folderID

The folder ID.

Class GetChatMessagesInfo

The GetChatMessagesInfo class encapsulates a chat identfier. Instances of this class are used as service query parameters.

long

chatID

The chat ID.

Class GetChatsInfo

Instances of GetChatsInfo are used as parameters in chat queries.

long

folderID

The folder ID.

Class GetContactsInfo

Instances of GetContactsInfo are used as parameters in contacts queries.

long

folderID

The folder ID.

Class GetConversionsInfo

The GetConversionsInfo class encapsulates a folder identifier. Instances of this class are used in conversions queries.

long

folderID

The ID of the folder the visit belongs to.

Class GetConversionsWithDateRangeInfo

Extends GetConversionsInfo The GetConversionsWithDateRangeInfo class encapsulates a folder identifier. Instances of this class are used in conversions queries.

Calendar

fromDate

The FromDate value.

Calendar

toDate

The ToDate value.

Class GetEmailsInfo

The GetEmailsInfo class encapsulates an email thread identifier. Instances of this class are used in email queries.

long

emailThreadID

The email thread ID.

Class GetEmailThreadsInfo

The GetEmailThreadsInfo class encapsulates a folder identifier. Instances of this class are used in email thread queries.

long

folderID

The folder ID.

Class GetEmailThreadsWithDateRangeInfo

Extends GetEmailThreadsInfo The GetEmailThreadsWithDateRangeInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in email thread queries.

Calendar

fromDate

The FromDate instance.

Calendar

toDate

The ToDate instance.

Class GetInactiveCallsInfo

Extends GetCallsInfo The GetInactiveCallsInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in the inactive chats query.

Calendar

fromDate

The FromDate instance.

Calendar

toDate

The ToDate instance.

Class GetInactiveChatsInfo

Extends GetChatsInfo The GetInactiveChatsInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in the inactive chats query.

Calendar

fromDate

The FromDate instance.

Calendar

toDate

The ToDate instance.

Class GetPageViewsInfo

The GetPageViewsInfo class encapsulates a visit identifier. Instances of this class are used in the page views query.

long

visitID

The visit ID to be queried.

Class GetTicketsInfo

The GetTicketsInfo class encapsulates a folder identifier. Instances of this class are used in ticket queries.

long

folderID

The folder ID to be queried.

Class GetTicketsWithDateRangeInfo

Extends GetTicketsInfo The GetTicketsWithDateRangeInfo class encapsulates a folder identifier and optionally start and end dates. Instances of this class are used in ticket queries.

Calendar

fromDate

The FromDate instance.

Calendar

toDate

The ToDate instance.

Class GetVisitsInfo

The GetVisitsInfo class encapsulates a folder identifier. Instances of this class are used in visits queries.

long

folderID

The ID of the folder the visit belongs to.

Class GetVisitsWithDateRangeInfo

Extends GetVisitsInfo The GetVisitsWithDateRangeInfo class encapsulates a folder identifier. Instances of this class are used in visits queries.

Calendar

fromDate

The FromDate value.

Calendar

toDate

The ToDate value.

Class LoginActivityInfo

The LoginActivityInfo class encapsulates historical information about a login event or session. Each LoginActivityInfo instance has a creation time and, if completed, an end time.

`Long`	`operatorID` The ID of the agent associated with the entry.
`Byte`	`statusType` The entry status type: 0 (Offline), 1 (Away), 2 (Available).
`Calendar`	`created` The session creation date-time.
`Calendar`	`ended` The date-time when the session ended, or `null` if it hasn't ended yet.
`Long`	`serviceTypeID` The service type ID (1 = Chats, 2 = Visits, 3 = Emails, 7 = Calls).
`Byte`	`endedReason` The ended-reason value. 0 - None/Unknown 1 - Agent signed off 2 - Same client logged in 3 - Same agent logged in 4 - Client was closed 5 - Server requested client reconnect 6 - Sign-on limit reached 7 - Sign-off requested by another agent 8 - Same client logged in 9 - Agent login disabled
`Long`	`endedBy` ID of the agent who caused the session to end.

Class LoginActivityResult

An instance of the LoginActivityResult class is returned by a call to getLoginActivity .

LoginActivityInfo[]

loginActivityEntries

An array of LoginActivityInfo entries.

Class OperatorClientInfo

A OperatorClientInfo instance contains information about one agent client currently logged in.

See Also: CustomerService.getOperatorClients()

`Byte`	`callStatus` The status of the Call service. This may be 0 (off), 1 (away) or 2 (avaliable).
`Byte`	`chatStatus` The status of the Chat service. This may be 0 (off), 1 (away) or 2 (avaliable).
`Long`	`clientID` The unique ID of the this BoldChat client.
`String`	`clientIP` The IP address of the computer running the BoldChat client, as seen by the server.
`Long`	`operatorID` The ID of the agent logged in with this BoldChat client.
`String`	`userAgent` The HTTP User-Agent request header sent by the BoldChat client to the server when it first connected.
`Calendar`	`created` The creation timestamp of the BoldChat client record. This is roughly the time at which the client first connected.

See Also: CustomerService.getOperators() CustomerService.getOperatorByID()

Class OperatorClientsResult

The OperatorsResult class encapsulates an array of OperatorInfo records.

OperatorClientInfo[]

operatorClients

An array of BoldChat clients.

Class OperatorDiscussionInfo

A OperatorDiscussionInfo instance contains information about one agent discussion.

`Long`	`forumMessageID` The unique ID of a forum message
`Long`	`operatorID` The unique ID of the agent
`String`	`text` The message text
`Long`	`itemID` The itemID
`Byte`	`itemType` The type of the item
`Long`	`accountID` The account ID of the currently logged in user
`Calendar`	`created` The creation timestamp of the forum message This is roughly the time the message was sent

Class OperatorDiscussionsResult

The OperatorDiscussionsResult class encapsulates an array of OperatorDiscussionInfo records.

OperatorDiscussionInfo[]

operatorDiscussions

An array of agent discussion info

Class OperatorInfo

A OperatorInfo instance contains information about one agent.

`String`	`chatName` The chatName.
`Long`	`operatorID` The loginID.
`String`	`userName` The userName.
`String`	`email` The email.
`String`	`emailName` The emailName.
`String`	`name` The name.

Class OperatorsResult

The OperatorsResult class encapsulates an array of OperatorInfo records.

OperatorInfo[]

operators

An array of agents.

Class PageViewInfo

A PageViewInfo instance contains information about one page view. A page view belongs to a single visit.

`Calendar`	`created` The Created timestamp.
`Calendar`	`ended` The Ended timestamp.
`Long`	`pageViewID` The pageview ID.
`String`	`url` The pageview URL.
`Long`	`visitID` The ID of the visit this pageview belongs to.

Class PageViewsResult

The PageViewsResult class encapsulates an array of page views. Instances of this class are returned by the page views query.

PageViewInfo[]

pageViews

The array of pageviews.

Class SetupItemInfo

A SetupItemInfo instance contains general information about a setup item. Examples of setup items are User Categories, chat window definitions, and Salesforce connectors.

`String`	`name` The name.
`Long`	`setupItemID` The setupItemID.
`Byte`	`folderType` The folder type, which may be one of the following. 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 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 75 - Text Canned Messages 76 - Text User Categories 77 - Text User Statuses 78 - Text Custom Fields 1 79 - Text Custom Fields 2 84 - Twitter Canned Messages 85 - Twitter User Categories 86 - Twitter User Statuses 87 - Twitter Custom Fields 1 88 - Twitter Custom Fields 2
`Byte`	`isActive` Whether the setup item is active.
`Integer`	`accessKey` The shortcut or access key code, for setup items that support them.
`Calendar`	`created` The creation date-time.
`Calendar`	`updated` The last update date-time.

Class SetupItemsResult

The SetupItemsResult class encapsulates an array of setup items, such as user categories or user statuses.

SetupItemInfo[]

setupItems

The array of setup items.

boolean

truncated

True if the results were truncated.

Class TicketInfo

A TicketInfo instance contains information about one ticket. A ticket belongs to a single folder.

`Long`	`closedByOperatorID` The ID of the agent who closed the ticket or `null`.
`String`	`name` The ticket name (short description).
`Byte`	`priorityType` The priority type of the ticket. 0: Low Priority 1: Medium Priority 2: High Priority 3: Urgent Priority
`Long`	`relatedToItemID` The ID of the item this ticket is related to.
`Byte`	`relatedToItemType` The item type this ticket is related to. 2 - Contact 3 - Ticket
`Long`	`ticketID` The ticket ID.
`Calendar`	`closed` The Closed timestamp.
`Calendar`	`created` The Created timestamp.
`Long`	`createdByOperatorID` The ID of the agent who created the ticket.
`Long`	`customField1ID` The ID of the first custom field.
`Long`	`customField2ID` The ID of the second custom field.
`Long`	`departmentID` The department ID associated with the ticket, or `null`.
`Calendar`	`dueDate` The DueDate timestamp.
`Calendar`	`flagged` The Flagged timestamp or `null`.
`Long`	`folderID` The ID of the folder this ticket belongs to.
`Long`	`lastAssignedByOperatorID` The ID of the agent who last assigned the ticket to someone.
`String`	`notes` The ticket notes.
`Long`	`operatorID` The ID of the agent the ticket is assigned to or `null` if the ticket is unassigned.
`Calendar`	`updated` The Updated timestamp.
`Long`	`userCategoryID` The user category ID of the ticket.
`Long`	`userStatusID` The user status ID of the ticket.

Class TicketsResult

The TicketsResult class encapsultes an array of tickets. Instances of this class are returned by ticket queries.

TicketInfo[]

tickets

The array of tickets.

boolean

truncated

True if the results were truncated.

Class VisitInfo

A VisitInfo instance contains information about one visit. A visit belongs to a single folder.

`String`	`visitIP` The customer's IP address.
`String`	`visitName` The customer's name (which usually comes from a pre-chat survey or chat invitation).
`Integer`	`areaCode` The area code of the customer. This may be zero or `null` if unknown.
`Long`	`chatInvitationID` The chat invitation ID or `null`.
`Long`	`chatInvitationTemplateVariantID` The chat invitation template variant ID.
`Byte`	`chatStatusType` The chat status type. 0 - None 1 - Last page was the pre-chat form 2 - Last page was the chat page 3 - The pre-chat form was closed 5 - Last page was the post-chat form 6 - The post-chat form was submitted 7 - The chat was unavailable 8 - An unavailable email was sent 10 - The chat was blocked 11 - The chat was unavailable because of the ACD queue size 12 - The chat was unavailable due to agent hours 13 - The chat was blocked and an unavailable email was sent 14 - The chat was unavailable because of the ACD queue size, and an unavailable email was sent 15 - The chat was unavailable due to agent hours, and an unavailable email was sent
`String`	`currentUrl` The URL of the last page accessed by this visit.
`String`	`entryUrl` The URL of the page that created this visit.
`Integer`	`inviteDeclines` The number of invite declines.
`Integer`	`inviteIgnores` The number of invite ignores.
`Byte`	`inviteStatusType` The invite status type. 0 - None 1 - Auto Inviting 2 - Manual Inviting 3 - Auto Invite Accepted 4 - Manual Invite Accepted 5 - Auto Invite Declined 6 - Manual Invite Declined 7 - Auto Invite Ignored 8 - Manual Invite Ignored
`Integer`	`pageViewCount` The number of pageviews owned by the visit.
`String`	`refererUrl` The URL that referred this visit.
`String`	`refererQuery` Gets the search phrase associated with a search engine referral.
`String`	`userAgent` The customer's user agent (browser identifier).
`Byte`	`visitActionType` The visit action type. 0 - Normal 1 - Blocking 3 - Chat Inviting 5 - Call Inviting
`Integer`	`visitSeq` The visit sequence number. The first visit by a customer has sequence number 1.
`Byte`	`visitStatusType` The visit status type. 0 - Normal 1 - Blocked
`Byte`	`visitType` The visit type. 0 - Visit is the result of customer monitoring 1 - No customer monitoring but visit was needed (for example, to associate with a chat)
`String`	`city` The customer's city, which may be blank or `null` if unknown.
`Calendar`	`closed` The Closed timestamp, which may be `null` if the visit is active.
`String`	`countryCode` The customer's country code, which may be blank or `null` if unknown.
`Calendar`	`created` The Created timestamp.
`Calendar`	`ended` The Ended timestamp, which may be `null` if the visit has not ended.
`Long`	`folderID` The ID of the folder this visit belongs to.
`String`	`initialQuestion` The initial question (entered either in a pre-chat survey or chat invitation).
`String`	`iP` The customer's IP address.
`Long`	`operatorID` The ID of the agent who owns the visit.
`String`	`regionCode` The customer's region code.
`Long`	`relatedToItemID` The ID of the item this visit is related to, or `null`.
`Byte`	`relatedToItemType` The item type of the item this visit is related to. 2 - Contact 3 - Ticket
`String`	`reverseIP` The customer's resolved IP host.
`Calendar`	`updated` The Updated timestamp.
`String`	`visitEmailAddress` The customer's email address (which usually comes from a pre-chat survey or chat invitation).
`Long`	`visitID` The visit ID.
`String`	`visitInfo` The visit info field, which should come from the "vi" parameter of the customer monitoring URL.
`String`	`visitPhone` The customer's phone number.
`String`	`visitRef` The visit ref field (which should come from the "vr" parameter of the customer monitoring URL).
`Long`	`websiteDefID` The website definition ID.
`Long`	`visitorID` The ID of the customer this visit belongs to.

Class VisitsResult

The VisitsResult class encapsulates an array of visits. Instances of this class are returned by visit queries.

VisitInfo[]

visits

The array of visits.

boolean

truncated

True if the results were truncated.