You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

会话标记查询 GetConversationMarks

最近更新时间：2023.12.28 20:05:16

首次发布时间：2023.12.28 20:05:16

我的收藏

你可以调用 GetConversationMarks 接口，指定你所属的 AppId、会话成员 ID 对会话标记进行查询。

当前仅支持直播群。

注意事项

最大请求次数：100 次/秒

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetConversationMarks接口名称。当前 API 的名称为 GetConversationMarks。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
ConversationShortIdLong是000001会话 ID

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数类型示例值描述
MarkTypesArray of String["Mark1","Mark2"]标记类型

请求示例

POST https://rtc.volcengineapi.com?Action=GetConversationMarks&Version=2020-12-01
{
    "AppId":000000,
    "ConversationShortId":000001
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetConversationMarks",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "MarkTypes": [
            "Mark1",
            "Mark2"
        ]
    }
}

错误码

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