获取群聊成员列表
GET
/open-api/group_chat/member/list获取群聊成员列表。可以通过group_chat_id获取指定群聊的成员列表
错误码 | 说明 |
---|---|
20206 | id 错误,找不到对应客户 |
20207 | unionid 错误,找不到对应客户 |
20208 | unionid 和 id 必须至少提供一个 |
调用此接口需购买基础席位。 |
请求参数
Query 参数
group_chat_id
string
企业群聊id
示例值:
wr8xjUCAAAb4IiVmBjWjHSwHTXxPa9-A
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errcode
integer
必需
状态码,0为正常,非0代表错误。业务错误码下述,全局错误码见 全局错误码
errmsg
string
必需
错误信息,成功时为'ok',错误时会以中文方式显示错误原因
member_list
array [object {14}]
客户列表
chat_msg_count
integer | null
消息数量
created_at
integer
必需
数据创建时间(微伴系统内时间)
deleted
boolean
是否退群
deleted_time
integer | null
退群时间
group_id
string
客户群ID
id
integer
必需
群成员id(主键)(微伴内部id)
join_scene
integer
必需
入群方式入群方式。1 - 由成员邀请入群(直接邀请入群)2 - 由成员邀请入群(通过邀请链接入群)3 - 通过扫描群二维码入群
join_time
integer
群成员加入时间
other_name
string | null
必需
user_id
string
必需
群成员id(企业微信userid)
user_type
integer
必需
群成员类型。 1 - 企业成员 2 - 外部联系人
invitor_ext_id
string | null
邀请人
last_chat_msg_time
integer | null
最近一次聊天的时间
unionid
string
客户unionid
total
integer
群成员总数
示例
{
"errcode": 0,
"errmsg": "ok",
"member_list": [
{
"chat_msg_count": null,
"created_at": 1582013715,
"deleted": false,
"deleted_time": null,
"group_id": "wr8xjUCAAAb4IiVmBjWjHSwHTXxPa9-A",
"id": 2,
"invitor_ext_id": "PanPan",
"join_scene": 1,
"join_time": 1581577730,
"last_chat_msg_time": null,
"unionid": null,
"user_id": "PanPan",
"user_type": 1
},
{
"chat_msg_count": null,
"created_at": 1582013715,
"deleted": false,
"deleted_time": null,
"group_id": "wr8xjUCAAAb4IiVmBjWjHSwHTXxPa9-A",
"id": 3,
"invitor_ext_id": "Shiyan",
"join_scene": 3,
"join_time": 1581580191,
"last_chat_msg_time": null,
"unionid": "omefmt_T_WQs_h4QolC1RQ4udWG4",
"user_id": "wm8xjUCAAAu4nT-CRhEFbNNGfY-N6tLw",
"user_type": 2
}
],
"total": 2
}
最后修改时间: 5 个月前