Bold360 and BoldChat Developer Center

getTextChats

Returns inactive text messages. Filter and page results as needed.

Additional information

Maximum page size: 1000 records.

Input parameters

Parameter Type Required Description

FolderID

numeric - ID code

Yes

The identifier of the folder to retrieve data from .

FromDate

date - ISO/UTC

No

The start date.

ToDate

date - ISO/UTC

No

The end date.

NextPage

string

No

Tells the server the next page of data to retrieve. This parameter should be the same value as what was returned in the response field "NextPage" by the previous call.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getTextChats?auth=$authHash&FromDate=2020-01-01T00:00:00Z"

Return values

Parameters are provided in alphabetic order. See Sample code for probable output.

Parameter Type Description
AccountID numeric - ID code Bold360 product account ID.
ACDReassignCount integer The number of operator reassignments through Automatic Chat Distribution (ACD) for a specific chat.
Answered date - ISO/UTC Date and time when the chat was most recently answered.
AreaCode code - UNSD M49 area code Telephone area code for the region, typically captured in the pre-chat survey.
AutoResponderState code - set values The automated response step or node. These nodes can be used to set up simple to complex guided workflows and to mark the current stage in the flow.
BlockedBy string Name of the operator who blocked a chat. <None> or null value indicates that the chat was not blocked.
ChatName string The name of the customer, captured within the VisitName parameter or through Name in pre-chat survey.
ChatStatusType integer Status of the chat at conversion (e.g. none, chat was unavailable, chat was blocked, etc), there are 17 types, more info in ConversionInfo. The most recent state that chat was in at the time of the chat closing. The legend of statuses is:
  • 0 - None
  • 1 - Pre-chat form
  • 2 - In chat
  • 3 - Pre-chat form closed
  • 4 - Chat ended
  • 5 - Transcript
  • 6 - Sent transcript
  • 7 - Unavailable
  • 8 - Sent unavailable
  • 9 - Chat ended answered
  • 10 - Unavailable blocked
  • 11 - Unavailable max queue
  • 12 - Unavailable hours
  • 13 - Sent unavailable blocked
  • 14 - Sent unavailable max queue
  • 15 - Unavailable limit
  • 16 - Sent unavailable limit
  • 17 - Unsecure
ChatType (aka ChatLaunchType) integer Type of the chat at the start or after someone tried to start it:
  • 0 - Visitor stated the chat with an agent
  • 1 - Operator initiated the chat (using auto invite)
  • 2 - Operator invited the customer to chat (using custom invite)
  • 3 - Operator was unavailable
  • 4 - Auto-invited chat
  • 5 - Blocked chat
  • 6 - Recovery invite
  • 7 - XMPP chat
  • 8 - Chat started via API
City string - ISO 3166 City of the visitor or customer.
ClientType integer The type of the Bold360 client used for Chat:
  • 0 - Normal
  • 1 - iPhone
  • 2 - Web
  • 3 - Visitor
  • 4 - Call
  • 5 - Offline
  • 6 - Web Mobile
  • 7 - Login
  • 8 - Enabled
  • 9 - Dashboard
  • 10 - Bold360 Agent Workspace
Closed date - ISO/UTC Date and time the transaction - visit, chat, etc. - closed.
CountryCode code - ISO 3166 ISO 2-letter country code (e.g. US).
Created date - ISO/UTC Date and time when the target resource was created.
CustomField1ID numeric - ID code ID of the Custom Field 1 label applied to a chat during post-chat wrap-up. Retrievable using FolderType=32. <None> or null refers to no Custom Field 1 label present on a chat.
CustomField2ID numeric -ID code ID of the Custom Field 2 label applied to a chat during post-chat wrap-up. Retrievable using FolderType=33. <None> or null refers to no Custom Field 2 label present on a chat.
Data text - heading JSON array heading that precedes report data output.
Deleted date - ISO / UTC Date and time when the item was deleted. The value is null if the item was not deleted.
DeletedBy string (max) The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted.
DepartmentID numeric - ID code ID of the department.
DueDate date - ISO / UTC Not in use - parameter is obsolete.
Email string - legal email Email address of the message's sender, if available. Must contain @ character.
Ended date - ISO/UTC Date and time visit or chat ended.
EndedBy numeric - ID code The system ID of the individual who ended the chat - operator, customer, etc.
EndedReasonType integer Reason why the chat was ended:
  • Null - unknown
  • 0 - Unknown
  • 1 - Ended by operator
  • 2 - Ended by customer
  • 3 - Disconnected
  • 4 - Bot timeout
  • 5 - Auto-ended, for example due to customer timeout
