# 通过 unionid 获取客户详情

请求方式: GET

请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-member/v1/customer/get-by-qw_union_id

请求参数说明:

参数 类型 必须 说明
app_id string 企微中台应用 id
qw_union_id string 企微外部联系人 union_id

请求参数示例:

https://nbd-api.myscrm.cn/open-nbd-qw-member/v1/customer/get-by-qw_union_id?app_id=xxxx&qw_union_id=xxxx

返回数据:

{
  "errcode": 0,
  "errmsg": "ok",
  "customer": {
    "qw_external_userid": "string",
    "qw_name": "string",
    "e_id": "string",
    "avatar_oss_path": "string",
    "qw_avatar": "string",
    "qw_gender": 0,
    "qw_unionid": "string",
    "qw_position": "string",
    "qw_corp_name": "string",
    "qw_corp_full_name": "string"
  }
}

返回参数说明:

名称 类型 说明
customer object 客户信息
customer.qw_external_userid string 企微外部联系人的 userid
customer.qw_name string 企微外部联系人名称
customer.e_id string 企微中台企业 id
customer.avatar_oss_path string 头像 oss path
customer.qw_avatar string 企微头像
customer.qw_gender int32 性别。0 表示未定义,1 表示男性,2 表示女性
customer.qw_unionid string 企微外部联系人在微信开放平台的唯一身份标识(微信 unionid)
customer.qw_position string 企微职务信息
customer.qw_corp_name string 企微外部联系人所在企业的简称
customer.qw_corp_full_name string 企微外部联系人所在企业的主体名称