Querying the Summary of Interaction Rule Libraries for Live Rooms

Function

Queries the summary of interaction rule libraries for live rooms.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/smart-live-interaction-rule-groups-summary

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset where the query starts. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Number of items displayed on each page. Value range: 1~100 Default value: 10
create_since	No	String	Filter the records whose creation time is not earlier than the entered time.
create_until	No	String	Filter the records whose creation time is not later than the entered time.
group_name	No	String	Rule library name

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Number of interaction rules. Value range: 0~1000
interaction_rule_groups	Array of InteractionRuleGroupSummary objects	Interaction rule libraries.

**Table 6** InteractionRuleGroupSummary
Parameter	Type	Description
group_id	String	Interaction rule library ID
group_name	String	Interaction rule library name
create_time	String	Creation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.
update_time	String	Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms

Example Responses

Status code: 200

Successful.

{
  "count" : 1,
  "interaction_rule_groups" : [ {
    "group_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
    "group_name" : "Welcome to the live room.",
    "create_time" : "2022-11-30T06:59:55Z",
    "update_time" : "2022-12-05T12:30:37Z"
  } ]
}

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 401

Authentication is not performed or fails.

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 500

Internal service error.

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	Successful.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
500	Internal service error.