List of UserChats

List of UserChats in managed state.

Parameter

Accessible via URL https://api.channel.io/open/v5/user-chats and HTTP GET

📘

Present parameters in query string

Parameter

Example

Required

Description

Parameter type

state

opened

Required

User chat state filter. Available values closed, opened, snoozed(default value: opened).

Query

sortOrder

desc

Required

Sorting order. Available values are asc, desc, both(default value: desc).

Query

since

eyJjaGF0S2V5IjoiZ3Jvn0=

Optional

Encoded key of the first user chat to be retrieved

Query

limit

40

Optional

Restrict the maximum number of direct chats to be retrieved. It should be between 1 to 500. Default value is 25.

Query

Example

GET http://api.channel.io/open/v5/user-chats?state=opened&sortOrder=desc&since=eyJjaGF0S2V5IjoiZ3Jvn0=&limit=40

Response

Return a set of UserChat objects.

{
   "prev":"string",
   "next":"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"
      }
   ],
   "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"
      }
   ],
   "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
      }
   ]
}

Implementation note

The number of user chats retrieved in this endpoint is restricted by the limit query parameter, and is capped to values in the closed interval [1, 500].

Retrieved user chats can be filtered by opened, snoozed, and closed through the state query parameter.

Pagination is supported through the since query parameter along with the next value contained in the root object of the JSON response. Successive queries to this endpoint using the previous next value as the since parameter will ultimately retrieve all user chats.

The since parameter can be left empty to start the list.