文档
测试

获取企业微信外部联系人通讯录

websocket测试
POST
https://api.convergence.com/openim/openImSync

接口描述

该接口登录后首次拉取为全量拉取，后续为增量拉取

请求头

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

请求参数

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

请求参数示例

``` { "uin": 1021885090 } ```

响应参数

参数名
类型
描述
必填
code
Long
状态码
必填
message
String
消息内容
必填
traceId
String
链路跟踪ID
必填
resultType
String
返回结果类型
必填
uin
Long
微信号唯一标志
必填
deviceId
String
设备ID
必填
openImChatRoomContactList
Array
外部群聊集合
必填
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
群成员集合
必填
userName
String
群成员ID
必填
chatroomMemberFlag
Integer
默认为1
必填
*
其他为空，需要通过拉取群成员详情获取
必填
contactType
Integer
联系人各类权限标志位
必填
roomName
String
群用户名(openimChatroomUsername)
必填
svrChatroomVersion
Integer
服务器群版本号
必填
svrMemberVersion
Integer
服务器群成员版本号
必填
unknowTag11
Integer
默认为0
必填
unknowTag9
Integer
默认为-1
必填
openImContactList
Array
外部好友集合
必填
antispamTicket
String
Ticket(用于添加好友)
必填
appId
String
appId
必填
bigHeadImg
String
头像
必填
customInfoDetail
String
客户信息详情
必填
customInfoDetailVisible
Integer
客户信息详情是否可看(1:可查看)
必填
descWordingId
String
企业ID
必填
nickName
String
昵称
必填
nicknamePyinit
String
昵称缩写
必填
nicknameQuanpin
String
昵称全拼
必填
remark
String
备注名
必填
remarkPyinit
String
备注名缩写
必填
remarkQuanpin
String
备注名全拼
必填
sex
String
性别(1:男/2:女)
必填
smallHeadimg
String
头像缩略图
必填
source
String
好友添加方式
必填
tpUsername
String
用户ID(openimUsername)
必填
type
Integer
类型
必填

异步回调参数示例

``` { "code": 0, "deviceId": "f96a39e896f09f497bcf38dac65a4f86", "message": "", "openImChatRoomContactList": [ { "appId": "2000000000", "chatRoomNotify": 1, "chatroomData": { "announcement": "阿道夫", "announcementEditor": "25984985414157641@openim", "announcementPublishTime": 1590052504, "bigHeadImgUrl": "http://wx.qlogo.cn/mmcrhead/TU9nxKFGLUSHiaV0ZGJDfLzyfqMTg4M744cd1jML5JMdFBezcBbJhUyMSZGGznWiaQTzPVDb4ZJasfxkCr2t5bOxkibN4v81Tn4/0", "chatRoomMaxCount": 500, "extFlag": 2, "imgFlag": 2, "owner": "25984985414157641@openim", "smallHeadImgUrl": "http://wx.qlogo.cn/mmcrhead/TU9nxKFGLUSHiaV0ZGJDfLzyfqMTg4M744cd1jML5JMdFBezcBbJhUyMSZGGznWiaQTzPVDb4ZJasfxkCr2t5bOxkibN4v81Tn4/0", "topic": "测试群", "topicPyinit": "CSQ", "topicQuanpin": "ceshiqun", "unknowTag13": 0 }, "chatroomMemberBasicInfo": 1, "chatroomMemberCount": 6, "chatroomMemberData": [ { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 0, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_494e258wzq9a22" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984983640277613@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984985414157641@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984985622785479@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "25984983696890961@openim" }, { "appId": "", "bigHeadimgUrl": "", "chatroomMemberFlag": 1, "descWordingId": "", "displayName": "", "inviterUserName": "", "nickName": "", "smallHeadimgUrl": "", "userName": "wxid_evwonz075ayh21" } ], "contactType": 2, "roomName": "9223372041441152049@im.chatroom", "svrChatroomVersion": 6, "svrMemberVersion": 6, "unknowTag11": 0, "unknowTag9": -1 } ], "openImContactList": [ { "antispamTicket": "", "appId": "3552365301", "bigHeadimg": "http://wework.qpic.cn/bizmail/icZIj4acabOSMWlcw6xBKCH4Kve7MiazCngqVxLa7ibIbhwthokjM8FlQ/0", "customInfoDetail": "{\"custom_info\":[{\"title\":\"企业\",\"detail\":[{\"icon\":\"https://rescdn.qqmail.com/node/wework/images/icon_company_certified_3x.png\",\"desc\":\"257C7DDB9194E99947CF021400B5A89DRI01@im.wxwork\",\"desc_type\":1,\"action\":4,\"action_param\":{\"url\":\"https://work.weixin.qq.com/wework_admin/user/h5/corp?from=wx_plugin&vid_code_wx=144CF1610000000029310561126FB04E14CBCB13A979664604AF6D915EBAAD691BC39245FEBF7E2D58FDD5A902C5B0DC52A70E8F9BCE4D3666931A18C5B3B8059C061FAF83AE5D65\"}}]},{\"title\":\"实名\",\"detail\":[{\"icon\":\"https://rescdn.qqmail.com/node/wework/images/icon_realname_newv2.png\",\"desc\":\"**林\",\"desc_type\":0,\"action\":1}]},{\"title\":\"职务\",\"detail\":[{\"desc\":\"首席福利官\",\"desc_type\":0,\"action\":1}]}]}", "customInfoDetailVisible": 1, "descWordingId": "257C7DDB9194E99947CF021400B5A89DRI01@im.wxwork", "nickName": "首席福利官lucky", "nicknamePyinit": "SXFLGLUCKY", "nicknameQuanpin": "shouxifuliguanlucky", "remark": "", "remarkPyinit": "", "remarkQuanpin": "", "sex": 1, "smallHeadimg": "http://wework.qpic.cn/bizmail/icZIj4acabOSMWlcw6xBKCH4Kve7MiazCngqVxLa7ibIbhwthokjM8FlQ/140", "source": 30, "tpUsername": "25984984054431058@openim", "type": 1 } ], "resultType": "OPENIM_syncContact", "traceId": "3c629431efa34444af9cd9ba4bde3744", "uin": 1021885090 } ```
上一篇 获取小程序详情
nextDoc 获取企业微信外部联系人详情
本文档使用易文档编写, 更新时间: 2020-05-26 10:01