Get a list of User's UserChats
Retrieve UserChat of a particular User.
Parameter
Accessible via URL https://api.channel.io/open/v5/users/{userId}/user-chats and HTTP GET
Present parameters in query string
| Parameter | Example | Required | Description | Parameter type |
|---|---|---|---|---|
| userId | 12345 | Required | ID of User | Path |
| sortOrder | desc | Optional | Sorting order. - available values : asc, desc, both - default value : desc (descending order means latest message first) | Query |
| since | 500000 | Optional | Epoch time in microseconds of the first message to be retrieved. If the since parameter is left empty, the list retrieved will start with the first message (as specified by the order parameter). | Query |
| limit | 40 | Optional | Restrict the maximum number of direct chats to be retrieved. - min : 1 - max : 500 - default : 25 | Query |
Example
Response
Returns a set of UserChat along with related information
{
"prev": "string",
"next": "string",
"messages": [
{
"chatKey": "string",
"id": "string",
"mainKey": "string",
"threadKey": "string",
"root": true,
"channelId": "string",
"chatType": "string",
"chatId": "string",
"personType": "string",
"personId": "string",
"requestId": "string",
"language": "string",
"createdAt": 1656032152433,
"version": 0,
"blocks": [
{
"type": "bullets",
"language": "string",
"value": "string",
"blocks": [
null
]
}
],
"plainText": "string",
"updatedAt": 1656032152427,
"buttons": [
{
"title": "string",
"colorVariant": "cobalt",
"url": "string"
}
],
"files": [
{
"id": "string",
"type": "string",
"name": "string",
"size": 0,
"contentType": "string",
"duration": 0,
"width": 0,
"height": 0,
"orientation": 0,
"animated": true,
"bucket": "string",
"key": "string",
"previewKey": "string",
"channelId": "string",
"chatType": "string",
"chatId": "string"
}
],
"webPage": {
"id": "string",
"url": "string",
"title": "string",
"description": "string",
"imageUrl": "string",
"videoUrl": "string",
"publisher": "string",
"author": "string",
"width": 0,
"height": 0,
"bucket": "string",
"previewKey": "string",
"logo": "string",
"name": "string"
},
"log": {
"action": "changeName",
"values": [
"string"
],
"triggerType": "string",
"triggerId": "string"
},
"reactions": [
{
"emojiName": "string",
"personKeys": [
"string"
]
}
],
"form": {
"inputs": [
{
"value": {},
"readOnly": true,
"type": "text",
"label": "string",
"dataType": "string",
"bindingKey": "string"
}
],
"submittedAt": 1656032153409,
"type": "string"
},
"state": "sending",
"options": [
"actAsManager"
],
"marketing": {
"type": "string",
"id": "string",
"advertising": true,
"sendToOfflineXms": true,
"sendToOfflineEmail": true,
"exposureType": "fullScreen"
},
"supportBot": {
"id": "string",
"revisionId": "string",
"sectionId": "string",
"stepIndex": 0,
"buttons": [
{
"text": "string",
"nextSectionId": "string"
}
],
"submitButtonIndex": 0
},
"action": {
"type": "select",
"buttons": [
{
"key": "string",
"text": "string"
}
]
},
"submit": {
"id": "string",
"key": "string"
},
"threadMsg": true,
"broadcastedMsg": true,
"rootMessageId": "string"
}
],
"sessions": [
{
"key": "string",
"chatId": "string",
"chatKey": "string",
"updatedKey": "string",
"unreadKey": "string",
"channelId": "string",
"alert": 0,
"unread": 0,
"watch": "all",
"allMentionImportant": true,
"readAt": 1656032152418,
"receivedAt": 1656032152418,
"postedAt": 1656032152418,
"updatedAt": 1656032152427,
"createdAt": 1656032152427,
"version": 0,
"id": "string",
"personType": "string",
"personId": "string",
"chatType": "string"
}
],
"userChats": [
{
"id": "string",
"channelId": "string",
"contactKey": "string",
"contactOrder": 1656032152515,
"contactMediumType": "string",
"state": "closed",
"managed": true,
"userId": "string",
"name": "string",
"description": "string",
"handling": {
"type": "string"
},
"source": {
"page": "string",
"marketing": {
"id": "string",
"type": "string"
},
"supportBot": {
"id": "string",
"revisionId": "string",
"sectionPath": [
"string"
]
}
},
"managerIds": [
"string"
],
"assigneeId": "string",
"teamId": "string",
"tags": [
"string"
],
"goalEventName": "string",
"goalEventQuery": {
"key": "string",
"type": "boolean",
"operator": {},
"values": [
{}
],
"and": [
null
],
"or": [
null
]
},
"goalCheckedAt": 1656032152525,
"firstOpenedAt": 1656032152526,
"openedAt": 1656032152526,
"createdAt": 1656032152527,
"frontMessageId": "string",
"frontUpdatedAt": 1656032152527,
"deskMessageId": "string",
"deskUpdatedAt": 1656032152529,
"firstAssigneeIdAfterOpen": "string",
"firstRepliedAtAfterOpen": 1656032152526,
"oneStop": true,
"waitingTime": 0,
"avgReplyTime": 0,
"totalReplyTime": 0,
"replyCount": 0,
"resolutionTime": 0,
"operationWaitingTime": 0,
"operationAvgReplyTime": 0,
"operationTotalReplyTime": 0,
"operationReplyCount": 0,
"operationResolutionTime": 0,
"firstAskedAt": 1656032152526,
"askedAt": 1656032152526,
"closedAt": 1656032152526,
"snoozedAt": 1656032152525,
"expiresAt": 1656032152537,
"version": 0,
"goalState": "achieved"
}
],
"users": [
{
"id": "string",
"channelId": "string",
"memberId": "string",
"veilId": "string",
"unifiedId": "string",
"type": "member",
"name": "string",
"mobileNumberQualified": true,
"emailQualified": true,
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"profileOnce": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"tags": [
"string"
],
"alert": 0,
"unread": 0,
"popUpChatId": "string",
"blocked": true,
"unsubscribeEmail": true,
"unsubscribeTexting": true,
"hasChat": true,
"hasPushToken": true,
"language": "string",
"country": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"web": {
"device": "string",
"os": "string",
"osName": "string",
"browser": "string",
"browserName": "string",
"sessionsCount": 0,
"lastSeenAt": 1656032153127
},
"mobile": {
"device": "string",
"os": "string",
"osName": "string",
"appName": "string",
"appVersion": "string",
"sessionsCount": 0,
"lastSeenAt": 1656032153127
},
"sessionsCount": 0,
"lastSeenAt": 1656032153129,
"createdAt": 1656032153129,
"updatedAt": 1656032153129,
"version": 0,
"managedKey": 0,
"member": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"systemLanguage": "string"
}
],
"managers": [
{
"id": "string",
"channelId": "string",
"accountId": "string",
"name": "string",
"description": "string",
"showDescriptionToFront": true,
"nameDescI18nMap": {
"additionalProp1": {
"name": "string",
"description": "string"
},
"additionalProp2": {
"name": "string",
"description": "string"
},
"additionalProp3": {
"name": "string",
"description": "string"
}
},
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"email": "string",
"showEmailToFront": true,
"mobileNumber": "string",
"showMobileNumberToFront": true,
"role": "owner",
"removed": true,
"createdAt": 1656032151480,
"displayAsChannel": true,
"defaultGroupWatch": "all",
"defaultDirectChatWatch": "all",
"defaultUserChatWatch": "all",
"chatAlertSound": "none",
"showPrivateMessagePreview": true,
"operatorScore": 0,
"touchScore": 0,
"avatar": {
"bucket": "string",
"key": "string",
"width": 0,
"height": 0
},
"operatorEmailReminder": true,
"operator": true,
"operatorScheduling": true,
"operatorTimeRanges": {
"timeRanges": [
{
"dayOfWeeks": [
"mon"
],
"from": 0,
"to": 0
}
]
},
"defaultAllMentionImportant": true,
"userMessageImportant": true,
"autoAssignCapacity": 0,
"statusEmoji": "string",
"statusText": "string",
"statusClearAt": 1656032151487,
"doNotDisturbClearAt": 1656032151487,
"doNotDisturb": true,
"avatarUrl": "string",
"managerId": "string",
"emailForFront": "string",
"mobileNumberForFront": "string"
}
],
"chatTags": [
{
"id": "string",
"channelId": "string",
"colorVariant": "red",
"name": "string",
"key": "string",
"description": "string",
"followerIds": [
"string"
],
"createdAt": 1656032152405
}
]
}
Updated 12 months ago