更新时间:2024-11-18 GMT+08:00
分享

上报直播间事件

功能介绍

该接口用于上报直播间事件。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/live-event-report

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

room_id

String

剧本ID。

job_id

String

任务ID。

表2 Query参数

参数

是否必选

参数类型

描述

auth_key

String

鉴权Key。通过HmacSHA256生成的鉴权key

expires_time

Long

参数解释

鉴权key过期时间。从1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数。

取值范围:

0-4102415999000

refresh_url

Boolean

是否刷新URL

请求参数

表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。不允许输入中文。

表4 请求Body参数

参数

是否必选

参数类型

描述

total

Integer

参数解释

事件条目数。

取值范围:

1-1000

events

Array of LiveEvent objects

事件内容。

review_config

ReviewConfig object

内容审核配置

表5 LiveEvent

参数

是否必选

参数类型

描述

timestamp

Long

参数解释

事件戳。从1970-01-01 00:00:00:000开始的毫秒数

取值范围:

0-4102415999000

type

Integer

参数解释

事件类型。

  • 1 弹幕信息

  • 2 用户入场

  • 3 用户点赞

  • 4 用户送礼

  • 5 用户订阅\关注

  • 6 房间观看人数

取值范围:

0-100

content

String

事件内容。

事件类型不同,content内容也不同,定义如下所示:

  • type=1 弹幕信息

    content定义:

    • user:用户,json

    • content: string,弹幕内容user定义:

    • userId:用户id,string

    • name:用户姓名,string

    • level:用户平台等级,int

    • badge:用户牌子名称,string

    • badgeLevel:牌子等级,int举例:

    {
      "timestamp": 1694481224245,
      "type": 1,
      "content": "{\"user\":{\"userId\":\"2027271526\",\"name\":\"***\",\"level\":17,\"badge\":\"\",\"badgeLevel\":0},\"content\":\"***\"}"
    }
  • type=2 用户入场

    content定义:

    • user:用户,json举例:

    {
      "timestamp": 1694481227655,
      "type": 2,
      "content": "{\"user\":{\"userId\":\"2978899271\",\"name\":\"***\",\"level\":1,\"badge\":\"\",\"badgeLevel\":0}}"
    }
  • type=3 用户点赞

    content定义:

    • user:用户,json举例:

    {
      "timestamp": 1694481227655,
      "type": 2,
      "content": "{\"user\":{\"userId\":\"2978899271\",\"name\":\"***\",\"level\":1,\"badge\":\"\",\"badgeLevel\":0}}"
    }
  • type=4 用户送礼

    content定义:

    • user:用户,json

    • gift:礼物信息,jsongift定义:

    • giftName:礼物名称,string

    • giftNum:礼物数量,int

    • totalValue:此处礼物总价值,int

    • giftValue:单个礼物价值,int举例:

    {
      "timestamp": 1690531652862,
      "type": 4,
      "content": "{\"gift\":{\"giftName\":\"小星星\",\"giftNum\":10,\"totalValue\":10,\"giftValue\":3},\"user\":{\"userId\":\"douyin_95882940927\",\"name\":\"纯爱战士熙熙\",\"level\":2,\"badge\":\"\",\"badgeLevel\":0}}"
    }
  • type=5 用户订阅

    暂未使用

  • type=6 房间观看人数

    content定义:

    • numberOfViewers:房间观看人数,int举例:

    {
      "timestamp": 1694481236886,
      "type": 6,
      "content": "{\"numberOfViewers\":5466}"
    }
表6 ReviewConfig

参数

是否必选

参数类型

描述

no_need_review

Boolean

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

响应参数

状态码: 200

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表8 响应Body参数

参数

参数类型

描述

live_event_report_url

String

刷新后的直播事件上传URL

状态码: 400

表9 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

请求传参异常,包含错误码及对应描述。

状态码: 401

表10 响应Body参数

参数

参数类型

描述

Unauthorized

AnyType

未鉴权或鉴权失败。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

InternalServiceError

AnyType

内部服务错误。

请求示例

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs/26f06524-4f75-4b3a-a853-b649a21aaf66/live-event-report

{
  "total" : 1,
  "events" : [ {
    "timestamp" : 1690819199000,
    "type" : 1,
    "content" : "xxxxx"
  } ]
}

响应示例

状态码: 200

成功。

{
  "live_event_report_url" : "https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs/26f06524-4f75-4b3a-a853-b649a21aaf66/live-event-report"
}

状态码: 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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.*;

import java.util.List;
import java.util.ArrayList;

public class LiveEventReportSolution {

    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();
        LiveEventReportRequest request = new LiveEventReportRequest();
        request.withRoomId("{room_id}");
        request.withJobId("{job_id}");
        ReportLiveEventReq body = new ReportLiveEventReq();
        List<LiveEvent> listbodyEvents = new ArrayList<>();
        listbodyEvents.add(
            new LiveEvent()
                .withTimestamp(1690819199000L)
                .withType(1)
                .withContent("xxxxx")
        );
        body.withEvents(listbodyEvents);
        body.withTotal(1);
        request.withBody(body);
        try {
            LiveEventReportResponse response = client.liveEventReport(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
32
33
34
35
36
37
38
39
40
41
42
43
44
# 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 = LiveEventReportRequest()
        request.room_id = "{room_id}"
        request.job_id = "{job_id}"
        listEventsbody = [
            LiveEvent(
                timestamp=1690819199000,
                type=1,
                content="xxxxx"
            )
        ]
        request.body = ReportLiveEventReq(
            events=listEventsbody,
            total=1
        )
        response = client.live_event_report(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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.LiveEventReportRequest{}
	request.RoomId = "{room_id}"
	request.JobId = "{job_id}"
	typeEvents:= int32(1)
	contentEvents:= "xxxxx"
	var listEventsbody = []model.LiveEvent{
        {
            Timestamp: int64(1690819199000),
            Type: &typeEvents,
            Content: &contentEvents,
        },
    }
	request.Body = &model.ReportLiveEventReq{
		Events: &listEventsbody,
		Total: int32(1),
	}
	response, err := client.LiveEventReport(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功。

400

请求传参异常,包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码

相关文档