Querying Customers (Old)

Function

This API is used to query your customers.

This API will be brought offline soon. For details about the new API for querying the customer list, see Querying Customers.

Web UI

You can log in to the Partner Center to query your customers.

In the top navigation, choose Sales > Customers > Customer Management.
Set search criteria to search for customers.

You can search for customers by the association type, association time, customer name, salesperson name, mobile number, or customer tag.

REST API

This API is used to query your customers on the partner sales platform.

This API can be invoked only by the partner account AK/SK or token.

If a customer queried does not exist, the HTTP code 200 will be returned by the API and nothing is returned in the response.

URI

GET /v1.0/{partner_id}/partner/customer-mgr/detail

The following table describes the parameters.

Parameter	Mandatory	Value Range	Description
partner_id	Yes	A maximum of 64 characters	Partner ID (assigned by Huawei). For details about how to obtain the partner ID, see How Do I Check the Partner ID?

Parameter

Mandatory

Value Range

Description

partner_id

Yes

A maximum of 64 characters

Partner ID (assigned by Huawei).

For details about how to obtain the partner ID, see How Do I Check the Partner ID?

Request

Request parameters

Parameter	Mandatory	Type	Value Range	Description
domain_name	No	String	A maximum of 128 characters	Account. If the customer has created an IAM user, enter the account name. For details about the two concepts, see "Account" and "IAM User" in Identity Management. Fuzzy search is supported. Only prefix, suffix, or middle part can be used for fuzzy search. The content you enter for fuzzy search cannot contain spaces. If this parameter is not included in the request parameters or is left empty, it cannot be used as a filter criterion. If this parameter is set to "" or null, it can be used as a filter criterion.
corp_name	No	String	A maximum of 128 characters	Enter the enterprise name if it is used for real-name authentication. For an individual who uses real name for authentication, enter the individual name. Fuzzy search is supported. Only prefix, suffix, or middle part can be used for fuzzy search. The content you enter for fuzzy search cannot contain spaces. If this parameter is not included in the request parameters or is left empty, it cannot be used as a filter criterion. If this parameter is set to "" or null, it can be used as a filter criterion.
page_no	No	Integer	-	Page to be queried. By default, the first page is queried. If this parameter is not included in the request, is left empty, or is set to null, the value 1 is used. This parameter cannot be set to "".
page_size	No	Integer	[1-100]	Number of records on each page. The default value is 10, and the maximum value is 100. If this parameter is not included in the request, is left empty, or is set to null, the value 10 is used. This parameter cannot be set to "".
label	No	String	A maximum of 64 characters	Tag. Fuzzy search is supported. Only prefix, suffix, or middle part can be used for fuzzy search. The content you enter for fuzzy search cannot contain spaces. The letters entered for search are case-sensitive. If this parameter is not included in the request parameters or is left empty, it cannot be used as a filter criterion. If this parameter is set to "" or null, it can be used as a filter criterion.
cooperationType	No	String	[1\|3]	Association type. 1: Referral 2: Authorized Distributor 3: Reseller Note: Currently, only Referral and Reseller are supported. If this field is not included in the request parameters or is left empty, it cannot be used as a filter criterion. It cannot be set to "" or null.
cooperationTimeStart	No	String	A maximum of 20 characters	Start time of the association time range (UTC time). The value is in "yyyy-MM-dd 'T' HH:mm:ss 'Z'" format, such as 2019-05-06T08:05:01Z. This parameter must be used together with cooperationTimeEnd. If this parameter is not included in the request parameters, it cannot be used as a filter criterion. It cannot be left empty or set to "" or null.
cooperationTimeEnd	No	String	A maximum of 20 characters	End time of the association time range (UTC time) The value is in the following format: yyyy-MM-dd'T'HH:mm:ss'Z', such as 2019-05-06T08:05:01Z This parameter must be used together with cooperationTimeStart. If this parameter is not included in the request parameters, it cannot be used as a filter criterion. It cannot be left empty or set to "" or null.

Request Example

GET https://bss-intl.myhuaweicloud.com/v1.0/{partner_id}/partner/customer-mgr/detail HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

Response

Response parameters

Parameter	Mandatory	Type	Value Range	Description
error_code	Yes	String	A maximum of 16 characters	Error code. For details, see 4.
error_msg	Yes	String	A maximum of 1024 characters	Error description.
customer_info_list	No	List<CustomerInfo>	-	Customer list. For details, see Table 1.
count	No	Integer	-	Total number of records.

**Table 1** CustomerInfo
Parameter	Mandatory	Type	Value Range	Description
corp_name	Yes	String	A maximum of 128 characters	Enterprise name.
domain_name	Yes	String	A maximum of 128 characters	Account. If the customer has created an IAM user, the account name is returned.
customer_id	Yes	String	A maximum of 64 characters	Customer account ID.
start_time	No	String	A maximum of 20 characters	Time when an enterprise is registered. The value is UTC time in yyyy-MM-ddTHH:mm:ssZ format. The range of HH is 0-23, and the range of mm and ss is 0-59.
cooperation_type	No	String	Length: 1	Association type. 1: Referral 2: Authorized Distributor 3: Reseller Note: Currently, only Referral and Reseller are supported.
label	No	String	A maximum of 64 characters	Tag. Fuzzy search is supported.
telephone	No	String	A maximum of 20 characters	Customer phone number
verifiedStatus	No	String	A maximum of 5 characters	Real-name authentication status. -1: The real name is not authenticated. 0: Real-name authentication is under review. 1: The real-name authentication is not passed. 2: The real name is authenticated.
countryCode	No	String	A maximum of 10 characters	Country code, which is the country code prefix of a phone number. Example: 0086 for China

Example response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

{
  "count": 2,
  "error_code": "CBC.0000",
  "error_msg": "success",
  "customer_info_list": [
        {
            "customer_id": "7ff331de7af7457d8331de0bfe7a42b7",
            "corp_name": null,
            "domain_name": "mingcheng",
            "start_time": "2018-10-11T02:28:34Z",
            "cooperation_type": "1",
            "label": "xxx",
            "telephone": "139xxxxxxxx",
            "verifiedStatus": "-1",
            "countryCode": "xxxx"
        },
        {
            "customer_id": "67b5223d4f6e4cc18d8dfd2da9d01db8",
            "corp_name": null,
            "domain_name": "ambrosiaxu",
            "start_time": "2018-06-25T11:15:20Z",
            "cooperation_type": "1",
            "label": "xxx",
            "telephone": "139xxxxxxxx",
            "verifiedStatus": "-1",
            "countryCode": "xxxx"
        }
  ]
}

Returned Values

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.