CreateSoundCode_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 2。

说明 RAM 用户共享阿里云账号配额。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:CreateSoundCode
全部资源
*

请求参数

字段名称字段详情
Durationinteger<int32>

声码持续时长,单位为秒,取值范围为 1~30。

示例值:2
SoundCodeContentstring

声码营销内容,例如商品的详情地址等,长度限制 100 个字符。

示例值:www.taobao.com
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot_instc_pu****_c*-v64********
Namestring

声码名称,长度为 1~64 个字符,一个汉字占两个字符,实例下保证唯一。

示例值:TEST123
OpenTypestring

排程开放类型。展开详情

示例值:OPEN

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.soundcodeservice.NotSigned
Datastring

创建成功时返回的声码 ID(SoundCode),是声码的唯一标识。

示例值:Md3ZiTL888K9llXDy7890***********
ErrorMessagestring

调用失败时,返回的错误信息。

示例值:sound code service has not been signed
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:66FF51D3-***-49F1-B1A2-***
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.soundcode.InvalidIotInstanceId
invalid iot instance id诊断
400
iot.soundcode.InvalidSoundCodeContent
invalid sound code content诊断
400
iot.soundcode.InvalidSoundCodeDuration
invalid sound code duration诊断
400
iot.soundcode.SensitiveContent
sensitive content诊断
400
iot.soundcode.InvalidName
invalid sound code name诊断
400
iot.soundcode.AlreadyExistsName
already exists sound code name诊断
403
iot.soundcodeservice.NotSigned
sound code service has not been signed诊断
429
iot.soundcode.EncodeLimit
sound code encode limit exceeded诊断

变更历史

暂无变更历史