getChat | Notion

Retrieves the details of a group or channel — title, description, photo, member count, invite link and tags.

Request

method is "getChat".

Field	Type	Required	Description
`chat_id`	String	Yes	The group or business channel to look up.
`app_id`	String	Yes	The app the chat belongs to.
`reference`	String	Optional	Your id for this request. Echoed back in the response.

Preconditions

Requirement	Why
`"Manage Chats"` permission	Needed to read chat details.

Response

chatDetails

Field	Type	Returned	Description
`method`	String	Yes	`"chatDetails"`
`chat`	Chat	Yes	The full chat record.
`app_id`	String	Yes	Echoed from the request.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	Callback
Java	`api.getChat(chatId, appId, reference);`	`onChatDetails(Chat chat, String appId)`
JavaScript	`api.getChat(chatId, appId, reference);`	`onChatDetails(chat, appId)`
Python	`napi.get_chat(chat_id=chat_id, app_id=app_id, reference=reference)`	`on_chat_details(self, chat, app_id)`

Example

Request

{
  "method": "getChat",
  "chat_id": "90090684438172188",
  "app_id": "90090700613754551",
  "reference": "123456789"
}

api.getChat("90090684438172188", "90090700613754551", "123456789");

api.getChat("90090684438172188", "90090700613754551", "123456789");

napi.get_chat(chat_id="90090684438172188", app_id="90090700613754551", reference="123456789")

Response

{
  "method": "chatDetails",
  "app_id": "90090700613754551",
  "reference": "123456789",
  "chat": {
    "id": "90090684438172188",
    "title": "Group Name",
    "type": "Group",
    "description": "Test new group",
    "category": "S",
    "language_code": "en",
    "member_count": 2,
    "version": "vT9kSn",
    "invite_link": "<https://djoin.ndbx.me/join?id=oI8TSxmwrNoZlWQz4%2BdfdME01yf%2FXq1D4hGcb%2Fo8x2k%3D&type=Group&pay=0&vappId=0>",
    "photo": {
      "id": "V_vT9kSn_nullde6c172db6a9b5d9764ea99a1371ed5495d1dda12ffaa56b4b3b55428980b446.jpg",
      "width": 256,
      "height": 256,
      "thumbnail": {
        "id": "V_vT9kSn_nullde6c172db6a9b5d9764ea99a1371ed5495d1dda12ffaa56b4b3b55428980b446.jpg.thumb.jpg",
        "width": 120,
        "height": 120
      }
    },
    "image": "/9j/4AAQSkZJRgABAgAAAQABAAD…",
    "tagsDefinition": null
  }
}