修改消息扩展字段 ModifyMessage--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

修改消息扩展字段 ModifyMessage

最近更新时间：2024.04.17 17:35:51首次发布时间：2023.04.24 11:11:46

你可以使用此接口修改消息扩展字段。

使用说明

接口行为

你可以调用ModifyMessage接口，指定你所属的AppId和，会话 ID 和消息 ID，修改消息的扩展字段。

无法修改已过期消息。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
MessageId	Long	是	`10001`	消息 ID
Ext	JSON Map	否	`{"key":"value"}`	消息的扩展字段，key 的数据类型为 String，value 的数据类型为 String。目前更新的规则为相同的key，value直接覆盖。未出现的key，直接追加。举个例子，消息目前的ext为{"key1":"value1","key2":"value2"} 传入的为{"key3":"value3"} , key3为一个新的key，因此直接追加，最终ext为{"key1":"value1","key2":"value2","key3":"value3"} 传入的为{"key1":"update_value"} , key1目前已经存在了，因此直接覆盖对应的value，最终ext为{"key1":"update_value","key2":"value2"} 传入的为{"key1":"update_value","key3":"value3"},key1存在覆盖value，key3不存在需要追加，最终的ext为{"key1":"update_value","key2":"value2","key3":"value3"}
Content	String	否	`{\"text\":\"\"}`	消息内容。修改时`Content` 内容需符合客户端格式，详细信息请参看消息格式。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://rtc.volcengineapi.com?Action=ModifyMessage&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "MessageId": 10001,
    "Ext": {
        "key": "value"
    },
    "Content":"{\"text\":\"\"}"
}

返回示例

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

错误码

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