文档

查询项目列表

更新时间:

调用ListProducts查询项目列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action

String

ListProducts

系统规定参数。取值:ListProducts

Offset

Integer

1

当前页码数。

Size

Integer

20

  • 每页可显示的项目的个数。

  • 取值范围为:1-100。

Simple

Boolean

false

设置是否为简化查询。

  • true:简化查询。不返回encodedIcon和Platforms两个字段。

  • false:非简化查询。返回全部字段。

ProductName

String

我的项目

输入关键字,按项目名称模糊查询。

返回数据

名称

类型

示例值

描述

UbsmsStatus

String

enabled

当前账号状态,返回值说明如下:

  • enabled:开通状态

  • disabled:禁用状态

  • inDebt:停机24小时以内(含24小时)

  • inDebt24h:停机24小时以上

RequestId

String

126D4DDD-05A5-49B1-B18C-39C4A929BFB2

请求的ID。

Total

Integer

10

查询结果总数。

ProductInfos

Array of ProductInfo

项目的概要信息。

ProductInfo

IndustryId

Integer

1

行业ID,返回值说明如下:

  • 0:社交

  • 1:摄影与摄像

  • 2:效率

  • 3:生活

  • 4:美食佳饮

  • 5:工具

  • 6:娱乐

  • 7:游戏

  • 8:儿童

  • 9:教育

  • 10:报刊杂志

  • 11:健康健美

  • 12:旅游

  • 13:音乐

  • 14:体育

  • 15:商务

  • 16:新闻

  • 17:财务

  • 18:参考

  • 19:导航

  • 20:医疗

  • 21:图书

  • 22:天气

  • 23:智能物联网

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"
  } ]
}