1.1. 外部群信息
该接口用于获取外部群信息
1.1.1. 请求方法
POST api/v1/getExternalGroup
1.1.2. 请求参数
参数 | 是否必须 | 说明 |
---|---|---|
corpId | 是 | 企业微信corpId |
chatId | 是 | 客户群ID |
1.1.3. 入参示例
{
"corpId":"wxxxxxxxxxxx078",
"chatId":"xxxxxxxxx"
}
1.1.4. 返回数据
属性名 | 类型 | 说明 |
---|---|---|
errcode | 整型 | 返回码 |
errmsg | 字符串 | 对返回码的文本描述内容 |
group_chat | 对象 | 外部群对象 |
- chat_id | 字符串 | 客户群ID |
- name | 字符串 | 群名 |
- owner | 字符串 | 群主ID |
- create_time | 字符串 | 群的创建时间 |
- notice | 字符串 | 群公告 |
- member_list | 对象数组 | 群成员列表 |
- - userid | 字符串 | 群成员id |
- - type | 整型 | 成员类型。1 - 企业成员 2 - 外部联系人 |
- - unionid | 字符串 | 外部联系人在微信开放平台的唯一身份标识(微信unionid),仅当群成员类型是微信用户(包括企业成员未添加好友) |
- - join_time | 字符串 | 入群时间 |
- - join_scene | 整型 | 入群方式。1 - 由群成员邀请入群(直接邀请入群) 2 - 由群成员邀请入群(通过邀请链接入群) 3 - 通过扫描群二维码入群 |
- - invitor | 字符串 | 邀请者。目前仅当是由本企业内部成员邀请入群时会返回该值 |
- - invitor.userid | 字符串 | 邀请者的userid |
- - group_nickname | 字符串 | 在群里的昵称 |
- - name | 字符串 | 名字。仅当 need_name = 1 时返回 如果是微信用户,则返回其在微信中设置的名字 如果是企业微信联系人,则返回其设置对外展示的别名或实名 |
- admin_list | 对象数组 | 群管理员列表 |
- - userid | 字符串 | 群管理员userid |
1.1.5. 返回示例
{
"errcode": 0,
"errmsg": "ok",
"group_chat": {
"chat_id": "wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
"name": "销售客服群",
"owner": "ZhuShengBen",
"create_time": 1572505490,
"notice": "文明沟通,拒绝脏话",
"member_list": [{
"userid": "abel",
"type": 1,
"join_time": 1572505491,
"join_scene": 1,
"invitor": {
"userid": "jack"
},
"group_nickname" : "客服小张",
"name" : "张三丰"
}, {
"userid": "wmOgQhDgAAuXFJGwbve4g4iXknfOAAAA",
"type": 2,
"unionid": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
"join_time": 1572505491,
"join_scene": 1,
"group_nickname" : "顾客老王",
"name" : "王语嫣"
}],
"admin_list": [{
"userid": "sam"
}, {
"userid": "pony"
}]
}
}