CreateSharePromotionActivity_物联网平台_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.

接口说明

使用说明

由于一个设备只能加入一个分享任务且只能播报该分享任务中共享语料,千里传音语音播报服务提供了促销活动功能,可指定分享任务中共享设备播报促销活动中的语料。

配置流程如下:

  1. 调用本接口为当前实例下所有分享任务创建促销活动。
  2. 调用接口 QuerySharePromotionActivityAuditResult,查询指定分享任务的促销活动审核结果,确认指定分享任务的促销活动审核通过。
  3. 调用接口 CreateSharePromotionSpeechModel 添加促销活动的语料。
  4. 调用接口 AddDeviceToSharePromotion 将千里传音分享任务中已有共享设备添加到促销活动中。
  5. 调用接口 ShareSpeechByCombination 播放促销活动的共享语料。

分享任务的详细配置,请参见使用共享设备播报分享语料

QPS 限制

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

说明 单个阿里云账号下的所有 RAM 用户共享该阿里云账号的配额。

流控信息

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

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
SharePromotionActivityNamestring

促销活动的名称。

示例值:task01
IotInstanceIdstring

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

示例值:iot-cv3********
StartTimeinteger<int64>

促销活动开始时间的毫秒级时间戳。不传入,表示促销活动没有开始时间的限制。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1691547072000
EndTimeinteger<int64>

促销活动结束时间的毫秒级时间戳。不传入,表示促销活动没有结束时间的限制。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1694315533000

请求说明

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

返回参数

字段名称字段详情
Codestring

调用结果状态码:展开详情

示例值:iot.speech.InvalidIotInstanceId
Datastring

返回的促销活动 ID。

示例值:61******_****_4901_****_47***********
ErrorMessagestring

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

示例值:Invalid instance ID.
RequestIdstring

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

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.speech.InvalidIotInstanceId
Invalid instance ID.诊断
400
iot.system.SystemException
An internal error occurred. Try again later.诊断
400
iot.check.InvalidFormattedParameter
The parameter format is invalid.诊断

变更历史

暂无变更历史

相关示例