Cloud Recipes

Last Updated on : 2024-06-05 03:15:11download

Get list of recipe categories

API endpoint

action: cookbook.categoryList

Request parameter

Parameter name	Type	Description	Required
product_id	String	The product ID (PID).	Yes
lang	String	Language	Yes

Sample request

{
    "action": "cookbook.categoryList",
    "params": {
        "product_id":"kr1hsl03dzkp **** ",
        "lang": "zh"
    }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
imageUrl	String	The URL of the image.
langInfo	List	The multilingual information.
name	String	The name of the category.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Sample response

{
  "result": {
    "data": [
      {
        "gmtModified": 1610939037284,
        "langInfo": {
          "name": "家常菜",
          "lang": "zh-CN"
        },
        "isFoodChannel": 0,
        "gmtCreate": 1570800000000,
        "imageUrl": "",
        "name": "家常菜",
        "id": 1,
        "lang": 1
      },
      {
        "gmtModified": 1610605844096,
        "langInfo": {
          "name": "快手菜",
          "lang": "zh-CN"
        },
        "isFoodChannel": 0,
        "gmtCreate": 1610605844096,
        "imageUrl": "",
        "name": "快手菜",
        "id": 2,
        "lang": 1
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": false,
    "totalCount": 3
  },
  "success": true,
  "t": 1610939414721
}

Query list of recipes on pages

API endpoint

action: cookbook.recipeList

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
lang	String	The language.	Yes
uid	String	User ID	Yes
category_id	Long	The category ID.	No
name	String	The name of the recipe.	No
page_no	Integer	The current page number, starting from `0`.	Yes
page_size	Integer	The number of entries to be displayed on each page.	Yes

Sample request

{
      "action": "cookbook.recipeList",
      "params": {
            "product_id": "kr1hsl03dzkp **** ",
            "lang": "zh",
           "uid": "ay16054980732684 **** ",
           "page_no": 0,
           "page_size": 10
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
mainImg	String	The main image.
lang	Integer	The language code.
langDesc	String	The description of the language.
desc	String	The description of the recipe.
cookType	Integer	The type of cooking. Valid values: `0`: cooking without parameters `1`: one-tap cooking `2`: multi-step cooking
foods	String	The ingredients.
extInfo	String	The additional information.
sourceType	Integer	The type of recipe. Valid values: `0`: a recipe provided by the business customer `1`: a recipe customized by an end user
isMainShow	Integer	Specifies whether to display a recipe on the homepage.
isShowControl	Integer	Specifies whether to allow end users to modify parameters.
isControl	Integer	Specifies whether the app supports one-tap cooking.
name	String	The name of the recipe.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Sample response

{
  "result": {
    "data": [
      {
        "gmtModified": 1610940130854,
        "mainImg": "",
        "foods": "主料：\n 鸡块 100 克 \n 辅料：\n 枸杞 1 克\n 红枣 3 克\n 椰子 1 个\n 调料：\n 盐 1 克\n 蔬菜精 1 克",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 0,
        "isShowControl": 1,
        "id": 1,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 0,
        "gmtCreate": 1610337216399,
        "easyLevel": "",
        "sourceType": 0,
        "name": "原盅椰子鸡",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "制作时长：65 分钟。\n 美味小窍门：\n1.椰子一个约 400 克，建议使用椰青。\n2.最好选择小土鸡，油少不腻，才能与椰子的清爽相搭。"
      },
      {
        "gmtModified": 1610698986741,
        "mainImg": "",
        "foods": "主料：\n 胡萝卜 200 克\n 辅料：\n 奶液 100 克",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 0,
        "isShowControl": 1,
        "id": 2,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 0,
        "gmtCreate": 1610692995771,
        "easyLevel": "",
        "sourceType": 0,
        "name": "胡萝卜泥(辅食)",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "制作时间：31 分钟。\n 美味小窍门：\n1.宝爸宝妈请参照婴儿辅食添加表，科学喂养，营养均衡。\n2.根据宝宝年龄段可与米糊搭配喂养。\n3.奶液可使用宝宝现阶段喝的配方奶或母乳。"
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": true,
    "totalCount": 2
  },
  "success": true,
  "t": 1610941675283
}

Query list of (recommended) recipes on pages

action:   cookbook.recipeListWithRecommend

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
lang	String	The language.	Yes
uid	String	The recipe ID.	Yes
category_id	Long	The category ID.	No
name	String	The name of the recipe.	No
is_food_channel	Byte	Indicates whether the recipe is recommended. Valid values: `0`: no. `1`: yes.	No
page_no	Integer	The current page number, starting from `0`.	Yes
page_size	Integer	The number of entries to be displayed on each page.	Yes

Sample request

{
      "action": "cookbook.recipeListWithRecommend",
      "params": {
          "product_id": "auzzizjq3oww **** ",
           "lang": "zh-CN",
             "is_food_channel": 1,
            "uid": "bay1604897111540 **** ",
            "page_no": 0,
             "page_size": 10
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
mainImg	String	The main image.
lang	Integer	The language code.
langDesc	String	The description of the language.
desc	String	The description of the recipe.
cookType	Integer	The type of cooking. Valid values: `0`: cooking without parameters `1`: one-tap cooking `2`: multi-step cooking
foods	String	The ingredients.
extInfo	String	The additional information.
sourceType	Integer	The type of recipe. Valid values: `0`: a recipe provided by the business customer `1`: a recipe customized by an end user
isMainShow	Integer	Specifies whether to display a recipe on the homepage.
isShowControl	Integer	Specifies whether to allow end users to modify parameters.
isControl	Integer	Specifies whether the app supports one-tap cooking.
name	String	The name of the recipe.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Sample response

{
  "result": {
    "data": [
      {
        "gmtModified": 1610509448729,
        "mainImg": "",
        "foods": "用料：速冻奶黄包 7 只 30g/只 直径：3cm",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 1,
        "isShowControl": 1,
        "id": 1,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 1,
        "gmtCreate": 1605098189575,
        "easyLevel": "",
        "sourceType": 0,
        "name": "蒸速冻奶黄包",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "蒸速冻奶黄包"
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": false,
    "totalCount": 1
  },
  "success": true,
  "t": 1610941610052
}

Get recipe details

API endpoint

action:   cookbook.recipe

Request parameter

Parameter name	Type	Description	Required
menu_id	long	The recipe ID to be returned as the ID field value in the response.	Yes
lang	String	The language.	Yes

Sample request

{
      "action": "cookbook.recipe",
      "params": {
            "menu_id": 1,
            "lang": "zh-CN"
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
mainImg	String	The main image.
lang	Integer	The language code.
langDesc	String	The description of the language.
desc	String	The description of the recipe.
cookType	Integer	The type of cooking. Valid values: `0`: cooking without parameters `1`: one-tap cooking `2`: multi-step cooking
foods	String	The ingredients.
extInfo	String	The additional information.
sourceType	Integer	The type of recipe. Valid values: `0`: a recipe provided by the business customer `1`: a recipe customized by an end user
isMainShow	Integer	Specifies whether to display a recipe on the homepage.
isShowControl	Integer	Specifies whether to allow end users to modify parameters.
isControl	Integer	Specifies whether the app supports one-tap cooking.
name	String	The name of the recipe.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.
menuStepInfoVOList	List	The procedure described with text and images.
cookStepInfoVOList	List	The cooking steps.

Description of menuStepInfoVOList

Parameter name	Type	Description
id	Long	The recipe ID.
menuId	Long	The recipe ID.
step	Integer	The step number.
finishCtrl	String	The command to finish a step.
langInfos	List	The description of the language.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Description of cookStepInfoVOList

Parameter name	Type	Description
id	Long	The recipe ID.
menuId	Long	The recipe ID.
step	Integer	The step number.
finishCtrl	String	The command to finish a step.
langInfos	List	The description of the language.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Description of langDesc

Parameter name	Type	Description
lang	String	Language
stepImg	String	The image of a step.
desc	String	The description of a step.

Sample response

{
  "result": {
    "data": [
      {
        "gmtModified": 1610509448729,
        "mainImg": "",
        "foods": "用料：速冻奶黄包 7 只 30g/只 直径：3cm",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 1,
        "isShowControl": 1,
        "id": 1,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 1,
        "gmtCreate": 1605098189575,
        "easyLevel": "",
        "sourceType": 0,
        "name": "蒸速冻奶黄包",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "蒸速冻奶黄包"
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": false,
    "totalCount": 1
  },
  "success": true,
  "t": 1610941610052
}

Get list of recipe favorites

API endpoint

action:   cookbook.favoritesList

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
lang	String	The language.	Yes
uid	String	The user ID.	Yes

Sample request

{
      "action": "cookbook.favoritesList",
      "params": {
            "lang": "zh-CN",
            "product_id": "kr1hsl03dzkp **** ",
            "uid": "ay1607531387415z **** "
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
mainImg	String	The main image.
lang	Integer	The language code.
langDesc	String	The description of the language.
desc	String	The description of the recipe.
cookType	Integer	The type of cooking. Valid values: `0`: cooking without parameters `1`: one-tap cooking `2`: multi-step cooking
foods	String	The ingredients.
extInfo	String	The additional information.
sourceType	Integer	The type of recipe. Valid values: `0`: a recipe provided by the business customer `1`: a recipe customized by an end user
isMainShow	Integer	Specifies whether to display a recipe on the homepage.
isShowControl	Integer	Specifies whether to allow end users to modify parameters.
isControl	Integer	Specifies whether the app supports one-tap cooking.
name	String	The name of the recipe.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Sample response

    {
  "result": {
    "data": [
      {
        "gmtModified": 1610957690348,
        "mainImg": "",
        "foods": "主料：\n 低筋粉 60 克\n\n 辅料：\n 牛奶 50 克\n 鸡蛋 5 个\n\n 配料：\n 白砂糖 50 克\n 植物油 50 克\n",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 0,
        "isShowControl": 1,
        "id": 1,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 0,
        "gmtCreate": 1598501320202,
        "easyLevel": "",
        "sourceType": 0,
        "name": "戚风蛋糕",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "松软可口的西式点心"
      },
      {
        "gmtModified": 1602821210071,
        "mainImg": "",
        "foods": "主料：\n 淡奶油 200 克\n 巧克力饼干 45 克\n\n\n 辅料：\n 纯牛奶 50 克\n 蛋黄 3 个\n 炼乳 20 克\n\n 调料：\n 白砂糖 20 克",
        "taste": "",
        "preVideo": "",
        "productGroupId": "1",
        "xyxk": "",
        "useFoodLib": 0,
        "extInfo": "",
        "isMainShow": 0,
        "isShowControl": 1,
        "id": 2,
        "lang": 1,
        "foodCategory": "",
        "langDesc": "zh-CN",
        "author": "",
        "foodType": "",
        "cookTime": 0,
        "stepVideo": "",
        "isFoodChannel": 0,
        "gmtCreate": 1598880426361,
        "easyLevel": "",
        "sourceType": 0,
        "name": "巧克力冰淇淋",
        "information": "",
        "isControl": 1,
        "eatCount": 0,
        "cookType": 2,
        "desc": "巧克力冰淇淋是一款甜品，由淡奶油，牛奶，鸡蛋，白糖，巧克力饼干制作而成，口感香甜。（烹饪大约时长 5 分钟）"
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": false,
    "totalCount": 2
  },
  "success": true,
  "t": 1610959336003
}

Add recipe to favorites

API endpoint

action:   cookbook.addFavorites

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
uid	String	The user ID.	Yes

Sample request

{
      "action": "cookbook.addFavorites",
       "params": {
           "product_id": "kr1hsl03dzkp **** ",
            "menu_id": 1,
            "uid": "ay1607531387415z **** "
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Sample response

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

Remove recipe from favorites

API endpoint

action:   cookbook.deleteFavorites

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
uid	String	The user ID.	Yes

Sample request

{
      "action": "cookbook.deleteFavorites",
      "params": {
            "menu_id": "1",
            "product_id": "kr1hsl03dzkp **** ",
           "uid": "ay1610529826595f **** "
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Sample response

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

Check whether recipe is in favorites

API endpoint

action:   cookbook.checkFavorites

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
uid	String	The user ID.	Yes

Sample request

{
      "action": "cookbook.checkFavorites",
      "params": {
           "menu_id": "1",
        "product_id": "kr1hsl03dzkp **** ",
            "uid": "ay1610529826595f **** "
      }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
isStar	Boolean	Indicates whether a recipe is a favorite one. `true`: yes. `false`: no.

Sample response

{
      "result": {
          "isStar": false
      },
      "success": true,
        "t": 1610959896088
  }

Get list of recipe favorites for device

API endpoint

action:   cookbook.deviceFavorites

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
lang	String	The language.	Yes
dev_id	String	The device ID.	Yes

Sample request

{
      "action": "cookbook.deviceFavorites",
      "params":{
          "lang":"zh-CN",
          "product_id":"kr1hsl03dzkp **** ",
          "dev_id":"vzwcutq0dwnr **** "
      }
  }

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
id	Long	The recipe ID.
mainImg	String	The main image.
lang	Integer	The language code.
langDesc	String	The description of the language.
desc	String	The description of the recipe.
cookType	Integer	The type of cooking. Valid values: `0`: cooking without parameters `1`: one-tap cooking `2`: multi-step cooking
foods	String	The ingredients.
extInfo	String	The additional information.
sourceType	Integer	The type of recipe. Valid values: `0`: a recipe provided by the business customer `1`: a recipe customized by an end user
isMainShow	Integer	Specifies whether to display a recipe on the homepage.
isShowControl	Integer	Specifies whether to allow end users to modify parameters.
isControl	Integer	Specifies whether the app supports one-tap cooking.
name	String	The name of the recipe.
gmtCreate	Integer	The timestamp when the data was created.
gmtModified	Integer	The timestamp when the data was modified.

Sample response

{
  "result": [
    {
      "gmtModified": 1598668394824,
      "mainImg": "",
      "langDesc": "en,zh-CN",
      "foods": "好食谱",
      "gmtCreate": 1598501322848,
      "extInfo": "",
      "sourceType": 0,
      "isMainShow": 0,
      "name": "中⽂食谱",
      "isShowControl": 0,
      "id": 1,
      "isControl": 1,
      "lang": 257,
      "desc": "好食谱",
      "cookType": 1
    }
  ],
  "t": 1598668505143,
  "success": true,
  "status": "ok"
}

Add recipe to favorites for device

API endpoint

action:   cookbook.addDeviceFavorites

Request parameter

Parameter name	Type	Description	Required
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
dev_id	String	The device ID.	Yes

Sample request

{
      "action": "cookbook.addDeviceFavorites",
      "params":{
              "menu_id": 1,
              "dev_id":"vzwcutq0dwnr **** "
       }
  }

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Sample response

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

Remove recipe from favorites for device

API endpoint

action:   cookbook.deleteDeviceFavorites

Request parameter

Parameter name	Type	Description	Required
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
dev_id	String	The device ID.	Yes

Sample request

{
      "action": "cookbook.deleteFavorites",
      "params":{
          "menu_id":"1",
          "dev_id":"vzwcutq0dwnr **** "
      }
  }

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Sample response

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

Check whether recipe is in favorites for device

API endpoint

action:   cookbook.checkFavorites

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
menu_id	String	The recipe ID to be returned as the ID field value in the response.	Yes
uid	String	The user ID.	Yes

Sample request

{
      "action": "cookbook.checkFavorites",
      "params":{
          "menu_id":"1",
          "product_id":"kr1hsl03dzkp **** ",
          "uid":"ay1610529826 **** "
          }
  }

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
isStar	Boolean	Indicates whether a recipe is a favorite one. `true`: yes. `false`: no.

Sample response

{
      "result": {
          "isStar": false
      },
      "success": true,
      "t": 1610959896088
  }

Get list of recommended devices and banners

API endpoint

action:   cookbook.menuBannerList

Request parameter

Parameter name	Type	Description	Required
biz_type	long	The type of list: `1`: banners `2`: recommended devices	Yes
product_id	String	The PID.	Yes
lang	String	The language.	Yes

Sample request

{
      "action": "cookbook.menuBannerList",
      "params":{
          "biz_type": 1,
          "product_id":"vzwcutq0dwnr **** ",
          "lang":"zh-CN"
      }
  }

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
image	String	Image
langDesc	String	Supported language
linkUrl	String	The navigation URL.
name	String	The name.

Sample response

{
  "result": {
    "data": [
      {
        "image": "",
        "gmtModified": 1609814022839,
        "langDesc": "zh-CN,en",
        "gmtCreate": 1604635265813,
        "capability": 257,
        "linkUrl": "",
        "name": "Recommended devices",
        "startTime": 1609776000000,
        "id": 1,
        "endTime": 1612065599000,
        "status": 1
      }
    ],
    "pageNo": 0,
    "pageSize": 10,
    "hasNext": false,
    "totalCount": 1
  },
  "t": 1609815590,
  "success": true
}

Get search model for device

API endpoint

action:   cookbook.menuQueryModel

Request parameter

Parameter name	Type	Description	Required
product_id	String	The PID.	Yes
lang	String	The language.	Yes

Sample request

{
      "action": "cookbook.menuQueryModel",
      "params": {
            "product_id": "vzwcutq0dwnr **** ",
            "lang": "zh-CN"
     }
}

Response parameter

Parameter name	Type	Description
code	Integer	The response code.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The error message that is returned if the API call fails. This parameter value is empty if the API call succeeds.
result	Object	The message transmitted through an MQTT connection.

Description of result

Parameter name	Type	Description
metadata	List	The metadata.
productGroup	List	The product group.

Sample response

{
  "result": {
    "metadata": [
      {
        "gmtModified": 1603771677950,
        "code": "taste",
        "id": 1,
        "gmtCreate": 1603771677950,
        "value": "",
        "langInfos": [
          {
            "lang": "zh-CN",
            "desc": "甜"
          }
        ],
        "key": "甜"
      }
    ],
    "productGroup": [
      {
        "gmtModified": 1609224715359,
        "name": "烤箱",
        "id": 1,
        "gmtCreate": 1598500742069
      }
    ]
  },
  "t": 1609818542,
  "e": false,
  "success": true
}