查询智能直播间互动规则库列表
功能介绍
该接口用于智能直播间互动规则库列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/smart-live-interaction-rule-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
create_since |
否 |
String |
过滤创建时间>=输入时间的记录。 |
create_until |
否 |
String |
过滤创建时间<=输入时间的记录。 |
group_name |
否 |
String |
规则库名称 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
互动规则总数。 |
interaction_rule_groups |
Array of InteractionRuleGroupDetail objects |
互动规则库列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
互动规则库ID |
group_name |
String |
互动规则库名称 |
interaction_rules |
Array of InteractionRuleDetailInfo objects |
互动规则列表 |
create_time |
String |
创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
update_time |
String |
更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
参数 |
参数类型 |
描述 |
---|---|---|
rule_index |
String |
规则索引 |
rule_name |
String |
规则名称 |
enabled |
Boolean |
是否启用 |
event_type |
Integer |
事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件 |
hit_condition |
HitCondition object |
命中条件 |
trigger |
TriggerProcess object |
触发器 |
review_config |
ReviewConfig object |
内容审核配置 |
rule_id |
String |
互动规则ID |
create_time |
String |
创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
update_time |
String |
更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
参数 |
参数类型 |
描述 |
---|---|---|
relation |
String |
条件关系
|
priority |
Integer |
优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值 |
tags |
Array of HitConditionTag objects |
匹配关系配置 |
参数 |
参数类型 |
描述 |
---|---|---|
tag |
String |
事件内容关键字段 |
operation |
String |
字段处理
|
match |
String |
匹配类型
|
value |
String |
匹配值 |
参数 |
参数类型 |
描述 |
---|---|---|
time_window |
Integer |
处理抑制时长。单位秒。 -1 表示整场直播 0 表示无抑制,每次都触发 |
reply_mode |
String |
回复类型。
|
layer_config |
SmartLayerConfig object |
智能图层配置。 |
extra_layer_config |
SmartLayerConfig object |
额外图层,用于有产品同时需要显示动态文本场景,配置第二图层使用。 |
reply_texts |
Array of strings |
回复话术集 |
reply_audios |
Array of ReplyAudioInfo objects |
回复音频集。填写audio_url。 |
reply_order |
String |
回复次序
|
reply_role |
String |
回复角色。默认为主播
|
robot_id |
String |
机器人ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
layer_type |
String |
图层类型。
|
asset_id |
String |
图层所需资产的资产id,外部资产信息无需填写 |
position |
LayerPositionConfig object |
图层位置配置。 |
size |
LayerSizeConfig object |
图层大小配置。 |
image_config |
SmartImageLayerConfig object |
素材图片图层配置。 |
video_config |
SmartVideoLayerConfig object |
素材视频图层配置。 |
text_config |
SmartTextLayerConfig object |
素材视频图层配置。 |
参数 |
参数类型 |
描述 |
---|---|---|
dx |
Integer |
图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 说明:
|
dy |
Integer |
图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
layer_index |
Integer |
图片/视频/人物图的层顺序。 说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
width |
Integer |
图层图片宽度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
height |
Integer |
图层图片高度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
参数 |
参数类型 |
描述 |
---|---|---|
image_url |
String |
图片文件的URL。 |
display_duration |
Integer |
图片显示时长。单位s
|
参数 |
参数类型 |
描述 |
---|---|---|
video_url |
String |
视频文件的URL。 |
video_cover_url |
String |
视频封面文件的URL。 |
display_duration |
Integer |
视频显示时长。单位s
|
参数 |
参数类型 |
描述 |
---|---|---|
text_type |
String |
文本类型。
|
text_context |
String |
文本。 |
font_name |
String |
字体。当前支持的字体:
|
font_size |
Integer |
字体大小(像素)。 取值范围:[4, 120] |
font_color |
String |
字体颜色。RGB颜色值。 |
display_duration |
Integer |
文本显示时长。单位s
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms
响应示例
状态码: 200
成功。
{ "count" : 1, "interaction_rule_groups" : [ { "group_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "group_name" : "欢迎用户进入", "create_time" : "2022-11-30T06:59:55Z", "update_time" : "2022-12-05T12:30:37Z" } ] }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 500
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class ListInteractionRuleGroupsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); ListInteractionRuleGroupsRequest request = new ListInteractionRuleGroupsRequest(); try { ListInteractionRuleGroupsResponse response = client.listInteractionRuleGroups(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListInteractionRuleGroupsRequest() response = client.list_interaction_rule_groups(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInteractionRuleGroupsRequest{} response, err := client.ListInteractionRuleGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。