文档首页/ 数字内容生产线 MetaStudio/ API参考/ 分身视频直播/ 智能直播间管理/ 查询智能直播间互动规则库列表
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询智能直播间互动规则库列表

功能介绍

该接口用于智能直播间互动规则库列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

每页显示的条目数量。

取值范围：

1-100

默认取值：

10

create_since

否

String

过滤创建时间>=输入时间的记录。

create_until

否

String

过滤创建时间<=输入时间的记录。

group_name

否

String

规则库名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。
表5 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

互动规则总数。

取值范围：

0-1000

interaction_rule_groups

Array of InteractionRuleGroupDetail objects

互动规则库列表。
表6 InteractionRuleGroupDetail

参数

参数类型

描述

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”。
表7 InteractionRuleDetailInfo

参数

参数类型

描述

rule_index

String

参数解释：

规则索引。用于触发规则时索引具体规则。

约束限制：

无需用户填写。

取值范围：

字符0-64位

默认取值：

不涉及。

rule_name

String

参数解释：

规则名称。

约束限制：

不涉及。

取值范围：

字符0-256位

默认取值：

不涉及。

enabled

Boolean

参数解释：

是否启用。

约束限制：

不涉及。

取值范围：

  • true：启用

  • fasle：不启用

默认取值：

true

event_type

Integer

参数解释：

规则匹配直播事件类型。接口的取值范围[0,100]，实际业务取值如下所示：

  • 1：弹幕事件

  • 2：用户入场事件

  • 3：用户点赞事件

  • 4：用户送礼事件

  • 10: 预置话术事件

请以实际业务取值为准。

说明：

  • 1,2,3,4：与LiveEventReport中的event.type对应。

  • 10：匹配预置剧本

约束限制：

不涉及。

默认取值：

不涉及

取值范围：

0-100

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”。
表8 HitCondition

参数

参数类型

描述

relation

String

参数解释：

条件关系。对于多个条件的逻辑运算关系。

约束限制：

不涉及。

取值范围：

  • AND：表示多个条件同时满足。

  • OR：表示多个条件满足其一即可。

  • RESERVED：兜底回复不会去判断其他命中条件。

默认取值：

不涉及。

priority

Integer

参数解释：

优先级，数值越低优先级越高；取值0-999，默认值为500，为可选值

约束限制：

不涉及

取值范围：

0-999

默认取值：

500

tags

Array of HitConditionTag objects

匹配关系配置
表9 HitConditionTag

参数

参数类型

描述

tag

String

参数解释：

事件内容关键字段

说明：

  • event_type为1,2,3,4：与LiveEventReport中event.content中反序列化后的JSON字段对应。如：弹幕事件上报事件。

    {

    "timestamp": 1694481224245,

    "type": 1,

    "content": "{"user":{"userId":"2027271526","name":"","level":17,"badge":"","badgeLevel":0},"content":""}"

    }

    匹配弹幕内容，填写content；匹配用户平台等级，填写level。

  • 10：固定填写content即可。

约束限制：

不涉及

取值范围：

字符长度0-256位

默认取值：

不涉及

operation

String

参数解释：

字段取值处理

约束限制：

不涉及

取值范围：

  • SUM：累计

  • AVG：平均

  • COUNT：计数

  • NONE：无处理

默认取值：

NONE

match

String

参数解释：

匹配类型。关键词匹配建议使用REGEX。

约束限制：

不涉及。

取值范围：

  • EQUAL: 完全相等

  • REGEX：正则匹配

  • MATH_GT：数值大于

  • MATH_GE：数值大于等于

  • MATH_LT：数值小于

  • MATH_LE：数值小于等于

  • MATH_EQ：数值相等

默认取值：

不涉及

value

String

参数解释：

匹配值。

约束限制：

不涉及

取值范围：

字符长度0-1024

默认取值：

不涉及。
表10 TriggerProcess

参数

参数类型

描述

time_window

Integer

参数解释：

处理抑制时长。单位秒。

  • -1：表示整场直播仅触发一次。

  • 0：表示无抑制，每次都触发。

  • 其他值n：表示n秒内仅触发一次。

约束限制：

不涉及

默认取值：

不涉及

取值范围：

-1-7200

reply_mode

String

参数解释：

回复类型。

约束限制：

不涉及

取值范围：

  • SYSTEM_REPLY：系统自动回复预先设置的话术。

  • CALLBACK：回调给其他服务，携带设置的话术。

  • SHOW_LAYER：仅显示叠加图层，不影响话术。

  • INTELLIGENT_REPLY：使用配置的大模型生成回复话术。

默认取值：

不涉及

layer_config

SmartLayerConfig object

智能图层配置。

extra_layer_config

SmartLayerConfig object

额外图层，用于有产品同时需要显示动态文本场景，配置第二图层使用。

reply_texts

Array of strings

参数解释：

回复话术集。

约束限制：

