标记会话 MarkConversation--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

标记会话 MarkConversation

最近更新时间：2023.12.28 20:05:16首次发布时间：2023.12.28 20:05:16

你可以调用 MarkConversation 接口，指定你所属的 AppId、会话成员 ID 和标记类型对会话进行标记。

当前仅支持直播群。

注意事项

最大请求次数：50 次/秒

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=MarkConversation&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`MarkConversation`	接口名称。当前 API 的名称为 `MarkConversation`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
MarkTypes	Array of String	是	`[Mark1,Mark2]`	标记类型。一个直播群最多有 20个标记。
MarkAction	Integer	否	`1`	操作类型。默认值为 `1`。 `1`:新增 `2`:删除。
Operator	Long	否	`10001`	操作人UserId

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
当前返回值 Result 请求成功或失败时均返回空值。

请求示例

POST https://rtc.volcengineapi.com?Action=MarkConversation&Version=2020-12-01
{
    "AppId":000000,
    "ConversationShortId":000001,
    "MarkTypes":["Mark1","Mark2"],
    "MarkAction":1,
    "Operator":10001
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "MarkConversation",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

您可访问公共错误码，获取更多错误码信息。