同步企微好友

POST

/im/sync

基础API/联系人模块

本接口为长耗时接口，耗时时间根据好友数量递增，若接口超时可通过获取通讯录列表缓存接口获取响应结果

注意：
此接口未返回的群聊，当有人在群内发言时，会有回调消息推送到调用方，此时可通过获取群信息接口拿到此群的信息做后续处理

请求参数

Header 参数

VideosApi-token

string

必需

示例值:

Body 参数application/json

appId

string

设备ID

必需

示例

{
  "appId": "{{appid}}"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://api.videosapi.com/finder/v2/api/im/sync' \
--header 'VideosApi-token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "{{appid}}"
}'

返回响应

🟢200成功

application/json

Body

ret

integer

必需

msg

string

必需

data

object

必需

friends

array[string]

好友的wxid

必需

chatrooms

array[string]

必需

保存到通讯录中群聊的ID

ghs

array[string]

关注的公众号ID

必需

示例

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "friends": [
      "tmessage",
      "medianote",
      "qmessage",
      "qqmail",
      "wxid_910acevfm2nb21",
      "qqsafe",
      "wxid_9299552988412",
      "weixin",
      "exmail_tool",
      "wxid_mp05xmje0ctn22",
      "wxid_09oq4f4j4wg912",
      "wxid_6bfguz79h8n122",
      "wxid_lyuq4hr4lrjq22",
      "wxid_a1zqyljsrsdu12",
      "wxid_lv3pb3zhna3522",
      "wxid_k2biq6fuinsr22",
      "wxid_ujredjhxz9y712",
      "wxid_uwb7989u0jea12",
      "wxid_in46ey732vxu12",
      "wxid_3rvervwohj6921",
      "wxid_4wkls7tu62ua12",
      "wxid_g0bdknnotx2f12",
      "wxid_ce5fgp0icb3y21",
      "wxid_1482424825211",
      "wxid_vw3p4f6jy7bm12",
      "wxid_o2m8xm71c23522",
      "wxid_bclqpc2ho6o412",
      "wxid_98pjjzpiisi721",
      "wxid_noq2wsn5c8h222"
    ],
    "chatrooms": [
      "2180313478@chatroom",
      "14358945067@chatroom",
      "17362526147@chatroom",
      "11685224357@chatroom",
      "17522822550@chatroom"
    ],
    "ghs": [
      "gh_7aac992b0363",
      "gh_d7293b5f14f4",
      "gh_f51ce3ef83a4",
      "gh_7d20df86e26b",
      "gh_69bfb92a3e43"
    ]
  }
}

上传手机通讯录

获取企微好友详情