ExternalCrmItemID numeric - ID code Type of the linked CRM item:
  • C - Contact
  • L - Lead
ExternalCrmListID numeric - ID code Identifier to reference an external CRM list.
ExternalCrmType integer Type of CRM linked to the chat:
  • 0 - None
  • 1 - Salesforce
  • 2 - Icontact
  • 4 - New Salesforce
FirstAssignedAnswered    
Flagged Boolean Indicates whether the chat flag was raised within Bold360.
FolderID numeric The ID of the folder.
InitialQuestion string (max) The initial query sent in by the customer in the pre-chat survey.
InternalPhoneNumber string - legal phone number Phone number for the account.
LanguageCode code - ISO 639 The language of the chat, based on two-letter ISO 639-1 standard.
LastAssignedByOperatorID numeric - ID code ID of the agent who most recently assigned the chat. Null value indicates that the agent has not reassigned the chat.
LastMessagePersonType integer Type of the person who sent the last message:
  • 0 - Operator
  • 1 - Customer
  • 4 - Bold360 or BoldChat
  • 5 - LogMeIn Rescue
  • 6 - Auto message as set up in the chat window definition
  • 7 - Operator interpreter (set if auto-translation was used when the message was sent)
  • 8 - Customer interpreter (set if auto-translation was used when the message was sent)
  • 11 - Operator speech recognition (used during video chat if speech-to-text is enabled)
Values go from 0 to 12. Do not use the unlisted values as they are obsolete and are not handled.
LastMessageSent date - ISO-UTC Date and time when the last message in the conversation was sent.
Load integer The difficulty of the chat as defined by the rules engine. The value null indicates that difficulty is undefined.
MaxQueuePosition integer The highest position of the chat in the chat queue.
OperatorID numeric - ID code System-assigned ID of the operator.
OperatorMessageCount integer The number of operator-sent messages.
PageSize    
PageStart    
PhoneNumber string - legal phone number Phone number of the customer who initiated the chat.
Priority integer Indicates the priority/urgency of a chat as defined by the rules engine:
  • 0 - Lowest
  • 1 - Low
  • 2 - Normal
  • 3 - High
  • 4 - Highest
ProfilePic string - legal URL URL of the sender's profile picture.
RegionCode codes - ISO 3166 The geographical state/province.
RelatedToItemID numeric - ID code ID assigned to relate VisitRef and ContactId from found contact record.
RelatedToItemType integer Filled in by system when relating from VisitRef and set contact folder type (byte).
ResponseMessageCount integer The number of message responses that the agent sent to the customer since the customer's last message.
Started date - ISO / UTC Date and time when a chat was started within the chat queue.
Status codes - set values "Success" when the call completes; "Error" when the call fails.
TextChatID integer The identifier of the message conversation to get assignments for.
TextReceiverID numeric - ID code Identifier of the text receiver.
TextUserID numeric - ID code Identifier of the text user.
ToDate date - ISO / UTC End date.
TotalReassignCount integer The total count of how many agent reassignments occurred for a chat, including ACD reassignments and manual agent reassignment.
TotalResponseTime integer The total time in seconds that the customer waited for answers. Calculated as the aggregate time from every customer message to the subsequent agent reply. When there are multiple customer messages before the agent's reply, response time is calculated from the first customer message. Available for chat and message channels.
Truncated Boolean TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for.
UnrespondedMessageCount integer The number of customer-sent messages received since the agent's last message.
Updated date - ISO / UTC Date and time when the <event/record> was most recently modified.
UserCategoryID numeric - ID code ID of the User Category applied to a chat during post-chat wrap-up. <None> or null refers to no User Category present on a chat.
UserStatusID numeric - ID code ID of the user status applied to a chat during post-chat wrap-up. <None> or null indicates that there is no user status present on a chat.
VisitCreated date - ISO / UTC Date and time when the customer's site visit was created.
VisitorMessageCount integer The number of customer-sent messages.

Sample code

