获取客户详情 - 微伴助手OpenAPI

只有在企业微信侧完成了微信开发者ID绑定后才可在企业微信用户系统和微伴助手用户系统中通过 unionid 关联到具体客户。绑定方法见企业微信unionid绑定流程。调用此接口需购买基础席位。

错误码	说明
20206	id 错误，找不到对应客户
20207	unionid 错误，找不到对应客户
20208	unionid 和 id 必须至少提供一个

请求参数

Query 参数

可选

客户id。对应企业微信客户 id。id 和 unionid必须选择一个填写

示例值:

wm8zkSaSL7dgds4s45fw

unionid

string

可选

客户 unionid。id 和 unionid 必须选择一个填写

示例值:

oYtnV58v4QOisCZdE4qU02eK1pvU

openid

string

可选

客户 openid，密文企业选择unionid时需填写

示例值:

ohpYX63Ss6YnNTdv9YKcjpPGnBhA

access_token

string

调用接口凭证

必需

默认值:

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer

可选

状态码，0为正常，非0代表错误。业务错误码下述，全局错误码见全局错误码

errmsg

string

可选

错误信息，成功时为'ok'，错误时会以中文方式显示错误原因

total

integer

session总量

可选

external_user

object

客户列表

可选

string

可选

外部联系人id（主键）

type

integer

可选

外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户

unionid

string | null

可选

仅当联系人类型是微信用户，且企业绑定了微信开发者ID有此字段

created_at

integer

可选

数据创建时间（微伴系统内时间）

name

string

外部联系人昵称

可选

avatar

string

外部联系人头像

可选

corp_full_name

string | null

可选

外部联系人所在企业的主体名称，仅当联系人类型是企业微信用户时有此字段

corp_name

string | null

可选

外部联系人所在企业的简称，仅当联系人类型是企业微信用户时有此字段

gender

integer

可选

外部联系人性别 0-未知 1-男性 2-女性

position

string | null

可选

外部联系人的职位，如果外部企业或用户选择隐藏职位，则不返回，仅当联系人类型是企业微信用户时有此字段

external_profile

object | null

可选

外部联系人的自定义展示信息，可以有多个字段和多种类型，包括文本，网页和小程序，仅当联系人类型是企业微信用户时/有此字段，字段详情见企业微信对应文档

follow_staffs

array [object {27}]

可选

员工关系数组，为空表示客户当前未添加任何员工

custom_fields

array [object {9}]

客户自定义信息列表

可选

corp_id

string

客户所在公司ID

可选

created_at

integer

自定义信息创建时间

可选

deleted

boolean

是否被删除

可选

field_type

string

可选

自定义信息类型，支持text、option_text、datetime

field_value

string

自定义信息的值

可选

has_staff_used

boolean

可选

员工是否使用该自定义信息

integer

自定义信息id

可选

name

string

自定义信息名称

可选

rank_num

integer

自定义信息排序

可选

示例

{
  "errcode": 0,
  "errmsg": "ok",
  "total": 1,
  "external_user": {
    "id": "wm8xjUCAAAS4ozkSaSL7WIyxhV3iROJw",
    "type": 1,
    "unionid": "oz9xvw_jfkmHMGWVSn5CatKSTOMU",
    "created_at": 1579243948,
    "name": "clth",
    "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM6uFkY7eOZOK4bo3lMOKdYBcYrWYZ8cFuxYj6iaULHjLibQ/0",
    "corp_full_name": null,
    "corp_name": null,
    "gender": 1,
    "position": null,
    "external_profile": null,
    "follow_staffs": [
      {
        "staff_id": "zhangsan",
        "staff_name": "张三",
        "staff_avatar": "http://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssaYfX71u0Rya0GdmcJWhR6qBgbjkqiaSIKkicTy1wVhr9tQoTMP4rCxFLM/0",
        "state": "wb:269",
        "state_text": "通过渠道码 xx 添加",
        "state_type": "corp_contact_way",
        "remark": "微伴客户",
        "remark_state": "微伴渠道",
        "description": "",
        "remark_corp_name": "夜莺科技",
        "remark_mobiles": "[]",
        "deleted_at": 1591940337,
        "deleted_by": "external_user",
        "deleted_each_other": false,
        "age": "26",
        "phone_number": "13000000000",
        "qq": "487892822",
        "weibo": "zhangsan",
        "email": "487892822@qq.com",
        "address": "武汉市",
        "birthday": "2月15",
        "custom_fields": [
          {
            "corp_id": "1654076890000000000",
            "created_at": 1618383250,
            "deleted": false,
            "field_type": "text",
            "field_value": "",
            "has_staff_used": true,
            "id": 307,
            "name": "自定义信息3",
            "rank_num": 2
          },
          {
            "corp_id": "1654076890000000000",
            "created_at": 1618560293,
            "deleted": false,
            "field_type": "text",
            "field_value": "",
            "has_staff_used": true,
            "id": 331,
            "name": "自定义信息2",
            "rank_num": 1
          },
          {
            "corp_id": "1654076890000000000",
            "created_at": 1619091933,
            "deleted": false,
            "field_type": "text",
            "field_value": "",
            "has_staff_used": true,
            "id": 332,
            "name": "自定义信息1",
            "rank_num": 0
          }
        ],
        "tags": [
          {
            "group": "城市",
            "name": "武汉市"
          },
          {
            "group": "渠道类型",
            "name": "线下"
          }
        ],
        "internal_tags": [
          {
            "name": "已沟通"
          }
        ]
      }
    ]
  }
}

🟢200正常返回