AddDeviceToSharePromotion_物联网平台(IoT)-阿里云帮助中心

使用说明

促销活动使用的详细说明，请参见CreateSharePromotionActivity接口文档的使用说明。

QPS限制

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

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	AddDeviceToSharePromotion	系统规定参数。取值：AddDeviceToSharePromotion。
DeviceSimpleInfoList.N.ProductKey	String	是	a2YwD2****	待添加共享设备所属产品的ProductKey。
DeviceSimpleInfoList.N.DeviceName	String	是	device01	待添加的共享设备名称。
SharePromotionActivityId	String	是	61****__4901__47*********	促销活动ID。调用接口CreateSharePromotionActivity返回的Data值。
ShareTaskCode	String	是	52****_7e_43_9e_61**********	分享任务的分享码。分享任务的分享码信息，请参见使用共享设备播报分享语料。
IotInstanceId	String	否	iot-cv3********	实例ID。您可在物联网平台控制台的实例概览页签，查看当前实例的ID。重要若有ID值，必须传入该ID值，否则调用会失败。若无ID值，则无需传入。实例的更多信息，请参见实例概述。

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

返回数据

名称	类型	示例值	描述
Code	String	iot.speech.InvalidIotInstanceId	调用结果状态码：调用成功，返回空值。调用失败，返回错误码。详细信息，请参见下文错误码。
Data	Struct		返回的添加结果。
FailDeviceSimpleInfoList	Array of item		添加失败的共享设备列表文件。
item
DeviceName	String	device02	添加失败的共享设备名称。
FailCode	Integer	1	添加失败的错误码。 1：设备在共享中不存在。 2：设备已经在大促中存在。 3：批量操作异常，请稍后重试。
FailReason	String	设备在共享中不存在	添加失败的描述。
ProductKey	String	a2YwD2****	添加失败的共享设备所属产品的ProductKey。
ErrorMessage	String	Invalid instance ID.	调用失败时，返回的出错信息。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=AddDeviceToSharePromotion
&DeviceSimpleInfoList.1.ProductKey=a2YwD23***
&DeviceSimpleInfoList.1.DeviceName=device01
&SharePromotionActivityId=61******_****_4901_****_47***********
&ShareTaskCode=52******_7**e_4**3_9**e_61**********
&IotInstanceId=iot-cv3********
&<公共请求参数>

正常返回示例

XML格式

<AddDeviceToSharePromotionResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <FailDeviceSimpleInfoList>
              <item>
                    <FailCode>1</FailCode>
                    <FailReason>设备在共享中不存在</FailReason>
                    <ProductKey>a2YwD2****</ProductKey>
                    <DeviceName>device02</DeviceName>
              </item>
        </FailDeviceSimpleInfoList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</AddDeviceToSharePromotionResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "FailDeviceSimpleInfoList": {
            "item": [
                {
                    "FailCode": "1",
                    "FailReason": "设备在共享中不存在",
                    "ProductKey": "a2YwD2****",
                    "DeviceName": "device02"
                }
            ]
        }
    },
    "Code": "",
    "Success": true
}