Represents one member of a chat. Returned by getChatMember, banChatMember, unbanChatMember, and removeChatMember, and pushed to you when a user joins or leaves a chat.

💡 status tells you whether the person is still in the chat. A banned or removed member still comes back as a chatMember — read status, not the presence of the object.

Fields

Field Type Required Description
user User Yes The member.
chat Chat Yes The chat they belong to, or used to.
type String Yes "Member" or "Admin".
status String Yes "Active", "Deleted", "Banned", or "Left".
member_since Timestamp Optional Unix Epoch timestamp of when they joined.
tags Array of String Optional Ids of the tags applied to this member.
account_type String Optional How the user signed up — email or msisdn. Requires the Get User Login ID privilege on the app.
msisdn String Optional The user's email or mobile number. Same privilege applies.

Example

{
  "chatMember": {
    "type": "Member",
    "status": "Active",
    "member_since": 1741955050810,
    "tags": ["1", "2"],
    "chat": {
      "id": "90090684265189649",
      "type": "Channel"
    },
    "user": {
      "id": "24410036587411985"
    }
  }
}