物联使能获取用户信息列表-物联使能 API-文档中心-腾讯云

1. 接口描述
接口请求域名：iot.cloud.tencent.com/api/exploreropen/serviceapi。
本接口（ServiceGetCustomerList）用于获取用户信息列表。
2. 输入参数
名称
类型
必选
描述
Action
String
是
公共参数，本接口取值：ServiceGetCustomerList。
RequestId
String
是
公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。
AppKey
String
是
公共参数，物联网 SaaS 的 AppKey ，用于标识对应的物联网 SaaS。
Signature
String
是
公共参数，请求签名，需用户自行生成，用于校验请求的合法性。
Timestamp
Int64
是
公共参数，请求的 Unix 时间戳（秒级）。
Nonce
Int
是
公共参数，随机正整数，与 Timestamp 联合起来，防止重放攻击。
CustomerId
String
否
厂商应用端的唯一用户 ID，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
CountryCode
String
否
国家码，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
PhoneNumber
String
否
手机号，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
Offset
Int
否
分页偏移，0起始。
Limit
Int
否
单页数据量。
3. 输出参数
名称
类型
描述
RequestId
String
公共参数，唯一请求 ID，与入参相同，定位问题时，需提供该次请求的 RequestId。
Customers
Array of CustomerInfo
用户信息。
Total
Int
总用户数。
4. 示例
输入示例
 POST https://iot.cloud.tencent.com/api/exploreropen/serviceapi HTTP/1.1
 content-type: application/json
 {
    "RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
    "Timestamp": 1599468019,
    "Nonce": 170533123,
    "AppKey": "AppKey",
    "Signature": "Signature",
    "Action": "ServiceGetCustomerList",
    "CustomerId": "Customer100001",
    "Offset": 0,
    "Limit": 10
 }
输出示例：成功
{
	"Response": {
		"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68",
		"Customers": [{
			"CustomerId": "Customer100001",
			"CountryCode": "86",
			"PhoneNumber": "13900000000"
		}],
		"Total": 1
	}
}
输出示例：失败
{
	"Response": {
		"Error": {
			"Code": "InvalidParameterValue",
			"Message": "Signature 无效"
		},
		"RequestId": "f92406b3-****-4fe8-bc43-45e3d794bb68"
	}
}
5. 错误码
错误码
描述
InternalError
内部错误。
ErrorRequiredParamNotFound
必选参数缺失。
InvalidAction
Action 非法。
InvalidParameterValue
参数非法。
InvalidParameterValue.InvalidJSON
请求格式不是 JSON。
invalid CustomerId
CustomerId 格式错误。
invalid Email
Email 格式错误。
invalid Phone
Phone 或者 CountryCode 格式错误。
invalid CustomerId or invalid ServiceAppKey
CustomerId 或 ServiceAppKey 不存在。
?

名称	类型	必选	描述
Action	String	是	公共参数，本接口取值：ServiceGetCustomerList。
RequestId	String	是	公共参数，唯一请求 ID，可自行生成，推荐使用 uuId。定位问题时，需提供该次请求的 RequestId。
AppKey	String	是	公共参数，物联网 SaaS 的 AppKey ，用于标识对应的物联网 SaaS。
Signature	String	是	公共参数，请求签名，需用户自行生成，用于校验请求的合法性。
Timestamp	Int64	是	公共参数，请求的 Unix 时间戳（秒级）。
Nonce	Int	是	公共参数，随机正整数，与 Timestamp 联合起来，防止重放攻击。
CustomerId	String	否	厂商应用端的唯一用户 ID，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
CountryCode	String	否	国家码，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
PhoneNumber	String	否	手机号，可选参数，未指定则查询所有，指定则根据输入内容查询指定用户。
Offset	Int	否	分页偏移，0起始。
Limit	Int	否	单页数据量。

错误码	描述
InternalError	内部错误。
ErrorRequiredParamNotFound	必选参数缺失。
InvalidAction	Action 非法。
InvalidParameterValue	参数非法。
InvalidParameterValue.InvalidJSON	请求格式不是 JSON。
invalid CustomerId	CustomerId 格式错误。
invalid Email	Email 格式错误。
invalid Phone	Phone 或者 CountryCode 格式错误。
invalid CustomerId or invalid ServiceAppKey	CustomerId 或 ServiceAppKey 不存在。

获取用户信息列表

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

5. 错误码