不涉及

取值范围：

最大支持5条预置话术。

单条话术字符长度0-1024位。

默认取值：

不涉及

reply_audios

Array of ReplyAudioInfo objects

参数解释：

回复音频集。填写audio_url。

约束限制：

不涉及

取值范围：

最大支持5条预置音频。

默认取值：

不涉及

reply_order

String

参数解释：

回复话术选择次序。

约束限制：

不涉及

取值范围：

  • RANDOM：随机

  • ORDER：顺序循环

默认取值：

不涉及

reply_role

String

参数解释：

回复角色。

约束限制：

不涉及

取值范围：

  • STREAMER：主播

  • CO_STREAMER：助播，仅声音。

默认取值：

STREAMER

robot_id

String

参数解释：

机器人ID。

约束限制：

reply_mode为INTELLIGENT_REPLY时必填，智能交互配置的大模型机器人ID。

获取方法请参考创建应用。

取值范围：

字符长度0-64位。

默认取值：

不涉及

play_type

String

回复播放类型。

  • APPEND：追加，放置在场景播放队列尾部

  • INSERT： 插入，在两个音频文件，或者文本句末添加。

  • PLAY_NOW : 立即插入，收到指令后，立即播放，无需等待句末。

默认取值：

PLAY_NOW
表11 SmartLayerConfig

参数

参数类型

描述

layer_type

String

图层类型。

  • IMAGE： 素材图片图层

  • VIDEO： 素材视频图层

  • TEXT: 文本图层

asset_id

String

图层所需资产的资产id，外部资产信息无需填写

position

LayerPositionConfig object

图层位置配置。

size

LayerSizeConfig object

图层大小配置。

image_config

SmartImageLayerConfig object

素材图片图层配置。

video_config

SmartVideoLayerConfig object

素材视频图层配置。

text_config

SmartTextLayerConfig object

素材视频图层配置。
表12 LayerPositionConfig

参数

参数类型

描述

dx

Integer

参数解释：

图层左上角像素点的X轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

dy

Integer

参数解释：

图层图片左上角像素点的Y轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

layer_index

Integer

参数解释：

图片、视频、人物图的层顺序。

说明：

图层顺序为从1开始的整数，底层图层顺序是1，往上依次增加。

约束限制：

如果出现重复则重复图层叠加关系随机。

取值范围：

1-100

默认取值：

100
表13 LayerSizeConfig

参数

参数类型

描述

width

Integer

参数解释：

图层图片宽度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

1-7680

height

Integer

参数解释：

图层图片高度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。|

取值范围：

1-7680
表14 SmartImageLayerConfig

参数

参数类型

描述

image_url

String

图片文件的URL。

display_duration

Integer

参数解释：

图片显示时长，单位s。

显示时长规则为，若携带reply_texts、reply_audios，则与播放语音内容时长保持一致。若未携带，则与匹配的关键词语音内容时长保持一致。

取值范围：

0-3600

默认取值：

0
表15 SmartVideoLayerConfig

参数

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

display_duration

Integer

参数解释：

图片显示时长，单位s。

显示时长规则为，若携带reply_texts、reply_audios，则与播放语音内容时长保持一致。若未携带，则与匹配的关键词语音内容时长保持一致。

取值范围：

0-3600

默认取值：

0
表16 SmartTextLayerConfig

参数

参数类型

描述

text_type

String

参数解释：

文本类型。

  • DYNAMIC：动态文本，需要进行关键字替换。

  • STATIC：静态文本。

默认取值：

DYNAMIC

text_context

String

文本。

font_name

String

参数解释：

字体。当前支持的字体：

  • HarmonyOS_Sans_SC_Black：鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular：鸿蒙常规

  • HarmonyOS_Sans_SC_Thin：鸿蒙细体

  • fzyouh：方正瘦体

默认取值：

HarmonyOS_Sans_SC_Black

font_size

Integer

参数解释：

字体大小（像素）。

业务取值范围：[4, 120]，请以业务取值范围为准。

取值范围：

0-120

默认取值：

16

font_color

String

参数解释：

字体颜色。RGB颜色值。

默认取值：

#FFFFFF

display_duration

Integer

参数解释：

文本显示时长，单位s。

显示时长规则为，若携带reply_texts、reply_audios，则与播放语音内容时长保持一致；若未携带，则与匹配的关键词语音内容时长保持一致。

取值范围：

0-3600

默认取值：

0
表17 ReplyAudioInfo

参数

参数类型

描述

audio_url

String

音频URL

audio_name

String

音频名
表18 ReviewConfig

参数

参数类型

描述

no_need_review

Boolean

免审核。 目前仅白名单用户可使用此参数，非白名单用户跟随系统策略审核。

状态码： 400

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 401

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表21 响应Body参数

参数

参数类型

描述

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

内部服务错误。

错误码

请参见错误码。

父主题： 智能直播间管理

相关文档