Boldchat Web Service API Reference

Boldchat Web Service
API Reference

[ Programmer's Guide | API Reference Home ]

Class VisitInfo

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

Property Summary
String	visitIP The visitor's IP address.
String	visitName
Integer	areaCode The area code of the visitor.
Long	chatInvitationID The chat invitation ID or `null`.
Long	chatInvitationTemplateVariantID The chat invitation template variant ID.
Byte	chatStatusType The chat status type.
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.
Integer	pageViewCount The number of pageviews owned by the visit.
String	refererUrl The URL that referred this visit.
String	userAgent The visitor's user agent (browser identifier).
Byte	visitActionType The visit action type.
Integer	visitSeq The visit sequence number.
Byte	visitStatusType The visit status type.
Byte	visitType The visit type.
String	city The visitor's city, which may be blank or `null` if unknown.
Date	closed The Closed timestamp, which may be `null` if the visit is active.
String	countryCode The visitor's country code, which may be blank or `null` if unknown.
Date	created The Created timestamp.
Date	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 visitor's IP address.
Long	operatorID The ID of the operator who owns the visit.
String	regionCode The visitor'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.
String	reverseIP The visitor's resolved IP host.
Date	updated The Updated timestamp.
String	visitEmailAddress The visitor'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 visitor monitoring URL.
String	visitPhone The visitor's phone number.
String	visitRef The visit ref field (which should come from the "vr" parameter of the visitor monitoring URL).
Long	websiteDefID The website definition ID.
Long	visitorID The ID of the visitor this visit belongs to.

Property Detail

String visitIP

The visitor's IP address.

String visitName

Integer areaCode

The area code of the visitor. 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 - Pre-Chat form

2 - In Chat

3 - Pre-Chat Form Closed

4 - Chat Ended

5 - Post-Chat Form

6 - Post-Chat Form Submitted

7 - Unavailable

8 - Unavailable Email 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