QueryRCSAssetList - 查询5G消息素材列表

更新时间:
复制 MD 格式

批量查询5G消息素材详情

接口说明

前提条件

已通过 CreateRCSAsset 接口上传 5G 消息素材。

使用说明

  • 按签名分页查询素材列表,返回素材总数、总大小及每个素材按运营商和产品类型聚合的审核状态,列表项中的文件大小单位为 kB。

  • 支持按过期状态筛选,不传 ExpireStatus 则返回全部素材。

  • 素材文件和缩略图的下载 URL 带签名和有效期,请及时使用。

错误码

调用失败时 Success 返回 false,Code 返回对应错误码:

  • ILLEGAL_PARAM:参数校验失败,Message 中返回具体校验错误信息。

  • SYSTEM_ERROR:系统异常。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用将会被限流,这可能会影响您的业务,请合理调用。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SignName

string

签名名称。非空,最长 128 字符。

阿里云

AssetCode

string

素材编码。非空,最长 64 字符。通过 CreateRCSAsset 接口创建素材时返回。

ASSET_1721932656000a1b2c3

PageNo

integer

当前页码,从 1 开始,必须大于 0。

1

PageSize

integer

每页条数,取值范围 1~50。

10

ExpireStatus

integer

过期状态筛选,不传则返回全部。取值:

  • 0:未过期。

  • 1:已过期。

0

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝时返回的详细信息。

None

RequestId

string

本次请求的 ID。

A90E4451-FED7-49D2-87C8-00700A8C4D0D

Message

string

状态码的描述。

OK

Data

object

分页返回数据。

PageSize

integer

每页条数。

10

Total

integer

素材总数。

100

PageNo

integer

当前页码。

1

List

array<object>

素材列表。

array<object>

AssetFileSize

integer

素材文件大小,单位为 kB。

1024

ThumbnailFileUrl

string

缩略图文件可下载的 OSS URL,带签名和有效期。

https://oss.example.com/thumb.jpg

ExpireStatus

integer

过期状态。取值:

  • 0:未过期。

  • 1:已过期。

0

LastUsedDays

string

上次使用距今的天数。

30

AssetFileType

integer

素材文件类型。取值:

  • 1:图片。

  • 2:音频。

  • 3:视频。

1

AssetFileUrl

string

素材文件可下载的 OSS URL,带签名和有效期。

https://oss.example.com/asset.jpg

AssetCode

string

素材编码。

ASSET_1721932656000a1b2c3

AuditStatusList

array<object>

按运营商和产品类型聚合的审核状态列表。

array<object>

BizProductType

integer

产品类型。取值:

  • 10:5G 通知。

  • 11:5G 营销。

10

AuditStatus

integer

聚合审核状态。取值:

  • 0:审核中。

  • 1:审核通过。

  • 2:审核失败。

1

AuditFailInfo

object

审核异常信息,仅 auditStatus 为 2 时有值。

AssetFileAuditFailReason

string

素材文件审核异常信息。

图片分辨率过低

ThumbnailFileAuditFailReason

string

缩略图文件审核异常信息。

缩略图格式不支持

Carrier

integer

运营商。取值:

  • 1:移动。

  • 2:联通。

  • 3:电信。

1

SignName

string

签名名称。

阿里云

Code

string

请求状态码。返回 OK 代表请求成功。

OK

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Data": {
    "PageSize": 10,
    "Total": 100,
    "PageNo": 1,
    "List": [
      {
        "AssetFileSize": 1024,
        "ThumbnailFileUrl": "https://oss.example.com/thumb.jpg",
        "ExpireStatus": 0,
        "LastUsedDays": "30",
        "AssetFileType": 1,
        "AssetFileUrl": "https://oss.example.com/asset.jpg",
        "AssetCode": "ASSET_1721932656000a1b2c3",
        "AuditStatusList": [
          {
            "BizProductType": 10,
            "AuditStatus": 1,
            "AuditFailInfo": {
              "AssetFileAuditFailReason": "图片分辨率过低",
              "ThumbnailFileAuditFailReason": "缩略图格式不支持"
            },
            "Carrier": 1
          }
        ],
        "SignName": "阿里云"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情