CreateRCSAsset - 上传5G消息素材

更新时间:
复制 MD 格式

创建5G消息素材。

接口说明

前提条件

使用说明

  • 传入 OSS Key 后同步创建素材记录并返回素材编码 assetCode,格式为 ASSET_加时间戳加随机后缀,审核任务异步触发。

  • 图片最大 20MB,支持 JPG、JPEG、PNG、BMP、GIF 格式;音频最大 20MB,支持 AMR、MP3、M4A、AAC 格式;视频最大 20MB,支持 3GP、MP4、WEBM 格式;缩略图最大 10KB,支持 JPG、JPEG、PNG、BMP 格式。

  • 缩略图对图片类型可选,音频和视频类型必传。

素材有效期及使用限制

  • 素材超过 1 个月未使用,将变为过期状态。过期素材不占用素材数量和存储容量额度。

  • 单个签名下的素材受以下限制:
    • 素材总数不能超过 100 个。

    • 素材总大小不能超过 450 MB。

错误码

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

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

  • SIGN_NOT_FOUND:签名不存在。

  • SYSTEM_ERROR:系统异常。

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

SignName

string

是

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

阿里云

AssetFileOssKey

string

是

素材文件 OSS Key。通过 GetOSSInfoForUploadFile 接口获取 OSS 配置后直传文件,将返回的 ossKey 传入。非空,最长 512 字符。

将文件上传至 OSS 并获取 AssetFileOssKey 的具体操作,请参见通过 OSS 上传文件。

media/image_20260101.jpg

AssetFileType

integer

是

素材文件类型,非空。取值:

  • 1:图片。支持 JPG、JPEG、PNG、BMP、GIF 格式,最大 20MB。

  • 2:音频。支持 AMR、MP3、M4A、AAC 格式,最大 20MB。

  • 3:视频。支持 3GP、MP4、WEBM 格式,最大 20MB。

1

ThumbnailFileOssKey

string

否

缩略图文件 OSS Key。图片类型可选,音频/视频类型必传。支持格式 JPG/JPEG/PNG/BMP,最大 64 KB,最长 512 字符。

media/thumb_20260101.jpg

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

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

None

RequestId

string

本次请求的 ID。

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

Message

string

状态码的描述。

OK

Data

object

返回数据。

{ "assetCode": "ASSET_1721932656000a1b2c3" }

Code

string

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

OK

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

Data 返回数据结构说明

Data 为素材创建结果,包含以下字段:

字段类型描述示例
assetCodeString素材编码,系统生成,格式为 ASSET_加时间戳加随机后缀。可作为 DeleteRCSAsset 、 QueryRCSAssetDetail 接口的入参,以及富媒体模板中 MediaCode 字段的取值ASSET_1721932656000a1b2c3

返回示例

{
  "Code": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Success": true,
  "Data": {
    "assetCode": "ASSET_1721932656000a1b2c3"
  }
}

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Message": "OK",
  "Data": {
    "assetCode": "ASSET_1721932656000a1b2c3"
  },
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情。