获取联系人列表

本接口已迁移，请前往小组级接口文档查看（以A区为例）【获取联系人列表】

请求参数

Query 参数

token

string

调用接口凭证

必需

current

string

必需

页码, 默认为0，即第一页

pageSize

string

必需

每页数量, 默认为10，最大为1000

wxid

string

可选

需要搜索的客户系统id，当传入此参数时，current 和 pageSize 失效

includeStranger

string

可选

当传入这个参数为字符串"true"的时候，会在结果中返回单删好友

返回响应

🟢200成功

application/json

Body

code

number

返回码

必需

data

array [object {18}]

联系人数据

必需

chatId

string

该联系人的对话ID

可选

botInfo

object

所属托管账号信息

可选

wxid

string

系统联系人id

可选

weixin

number

企业微信员工id

可选

nickName

string

昵称

可选

alias

string

备注

可选

avatarUrl

string

头像

可选

city

string

省份信息

可选

province

string

城市信息

可选

gender

enum<number>

性别

可选

枚举值:

012

labels

array [object {2}]

自定义标签信息

可选

contactType

enum<number>

联系人类型

可选

枚举值:

0123

coworker

boolean

是否为同事（同一个企业下的员工）

可选

unionId

string

联系人开放平台id，需要安装自建应用后才会返回

可选

externalUserId

string

企业微信外部联系人id

可选

deleted

boolean

是否已删除

可选

friendshipStatus

enum<number>

好友状态

必需

枚举值:

0123

tags

array [object {1}]

企微标签信息

可选

page

object

必需

current

integer

当前页码

必需

total

integer

总数据条数

必需

示例

{
  "code": 0,
  "data": [
    {
      "chatId": "string",
      "botInfo": {
        "wxid": "string",
        "weixin": "string",
        "nickName": "string"
      },
      "wxid": "string",
      "weixin": 0,
      "nickName": "string",
      "alias": "string",
      "avatarUrl": "string",
      "city": "string",
      "province": "string",
      "gender": 0,
      "labels": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "contactType": 0,
      "coworker": true,
      "unionId": "string",
      "externalUserId": "string",
      "deleted": true,
      "friendshipStatus": 0,
      "tags": [
        {
          "labelName": "string"
        }
      ]
    }
  ],
  "page": {
    "current": 0,
    "total": 0
  }
}

请求参数

示例代码

返回响应