文档
测试

获取企业微信外部联系人详情

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

请求头

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

请求参数

参数名
类型
描述
必填
uin
Long
微信号唯一标志
必填
openimUsername
String
用户ID
必填
openimChatroomUsername
String
群ID(获取群内成员需要传该参数)
可选
traceId
String
链路跟踪ID
可选

请求参数示例

- 拉取外部群内成员 ``` { "uin": 1021885090, "openimUsername": "25984983172698739@openim", "openimChatroomUsername": "9223372041357564447@im.chatroom" } ``` - 拉取外部联系人 ``` { "uin": 1021885090, "openimUsername": "25984983172698739@openim" } ```

响应参数

参数名
类型
描述
必填
uin
Long
微信号唯一标志
必填
resultType
String
返回结果类型
必填
deviceId
String
设备ID
必填
traceId
String
链路跟踪ID
必填
openImContact
Object
外部联系人信息
必填
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
类型
必填

异步返回参数示例

``` { "deviceId": "f96a39e896f09f497bcf38dac65a4f86", "openImContact": { "antispamTicket": "v1_8e33331c8947042ac16dcd52d42363d6b89d6f10fccb77c86f31e7214e9739adaa0dd1433ea49093446c0b3605ab1f2cd13ffaf35cebc7cebea78fcbe3839fab87e3cd3a73d8cf9908d0759e0a4441f17e0c9093d59889193a96bc006a594848a8cb033049fda9ed1d546edb73080d2d", "appId": "3552365301", "bigHeadimg": "https://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssaeRc7TjqMeK3hoibjTzM69ibgh4WfB3z4ib1fmyucxj5zMqy0ul6By66wQ/0", "customInfoDetail": "{\"custom_info\":[{\"title\":\"企业\",\"detail\":[{\"icon\":\"https://rescdn.qqmail.com/node/wework/images/icon_company_certified_3x.png\",\"desc\":\"A77E3D86BEDAB74F18A14C558865C564RI01@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=0276E22C000000007ED4FD649A2192880E2FDB4C5F44FCB80712A1407BC860D4DCDA13610E6D9FAFB0713867340EDDBD96DADAEB4CB5909B648162D8E6426426B01B044D246C7C29\"}}]},{\"title\":\"实名\",\"detail\":[{\"icon\":\"https://rescdn.qqmail.com/node/wework/images/icon_realname_newv2.png\",\"desc\":\"哈哈哈\",\"desc_type\":0,\"action\":1}]}]}", "customInfoDetailVisible": 1, "descWordingId": "A77E3D86BEDAB74F18A14C558865C564RI01@im.wxwork", "nickName": "哈哈哈", "nicknamePyinit": "HHH", "nicknameQuanpin": "hahaha", "remark": "", "remarkPyinit": "", "remarkQuanpin": "", "sex": 1, "smallHeadimg": "https://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssaeRc7TjqMeK3hoibjTzM69ibgh4WfB3z4ib1fmyucxj5zMqy0ul6By66wQ/140", "source": 0, "tpUsername": "25984983172698739@openim", "type": 0 }, "resultType": "OPENIM_getContact", "traceId": "dfe2fa683a1f4c91a96d219c28372950", "uin": 1021885090 } ```