You need to enable JavaScript to run this app.
导航
修改会话信息 ModifyConversation
最近更新时间:2024.01.29 15:25:31首次发布时间:2023.04.24 11:11:46

你可以使用此接口修改会话信息。

使用说明

接口行为

你可以调用ModifyConversation接口,指定你所属的AppId和会话信息修改会话的详细信息。

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdInteger000000应用的唯一标志
ConversationCoreInfoObject of ConversationCoreInfo-会话信息

ConversationCoreInfo

参数类型是否必选示例值描述
ConversationShortIdLong000001需要修改的会话 ID
NameStringConversation会话名
AvatarUrlStringhttp://xxx.com会话头像 url
DescriptionStringYour_Description会话描述
NoticeStringYour_Notice会话公告
ExtJSON Map{"key":"value"}会话的扩展字段。key 的数据类型为 Stringvalue 的数据类型为 String
OwnerUserIdLong100001会话拥有人 UserId

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=ModifyConversation&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationCoreInfo": {
        "ConversationShortId": 000001,
        "Ext": {
            "key": "value"
        },
        "OwnerUserId": 100001
    }
}

返回示例

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

错误码

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