# Group Chat (In design...)

# Group Chat List

GET */api/v1/groupChat/list?token=*&current=*&pageSize=*

# Request parameters

name	type	required	description
token	string	yes	token to authenticate
current	string	yes	current page
pageSize	string	yes	page size for the data

TIP

This API support get the group chat data in batch, the max pageSize is 100

# Sample data:

{
  errcode: 0,
  errmsg: "ok"
  data:[{
    chatId: 'wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ',
    name: '群名称',
    owner: 'owner',
    createTime: 1532336327,
    notice: '群公告',
    memberList: [{
      type: 1,
      userId: 'userId',
      joinTime: 1605001966,
      joinScene: 1,
    }, {
      type: 2,
      userId: 'externalUserId',
      joinTime: 1605001977,
      joinScene: 1,
    }]
  }],
  total: 10
}

# Description

name	type	required	description
errcode	number	yes	return code
errmsg	string	yes	error message
data.chatId	string	yes	group chat id
data.name	string	yes	group chat name
data.owner	string	yes	group chat owner id
data.createTime	number	yes	the create time of the group
data.notice	string	no	the group announcement
data.memberList.userid	string	yes	the group member id
data.memberList.type	string	yes	type of group member, 1 is corp member, 2 external contact
data.memberList.joinTime	number	yes	join group time
data.memberList.joinScene	number	yes	join group scene: 1 direct invite by group member, 2 invite by group member with link card, 3 scan qr-code to join the group

# Group Chat Info

POST */api/v1/groupChat/get?token=*

# Request parameters

name	type	required	description
token	string	yes	token for authorization
groupChatIds	array	yes	group chat id list

TIP

This API supports pulling group chat info in batch, the max length of groupChatIds is 100.

# Sample data:

{
  errcode: 0,
  errmsg: "ok"
  data:[{
    chatId: 'wrG3O4AAAAA8bbFkg5q6q0M0Sdp-QQQQ',
    name: '群名称',
    owner: 'owner',
    createTime: 1532336327,
    notice: '群公告',
    memberList: [{
      type: 1,
      userId: 'userId',
      joinTime: 1605001966,
      joinScene: 1,
    }, {
      type: 2,
      userId: 'externalUserId',
      joinTime: 1605001977,
      joinScene: 1,
    }]
  }],
  total: 10
}

# Description

name	type	required	description
errcode	number	yes	return code
errmsg	string	yes	error message
data.chatId	string	yes	group chat id
data.name	string	yes	group chat name
data.owner	string	yes	group chat owner id
data.createTime	number	yes	create time of the group chat
data.notice	string	no	group chat announcement
data.memberList.userid	string	yes	the group member id
data.memberList.type	string	yes	type of group member, 1 is corp member, 2 external contact
data.memberList.joinTime	number	yes	join group time
data.memberList.joinScene	number	yes	join group scene: 1 direct invite by group member, 2 invite by group member with link card, 3 scan qr-code to join the group

← Users Tag →