更新时间:2023-09-27 GMT+08:00
分享

查询客户新客标签

功能介绍

伙伴通过该接口可以查询客户的新客标签。

  • 新客标签失效后,new_customer_tag会变成N,且有效期过期。
  • 客户如果没有实名认证,则新客标签为空。

接口约束

该接口只允许使用经销商伙伴或华为云伙伴能力中心(一级经销商)的AK/SK或者Token调用。

URI

POST /v2/partners/sub-customers/new-customers-tags/batch-query

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

customer_ids

List<String>

[0-200]

客户ID列表。单个客户ID最大长度:64。

此参数不携带或携带值为空列表或携带值为null时,不作为筛选条件。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

示例1,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

示例2,查询总数20条,期望每页返回10条数据,则获取第一页数据,入参offset填写0,limit填写10;获取第二页数据,入参offset填写10,limit填写10。

limit

Integer

最大值:200

每次查询的客户数量。默认值为10。

indirect_partner_id

String

最大长度:64

云经销商ID。获取方法请参见查询云经销商列表。如果需要查询云经销商的客户新客标签,必须携带该字段。除此之外,此参数不做处理。

请求示例
POST https://bss.myhuaweicloud.com/v2/partners/sub-customers/new-customers-tags/batch-query HTTP /1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "customer_ids": [
         "0bb43f********a10f19c014228fb580",
         "0bb43f********a10f19c014228fb581"
       ],
    "offset": 0,
    "limit": 10
}

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度:1000

错误描述信息。只有失败才返回该字段。

new_customer_tags

List<NewCustomerTag>

[0-200]

新客标签信息列表。只有成功的时候才返回。

此列表不包含非子客户的数据。批量查询客户新客标签时,若入参携带了非子客户,会被过滤。

具体请参见表1 NewCustomerTag

表1 NewCustomerTag

参数

参数类型

取值范围

描述

customer_id

String

最大长度:64

客户ID。

customer_tag_type

String

最大长度:6

新客标签类型。

  • SMB:SMB新客标签。

new_customer_tag

String

最大长度:64

新客标签。

  • Y:合格新客
  • N:非新客
  • UNDETERMINED:未达标新客,即有新客资格但尚未成为新客

effective_time

String

最大长度:10

生效月份。

格式为YYYY-MM。

expire_time

String

最大长度:10

失效月份。

格式为YYYY-MM。

响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
    "new_customer_tags": [
        {
            "customer_id": "05377f723980d4330f06c01929ec37a0",
            "customer_tag_type": "SMB",
            "new_customer_tag": "Y",
            "effective_time": "2022-09",
            "expire_time": "2023-04"
        }
    ]
}

状态码

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

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

400

CBC.99000037

您没有操作该云经销商的权限。

403

CBC.0151

拒绝访问。

429

CBC.0250

消息流量控制。

500

CBC.0999

其他错误。

相关文档