文档

CreateSharePromotionActivity

更新时间:

调用该接口创建千里传音分享任务的促销活动。

使用说明

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

配置流程如下:

1. 调用本接口为当前实例下所有分享任务创建促销活动。

2. 调用接口QuerySharePromotionActivityAuditResult,查询指定分享任务的促销活动审核结果,确认指定分享任务的促销活动审核通过。

3. 调用接口CreateSharePromotionSpeechModel添加促销活动的语料。

4. 调用接口AddDeviceToSharePromotion将千里传音分享任务中已有共享设备添加到促销活动中。

5. 调用接口ShareSpeechByCombination播放促销活动的共享语料。

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

QPS限制

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

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateSharePromotionActivity

系统规定参数。取值:CreateSharePromotionActivity。

SharePromotionActivityName String task01

促销活动的名称。

IotInstanceId String iot-cv3********

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

重要
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见实例概述

StartTime Long 1691547072000

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

EndTime Long 1694315533000

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

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

返回数据

名称

类型

示例值

描述

Code String iot.speech.InvalidIotInstanceId

调用结果状态码:

  • 调用成功,返回空值。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data String 61******_****_4901_****_47***********

返回的促销活动ID。

ErrorMessage String Invalid instance ID.

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

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateSharePromotionActivity
&SharePromotionActivityName=task01
&IotInstanceId=iot-cv3********
&<公共请求参数>

正常返回示例

XML格式

<CreateSharePromotionActivityResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>61******_****_4901_****_47***********</Data>
  <Code></Code>
  <Success>true</Success>
</CreateSharePromotionActivityResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": "61******_****_4901_****_47***********",
    "Code": "",
    "Success": true
}

  • 本页导读 (1)