Querying Notices

Query the list of notices that meet the specified conditions.

POST /v2/irobot/notices/search

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000
x-service-key	No	String	Specifies the flag for invoking the intelligent customer service. Minimum length: 1 Maximum length: 32
x-site	No	String	Specifies the site flag. The options are 0 (Chinese mainland) and 1 (international). Minimum length: 0 Maximum length: 1
x-language	No	String	Specifies the region language with a language abbreviation. The options are en-us and zh-cn. Minimum length: 0 Maximum length: 32

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
top	No	Integer	Requests for the number of data records with the highest matching degree. Minimum value: 1 Maximum value: 100
product_type_id	Yes	String	Specifies the product type ID. Minimum length: 0 Maximum length: 64

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
notices	Array of Notice objects	Specifies the list of recommended notices. Array length: 0 - 2147483647
error_code	String	Specifies the error code. Minimum length: 0 Maximum length: 32
error_msg	String	Describes the error. Minimum length: 0 Maximum length: 32

**Table 4** Notice
Parameter	Type	Description
id	String	Specifies the notice ID. Minimum length: 0 Maximum length: 64
content	String	Specifies the notice content. Minimum length: 0 Maximum length: 65535
create_time	Long	Specifies the creation time. Minimum value: 0 Maximum value: 9223372036854775807
update_time	Long	Specifies the update time. Minimum value: 0 Maximum value: 9223372036854775807

POST https://{endpoint}/v2/irobot/notices/search

{
  "product_type_id" : "Product type ID",
  "top" : 10
}

Status code: 200

Code 200 is returned if the operation is successful.

{
  "notices" : [ {
    "id" : "Notice ID",
    "content" : "Notice content",
    "create_time" : 1,
    "update_time" : 1
  } ]
}

Status Code	Description
200	Code 200 is returned if the operation is successful.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.