文档
测试

获取企业微信外部群聊详情

POST
https://api.convergence.com/openim/openImGetChatroomContact

请求头

参数名
类型
描述
必填
Content-Type
application/json
必填

请求参数

参数名
类型
描述
必填
uin
Long
微信号唯一标志
必填
openimChatroomUsername
String
群ID
必填
traceId
String
链路跟踪ID
可选

请求参数示例

``` { "uin": 1021885090, "openimChatroomUsername": "9223372041357564447@im.chatroom" } ```

响应参数

参数名
类型
描述
必填
code
Integer
状态码
必填
antispamTicket
String
Ticket(用于添加好友接口)
必填
appId
String
appId
必填
bigHeadimg
String
头像
必填
customInfoDetail
String
客户信息详情
必填
customInfoDetailVisible
Integer
客户信息是否可查看
必填
descWordingId
String
企业ID
必填
nickName
String
昵称
必填
nicknamePyinit
String
昵称缩写
必填
nicknameQuanpin
String
昵称全拼
必填
remark
String
备注
必填
remarkPyinit
String
备注缩写
必填
remarkQuanpin
String
备注全拼
必填
sex
Integer
性别(1男/2女)
必填
smallHeadimg
String
头像缩略图
必填
source
Integer
添加方式
必填
tpUsername
String
用户ID
必填
type
Integer
类型
必填
code
Integer
状态码
必填
deviceId
String
设备ID
必填
message
String
消息内容
必填
openImChatRoomContact
Object
外部群聊对象
必填
appId
String
appId
必填
chatRoomNotify
Integer
消息免打扰(1:未开启消息免打扰/0:开启消息免打扰)
必填
chatroomData
Object
群详情数据
必填
announcement
String
群公告
必填
announcementEditor
String
群公告编辑者
必填
announcementPublishTime
Long
群公告发布时间戳
必填
bigHeadImgUrl
String
群头像
必填
chatRoomMaxCount
Integer
群人数上限
必填
extFlag
Integer
群聊邀请确认标识位(1未开启/2开启/3未知)
必填
imgFlag
Integer
扫描二维码进群标识位(2允许/3禁用)
必填
owner
String
群主
必填
smallHeadImgUrl
String
群头像缩略图
必填
topic
String
群昵称
必填
topicPyinit
String
群昵称缩写
必填
topicQuanpin
String
群昵称拼音
必填
unknowTag13
Integer
默认为0
必填
chatroomMemberBasicInfo
Integer
默认为1,暂未清楚作用
必填
chatroomMemberCount
Integer
当前群成员数量
必填
chatroomMemberData
Array
群成员集合
必填
appId
String
appId
必填
bigHeadimgUrl
String
群头像
必填
chatroomMemberFlag
Integer
默认为1
必填
descWordingId
String
企业ID
必填
displayName
String
群内昵称
必填
inviterUserName
String
邀请人ID
必填
nickName
String
微信昵称
必填
smallHeadimgUrl
String
头像缩略图
必填
userName
String
群成员ID
必填
contactType
Integer
联系人各类权限标志位
必填
roomName
String
群用户名(openimChatroomUsername)
必填
svrChatroomVersion
Integer
服务器群版本号
必填
svrMemberVersion
Integer
服务器群成员版本号
必填
unknowTag11
Integer
默认为0
必填
unknowTag9
Integer
默认为-1
必填
resultType
String
返回结果类型
必填
traceId
String
链路跟踪ID
必填
uin
Long
微信号唯一标志
必填

异步返回参数示例

``` { "code": 0, "deviceId": "f96a39e896f09f497bcf38dac65a4f86", "message": "\n\u0000", "openImChatRoomContact": { "appId": "2000000000", "chatRoomNotify": 1, "chatroomData": { "announcement": "", "announcementEditor": "", "announcementPublishTime": 0, "bigHeadImgUrl": "http://wx.qlogo.cn/mmcrhead/ty0OWoxYWrTNNoImDsRWSU2tI2KDkqLaawhN7icPJiaGS84W70TJHkwSfo5IcicG2YpJzG30hcLMTw44ujNMLeQgsQCbf2PAGBh/0", "chatRoomMaxCount": 500, "extFlag": 3, "imgFlag": 2, "owner": "25984981831830680@openim", "smallHeadImgUrl": "http://wx.qlogo.cn/mmcrhead/ty0OWoxYWrTNNoImDsRWSU2tI2KDkqLaawhN7icPJiaGS84W70TJHkwSfo5IcicG2YpJzG30hcLMTw44ujNMLeQgsQCbf2PAGBh/0", "topic": "哈哈哈", "topicPyinit": "HHH", "topicQuanpin": "hahaha", "unknowTag13": 0 }, "chatroomMemberBasicInfo": 1, "chatroomMemberCount": 7, "chatroomMemberData": [ { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_jmg3nu2goog222" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_494e258wzq9a22" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_mnrket6lplwy22" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984981831830680@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984983172698739@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984985575648782@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_yxiqrtvdu49422" } ], "contactType": 2051, "roomName": "9223372041357564447@im.chatroom", "svrChatroomVersion": 2, "svrMemberVersion": 8, "unknowTag11": 0, "unknowTag9": -1 }, "resultType": "OPENIM_getChatroomContact", "traceId": "ecb81d9b8f5c4dff9d3e3a4683c0c889", "uin": 1021885090 } ```