 |
Boldchat Web Service API Reference |
Class CallInfo
Instances of theChatInfo class contain information about one chat.
| Property Summary | |
|---|---|
| Date | answered The Answered timestamp. |
| Long | chatID The chat ID. |
| String | chatName The name of the chat visitor, if any. |
| String | city The visitor's city. |
| Date | closed The Closed timestamp, if the chat is inactive. |
| String | countryCode The ISO 3166-1 country code. |
| Date | created The Created timestamp. |
| Long | customField1ID The first custom field ID. |
| Long | customField2ID The second custom field ID. |
| Long | departmentID The department ID. |
| Date | dueDate The due date. |
| Date | ended Gets the Ended timestamp of the chat. |
| Date | 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. |
| 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. |
| 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. |
| String | reverseIP The visitor's reverse IP. |
| Date | started Gets the Started timestamp of the chat. |
| 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. |
| Date | 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. |
| Date | windowClosed The WindowClosed timestamp. |
| Long | visitorID The ID of the visitor. |
| Property Detail |
|---|
The Answered timestamp.
Long chatID
The chat ID.
String chatName
The name of the chat visitor, if any.
String city
The visitor's city.
Date closed
The Closed timestamp, if the chat is inactive.
String countryCode
The ISO 3166-1 country code.
Date created
The Created timestamp.
Long customField1ID
The first custom field ID.
Long customField2ID
The second custom field ID.
Long departmentID
The department ID.
Date dueDate
The due date.
Date ended
Gets the Ended timestamp of the chat. In chats that have started, this field is set only after the chat has ended.
Date 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.
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 - Final
- 1 - Pre-Call Form
- 2 - Call
- 3 - Call Killed
- 4 - Post-Call Form
- 5 - Unavailable Form
- 6 - Unavailable Form Submitted
- 7 - Unsupported Browser
- 9 - Post-Call Form Submitted
- 10 - Call Blocked
- 11 - Call Scheduled
- 12 - Call Canceled
- 13 - Call Joining
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.
Date 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.
Date 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.
Date windowClosed
The WindowClosed timestamp.
Long visitorID
The ID of the visitor.