Close a UserChat

Close a particular UserChat

Parameter

Accessible via URL https://api.channel.io/open/v3/user-chats/{userChatId}/close and HTTP PATCH

Parameter

Example

Required

Description

Parameter type

userChatId

5e65fa8bc2409f0c1fd3

Required

ID of UserChat

Path

botName

channelBot

Required

Name of the removing bot

Query

Example

PATCH https://api.channel.io/open/v3/user-chats/5e65fa8bc2409f0c1fd3/close

Response

{
  "userChat": {
    "id": "5e7049961ece389ba6ac",
    "channelId": "10",
    "stateKey": "unassigned-5e7049d3b9ca81a42516",
    "userId": "5e6c24f163a0b21b555c",
    "name": "Heart 547",
    "state": "unassigned",
    "pluginId": "2111",
    "sourceUrl": "String",
    "managerIds": [
      "String"
    ],
    "firstOpenedAt": 1584417174318,
    "openedAt": 1584417174318,
    "createdAt": 1584417174125,
    "frontMessageId": "5e7049d3b9ca80db28d2",
    "frontUpdatedAt": 1584417235761,
    "deskMessageId": "5e7049964da304604546",
    "deskUpdatedAt": 1584417235761,
    "oneStop": false,
    "askedAt": 1584417174318,
    "version": 6
  },
  "message": {
    "chatKey": "String",
    "id": "5e7049964da304604546",
    "channelId": "10",
    "chatType": "userChat",
    "chatId": "5e7049961ece389ba6ac",
    "personType": "user",
    "personId": "5e6c24f163a0b21b555c",
    "requestId": "1584417174075gcww",
    "createdAt": 1584417174318,
    "version": 1,
    "blocks": [
      {
        "type": "text",
        "value": "String"
      }
    ]
  },
  "user": {
    "id": "5e6c24f163a0b21b555c",
    "channelId": "10",
    "memberId": "5e2f0af391bf87a0",
    "veilId": "5e2f0af391bf87a0",
    "name": "Heart 547",
    "alert": 8,
    "unread": 8,
    "blocked": false,
    "unsubscribed": false,
    "hasChat": true,
    "hasPushToken": false,
    "language": "en",
    "country": "KR",
    "city": "Seoul",
    "latitude": 37.4954,
    "longitude": 127.0621,
    "sessionsCount": 5,
    "lastSeenAt": 1584673657636,
    "createdAt": 1584145649408,
    "updatedAt": 1584934318716,
    "version": 8,
    "member": false,
    "contact": false,
    "avatarUrl": "https://cf.channel.io/avatar/emoji/cupid.e9f1a3.png",
    "systemLanguage": "en"
  },
  "userSession": {
    "key": "user-5e6c24f163a0b21b555c-userChat",
    "chatId": "5e7049961ece389ba6ac",
    "chatKey": "userChat-5e7049961ece389ba6ac",
    "updatedKey": "5e7049d3b9ca84cbf6f7",
    "channelId": "10",
    "alert": 1,
    "unread": 1,
    "readAt": 1584417175927,
    "receivedAt": 1584417175927,
    "updatedAt": 1584417235761,
    "createdAt": 1584417174143,
    "version": 5,
    "personType": "user",
    "personId": "5e6c24f163a0b21b555c",
    "chatType": "userChat",
    "bookmark": false,
    "id": "user-5e6c24f163a0b21b555c-userChat-5e7049961ece389ba6ac"
  }
}