更新时间:2024-09-24 GMT+08:00
分享

查询客户列表(旧)

功能介绍

伙伴可以查询合作伙伴的客户信息列表。

该接口即将下线,“查询客户列表”新接口请参考查询客户列表

Web UI

伙伴可以登录合作伙伴中心查询合作伙伴的客户信息列表。

  1. 在伙伴中心顶部导航栏中选择“销售 > 客户业务 > 我的客户”。
  2. 设置查询条件,筛选出待查询的客户。

    伙伴可以根据关联类型,关联时间,客户名称,业务员姓名,本月消费,资源到期时间,移动电话或者客户标签查询客户。

REST API

伙伴在伙伴销售平台可以查询合作伙伴的客户信息列表。

该接口只允许使用合作伙伴账号AK/SK或者Token调用。

伙伴查询不存在的客户时,接口返回HTTPcode 200,响应返回空列表。

  1. URI

    POST /v1.0/{partner_id}/partner/customer-mgr/query

    参数说明请参见下表。

    参数

    是否必选

    取值范围

    描述

    partner_id

    最大长度:64

    合作伙伴ID(华为分配)。

    获取方法请参见如何获取合作伙伴ID(partner_id)

    此参数暂不校验。

  1. 请求消息

    请求参数

    参数

    是否必选

    参数类型

    取值范围

    描述

    domainName

    String

    最大长度:128

    客户登录名称(如果客户创建了子用户,此处需要填写主账号登录名称。关于主账号和子用户的具体介绍请参见身份管理中“账号”和“IAM用户”的描述)。

    支持模糊查询。仅支持前缀匹配、后缀匹配、中间匹配;不支持携带空格查询。

    该参数不携带或携带值为空串或携带值为null,不作为筛选条件。

    name

    String

    最大长度:128

    实名认证名称。

    支持模糊查询。仅支持前缀匹配、后缀匹配、中间匹配;不支持携带空格查询。

    该参数不携带或携带值为空串或携带值为null,不作为筛选条件。

    offset

    Intger

    [1-最大整数]

    查询第N页。

    默认第1页。

    limit

    Intger

    [1-100]

    每页数量。

    默认10,最多100。

    label

    String

    最大长度:64

    标签,支持模糊查找。

    该参数不携带或携带值为空串或携带值为null,不作为筛选条件。仅支持前缀匹配、后缀匹配、中间匹配;不支持携带空格查询;不支持英文大小写模糊查询。

    cooperationType

    String

    最大长度:1

    关联类型:

    • 1:顾问销售
    • 2:代售

    注:

    支持顾问销售和代售关联类型。

    该参数不携带或携带值为空串或携带值为null,不作为筛选条件。

    cooperationTimeStart

    String

    最大长度:20

    关联时间区间段开始,UTC时间。

    格式为:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    该参数需与cooperationTimeEnd搭配使用。

    该参数不携带或携带值为null时,不作为筛选条件;不支持携带值为空串。

    cooperationTimeEnd

    String

    最大长度:20

    关联时间区间段结束,UTC时间。

    格式为:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”。

    该参数需与cooperationTimeStart搭配使用。

    该参数不携带或携带值为null时,不作为筛选条件;不支持携带值为空串。

    customerId

    string

    最大长度:64

    子客户ID。

    该参数不携带或携带值为空串或携带值为null,不作为筛选条件。

    请求示例

    POST https://bss.myhuaweicloud.com/v1.0/{partner_id}/partner/customer-mgr/query HTTP/1.1
    Content-Type: application/json
    X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

  1. 响应消息

    响应参数

    参数

    是否必选

    参数类型

    取值范围

    描述

    error_code

    String

    最大长度:16

    状态码。

    具体请参见4

    error_msg

    String

    最大长度:1024

    错误描述信息。

    customerInfoList

    List<CustomerInfo>

    -

    客户信息列表。

    具体请参见表1

    count

    Integer

    -

    总记录数。

    表1 CustomerInfo

    参数

    是否必选

    参数类型

    取值范围

    描述

    name

    String

    最大长度:128

    实名认证名称。虚拟账号下,该字段无效。

    domainName

    String

    最大长度:128

    客户登录名称(如果客户创建了子用户,此处返回主账号登录名称)。

    customerId

    String

    最大长度:64

    客户ID。

    cooperationTime

    String

    最大长度:20

    客户和伙伴关联时间。

    UTC时间,格式:yyyy-MM-dd'T'HH:mm:ss'Z',如“2019-05-06T08:05:01Z”,其中,HH范围是0~23,mm和ss范围是0~59。

    cooperationType

    String

    最大长度:1

    合作模式。

    • 1:顾问销售
    • 2:代售

    注:

    仅支持顾问销售和代售关联类型。

    label

    String

    最大长度:64

    标签,支持模糊查找。虚拟账号下,该字段无效。

    telephone

    String

    最大长度:20

    客户电话号码。虚拟账号下,该字段无效。

    verifiedStatus

    String

    最大长度:5

    实名认证状态,虚拟账号下,该字段无效。:

    • -1:未实名认证;
    • 0:实名认证审核中;
    • 1:实名认证不通过;
    • 2:已实名认证;

    countryCode

    String

    最大长度:10

    国家码,电话号码的国家码前缀。虚拟账号下,该字段无效。

    例如:中国 0086。

    customerType

    Integer

    [-1,0,1]

    客户类型,虚拟账号下,该字段无效。:

    • -1:无类型
    • 0:个人
    • 1:企业

    客户刚注册的时候,没有具体的客户类型,为“-1:无类型”,客户可以在账号中心通过设置客户类型或者在实名认证的时候,选择对应的企业/个人实名认证来决定自己的类型。

    isFrozen

    Integer

    [0,1]

    是否冻结:

    • 0:否
    • 1:是

    该字段预留

    响应示例

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=UTF-8
    Content-Length: length
    Date: response time
    
    {
    	"count": 2,
    	"customerInfoList": [{
    			"name": "xxx",
    			"domainName": "a9ca*****b96",
    			"customerId": "05ad******4ea0",
    			"cooperationTime": "2019-07-19T06:40:53Z",
    			"cooperationType": "3",
    			"label": null,
    			"telephone": "17729386686",
    			"verifiedStatus": "2",
    			"countryCode": null,
                            "customerType":1
    		},
    		{
    			"name": "xxx",
    			"domainName": "a65b******89d",
    			"customerId": "059e******c6da0",
    			"cooperationTime": "2019-07-13T11:39:27Z",
    			"cooperationType": "3",
    			"label": null,
    			"telephone": null,
    			"verifiedStatus": "2",
    			"countryCode": null,
                            "customerType":1,
                            "isFrozen":0
    		}
    	]
    }

  1. 状态码
    • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
    • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

    HTTP状态码

    错误码

    描述

    200

    CBC.0000

    成功。

    500

    CBC.0999

    其他错误。

    400

    CBC.0100

    参数错误。

    403

    CBC.0151

    访问拒绝。

相关文档