Cloud Services API ReferenceSmart HomeSmart Home Content ManageBanner ManagementCreate Banner

Create Banner

Last Updated on : 2023-06-20 12:34:14download

Create a specified banner. After release, you can view it on the app.

API address

POST: /v1.0/iot-03/app-contents/banners

Request parameter

Description of body

Parameter name	Type	Required	Description
category_id	String	true	The ID of a specified category.
title_lang_info	List	true	The title in multiple languages.
pic_url	String	true	The URL of the image.
link	String	true	The link address.
publish	Boolean	true	Indicates whether the banner is released. Valid values: `true`: yes. `false`: no.
operator	String	true	The ID of a specified operator.
schema	String	true	App schema

Description of title_lang_info

Parameter name	Type	IN	Required	Description
lang	String		true	The language.
value	String		true	The multilingual value.

Return parameter

Parameter name	Type	Description
result	Boolean	The returned result.

Request example

POST: /v1.0/iot-03/app-contents/banners

{
  "schema": "abc",
  "operator": "123",
  "category_id": "11001",
  "link": "www.baidu.com",
  "pic_url": "/suramar/content/1619002638fd391d975de.jpeg",
  "publish": true,
  "title_lang_info": [
    {
      "lang": "zh",
      "value": "Test"
    },
    {
      "lang": "en",
      "value": "test"
    }
  ]
}

Return example

{
    "result": true,
    "t": 1630330910164,
    "success": true
}

Error code

For more information, see error code.

Prev DocBanner Management

Next DocDelete Banner