{
    "Status": "success",
    "Truncated": true,
    "Next": {
        "PageSize": 1,
        "PageStart": 1,
        "ToDate": "2019-07-16T14:57:50.000Z",
        "FolderID": "890770706814655"
    },
    "Data": [
        {   
            "TextChatID": "1355860836604362237",
            "ChatType": 0,
            "ChatName": "Kane Berger",
            "PhoneNumber": "+353851234567",
            "OperatorID": "2885011704169379811",
            "DepartmentID": "2057829067470849",
            "LastAssignedByOperatorID": "2885011704169379811",
            "LanguageCode": "en",
            "LastMessagePersonType": 1,
            "RelatedToItemID": "3234804277528148262",
            "AccountID": "2300000001",
            "Created": "2020-05-06T12:51:14.473Z",
            "FirstAssignedAnswered": "2020-05-06T12:51:36.000Z",
            "Ended": "2020-06-17T13:13:10.000Z",
            "Closed": "2020-06-17T13:13:10.000Z",
            "Updated": "2020-06-17T13:13:10.457Z",
            "Deleted": null,
            "FolderID": "890770706814655",
            "DueDate": null,
            "Started": "2020-05-06T12:51:14.000Z",
            "UnrespondedMessageCount": 1,
            "Flagged": "2020-05-07T12:51:14.000Z",
            "VisitorMessageCount": 2,
            "OperatorMessageCount": 1,
            "UserCategoryID": "4102267986830989849",
            "UserStatusID": "2511608625640805252",
            "CustomField1ID": "6286061191924112570",
            "CustomField2ID": "2803168803465871146",
            "TextUserID": "5579633063309060824",
            "TextReceiverID": "2201961300957784",
            "RelatedToItemType": 2,
            "CountryCode": "US",
            "RegionCode": null,
            "AreaCode": "316",
            "City": null,
            "InitialQuestion": "Hello",
            "ChatStatusType": 0,
            "Answered": "2020-05-06T12:51:36.000Z",
            "ACDReassignCount": 0,
            "TotalReassignCount": 1,
            "MaxQueuePosition": 2,
            "ResponseMessageCount": 1,
            "TotalResponseTime": 396,
            "LastVisitorMessageSent": "2020-05-06T12:58:10.000Z",
            "EndedBy": "2885011704169379811",
            "EndedReasonType": 1,
            "ExternalCrmItemID": null,
            "ExternalCrmListID": null,
            "ExternalCrmType": 4,
            "VisitCreated": null,
            "BlockedBy": null,
            "DeletedBy": null,
            "ClientType": null,
            "InternalPhoneNumber": null,
            "Priority": null,
            "Load": null,
            "Email": "kberger@example.com",
            "AutoResponderState": "Prompt Email",
            "ProfilePic": "null"
        },
        {   
            "TextChatID": "1355860836604362237",
            "ChatType": 0,
            "ChatName": "+353857654321",
            "PhoneNumber": "+353857654321",
            "OperatorID": "2885011704169379811",
            "DepartmentID": "2057829067470849",
            "LastAssignedByOperatorID": "2885011704169379811",
            "LanguageCode": "en",
            "LastMessagePersonType": 1,
            "RelatedToItemID": null,
            "AccountID": "2300000001",
            "Created": "2020-05-06T12:51:14.473Z",
            "FirstAssignedAnswered": "2020-05-06T12:51:36.000Z",
            "Ended": "2020-06-17T13:13:10.000Z",
            "Closed": "2020-06-17T13:13:10.000Z",
            "Updated": "2020-06-17T13:13:10.457Z",
            "Deleted": null,
            "FolderID": "890770706814655",
            "DueDate": null,
            "Started": "2020-05-06T12:51:14.000Z",
            "UnrespondedMessageCount": 1,
            "Flagged": null,
            "VisitorMessageCount": 2,
            "OperatorMessageCount": 1,
            "UserCategoryID": null,
            "UserStatusID": null,
            "CustomField1ID": null,
            "CustomField2ID": null,
            "TextUserID": "5579633063309060824",
            "TextReceiverID": "2201961300957784",
            "RelatedToItemType": 0,
            "CountryCode": null,
            "RegionCode": null,
            "AreaCode": null,
            "City": null,
            "InitialQuestion": "Hi",
            "ChatStatusType": 0,
            "Answered": "2020-05-06T12:51:36.000Z",
            "ACDReassignCount": 0,
            "TotalReassignCount": 1,
            "MaxQueuePosition": 2,
            "ResponseMessageCount": 1,
            "TotalResponseTime": 396,
            "LastVisitorMessageSent": "2020-05-06T12:58:10.000Z",
            "EndedBy": "2885011704169379811",
            "EndedReasonType": 1,
            "ExternalCrmItemID": null,
            "ExternalCrmListID": null,
            "ExternalCrmType": null,
            "VisitCreated": null,
            "BlockedBy": null,
            "DeletedBy": null,
            "ClientType": null,
            "InternalPhoneNumber": null,
            "Priority": null,
            "Load": null,
            "Email": "jwayne@example.com",
            "AutoResponderState": null,
            "ProfilePic": null
        }
}