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


Class ChatInfo

Instances of the ChatInfo class contain information about one chat.

Property Summary
Calendaranswered
The Answered timestamp.
LongchatID
The chat ID.
StringchatName
The name of the chat visitor, if any.
BytechatStatusType
The chat status.
BytechatType
The chat type.
StringchatUrl
The URL of the chat page.
LongchatWindowDefID
The ID of the chat window definition.
Stringcity
The visitor's city.
Calendarclosed
The Closed timestamp, if the chat is inactive.
StringcountryCode
The ISO 3166-1 country code.
Calendarcreated
The Created timestamp.
LongcustomField1ID
The first custom field ID.
LongcustomField2ID
The second custom field ID.
LongdepartmentID
The department ID.
CalendardueDate
The due date.
Calendarended
Gets the Ended timestamp of the chat.
Calendarflagged
The flagged timestamp.
LongfolderID
The folder ID.
StringinitialQuestion
Gets the initial question, which is normally obtained either in the pre-chat survey or an auto-invite.
StringiP
The visitor's IP address.
StringlanguageCode
The visitor's ISO-639-1 language code.
LonglastAssignedByOperatorID
The ID of the operator that last assigned a chat.
BytelastMessagePersonType
The person type corresponding to the last chat message added to the chat.
StringlastName
The last name of the chat visitor.
LongoperatorID
The ID of the operator the chat is assigned to.
IntegeroperatorMessageCount
The count of messages sent by the operator.
BytepageType
The current page type.
StringregionCode
The visitor's region code.
LongrelatedToItemID
The ID of the item the chat is related to.
ByterelatedToItemType
The type of item the chat is related to.
StringreverseIP
The visitor's reverse IP.
Calendarstarted
Gets the Started timestamp of the chat.
StringsurveyComments
The post-chat survey comments.
IntegersurveyKnowledge
The "knowledge" evaluation from the post-chat survey.
IntegersurveyOverall
The "overall" evaluation from the post-chat survey.
IntegersurveyProfessionalism
The "professionalism" evaluation from the post-chat survey.
IntegersurveyResponsiveness
The "responsiveness" evaluation from the post-chat survey.
IntegerunrespondedMessageCount
The number of visitor messages without an answer.
Calendarupdated
Gets the Updated timestamp, which is the last time the chat record was updated.
LonguserCategoryID
The user category ID.
LonguserStatusID
The user status ID.
StringvisitEmailAddress
The visitor's email address.
LongvisitID
The visit ID.
StringvisitInfo
The visit info field.
LongvisitorClientID
IntegervisitorMessageCount
The number of visitor messages.
StringvisitPhone
The visitor's phone number
StringvisitRef
The VisitRef field.
LongwebsiteDefID
The website definition ID.
CalendarwindowClosed
The WindowClosed timestamp.
LongvisitorID
The ID of the visitor.

Property Detail
Calendar answered

The Answered timestamp.
Long chatID

The chat ID.
String chatName

The name of the chat visitor, 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 operator 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 operator 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 operator inviting the visitor
  • 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 visitor'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 visitor's IP address.
String languageCode

The visitor's ISO-639-1 language code.
Long lastAssignedByOperatorID

The ID of the operator that last assigned a chat.
Byte lastMessagePersonType

The person type corresponding to the last chat message added to the chat.
  • 0 - Operator
  • 1 - Visitor
 String lastName

The last name of the chat visitor.
Long operatorID

The ID of the operator the chat is assigned to.
Integer operatorMessageCount

The count of messages sent by the operator.
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 visitor'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 visitor'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 visitor 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 visitor's email address.
Long visitID

The visit ID.
String visitInfo

The visit info field.
Long visitorClientID

Integer visitorMessageCount

The number of visitor messages.
String visitPhone

The visitor'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 visitor.