You need to enable JavaScript to run this app.
导航

修改消息扩展字段 ModifyMessage

最近更新时间2024.02.19 16:54:18

首次发布时间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

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

Body

参数类型是否必选示例值描述
AppIdInteger000000应用的唯一标志
ConversationShortIdLong000001会话 ID
MessageIdLong10001消息 ID
ExtJSON Map{"key":"value"}消息的扩展字段
ContentString{\"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": {}
}

错误码

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