调用ListProducts查询项目列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListProducts | 系统规定参数。取值:ListProducts。 |
Offset | Integer | 是 | 1 | 当前页码数。 |
Size | Integer | 是 | 20 |
|
Simple | Boolean | 否 | false | 设置是否为简化查询。
|
ProductName | String | 否 | 我的项目 | 输入关键字,按项目名称模糊查询。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
UbsmsStatus | String | enabled | 当前账号状态,返回值说明如下:
|
RequestId | String | 126D4DDD-05A5-49B1-B18C-39C4A929BFB2 | 请求的ID。 |
Total | Integer | 10 | 查询结果总数。 |
ProductInfos | Array of ProductInfo | 项目的概要信息。 |
|
ProductInfo | |||
IndustryId | Integer | 1 | 行业ID,返回值说明如下:
|
Platforms | String | iOS | 项目下属应用的平台,包含Android和iOS两种类型。 |
CreateTime | String | 2020-12-16T06:25:52Z | 项目的创建时间。UTC格式表达。 |
EncodedIcon | String | 图片 base64 | icon图片的base64字符串。 |
ProductId | Integer | 1234 | 项目的ID。 |
Name | String | 我的项目 | 项目的名称。 |
Readonly | Boolean | false | 标识项目是否为只读状态。 |
Description | String | xxxx | 简要描述项目信息。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListProducts
&Offset=1
&Size=20
&Simple=false
&ProductName=我的项目
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListProductsResponse>
<UbsmsStatus>enabled</UbsmsStatus>
<RequestId>126D4DDD-05A5-49B1-B18C-39C4A929BFB2</RequestId>
<Total>10</Total>
<ProductInfos>
<IndustryId>1</IndustryId>
<Platforms>iOS</Platforms>
<CreateTime>2020-12-16T06:25:52Z</CreateTime>
<EncodedIcon>图片 base64</EncodedIcon>
<ProductId>1234</ProductId>
<Name>我的项目</Name>
<Readonly>false</Readonly>
<Description>xxxx</Description>
</ProductInfos>
</ListProductsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"UbsmsStatus" : "enabled",
"RequestId" : "126D4DDD-05A5-49B1-B18C-39C4A929BFB2",
"Total" : 10,
"ProductInfos" : [ {
"IndustryId" : 1,
"Platforms" : "iOS",
"CreateTime" : "2020-12-16T06:25:52Z",
"EncodedIcon" : "图片 base64",
"ProductId" : 1234,
"Name" : "我的项目",
"Readonly" : false,
"Description" : "xxxx"
} ]
}
错误码
访问错误中心查看更多错误码。