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

注销用户 UnRegisterUsers

最近更新时间：2024.01.30 16:36:08

首次发布时间：2023.08.15 19:07:14

我的收藏

你可以使用此接口注销用户。

使用说明

你可以调用 UnRegisterUsers 接口，指定你所属的 AppId、用户 ID，对已注册的广播用户进行注销。

调用接口

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

注意事项

QPS 不得超过 50。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
UserIdsArray of Long是[10001,10002]注销用户 UserId。一次最多注销 10 个用户。

返回参数

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

参数类型示例值描述
FailedInfosArray of FailedInfos-注销失败的用户信息

FailedInfos

参数类型示例值描述
UserIdLong失败的uid
MessageString-错误信息。参考：错误码
CodeString-错误码。参考:https://www.volcengine.com/docs/6348/412253

请求示例

POST https://rtc.volcengineapi.com?Action=UnRegisterUsers&Version=2020-12-01
{
    "AppId": 0,
    "UserIds": [10001,10002]
}

返回示例

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

错误码

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