調用RemoveTerminals將指定終端用戶從頻道踢出。

使用說明

本接口用于將指定終端用戶從頻道踢出。

QPS限制

本接口的單用戶QPS限制為1000次/分鐘。超過限制，API調用會被限流，這可能會影響您的業(yè)務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 RemoveTerminals

系統(tǒng)規(guī)定參數。取值：RemoveTerminals。

AppId String 是 yourAppId

應用ID，僅支持傳單個ID。

可通過控制臺創(chuàng)建和查詢。
ChannelId String 是 yourChannelId

已加入的頻道ID，僅支持傳單個ID。
TerminalIds.N String 是 1811****

用戶ID列表，N的取值：1~30。格式如下所示： 


TerminalIds.1=****
TerminalIds.2=****
......

返回數據

名稱 類型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

請求ID。
Terminals Array of Terminal

用戶ID信息列表。
Terminal
Code Integer 0

狀態(tài)碼，成功返回0，失敗返回錯誤碼描述。
Message String Success

刪除終端操作結果。取值：

  • Success：成功。
  • Failed：失敗。
Id String 1811****

用戶ID。

示例

請求示例

https://rtc.aliyuncs.com/?Action=RemoveTerminals
&ChannelId=yourChannelId
&Terminals.1=1811****
&AppId=yourAppId
&<公共請求參數>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<RemoveTerminalsResponse>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
    <Terminals>
        <Id>1811****</Id>
        <Code>0</Code>
        <Message>Success</Message>
    </Terminals>
    <Terminals>
        <Id>1811****</Id>
        <Code>0</Code>
        <Message>Success</Message>
    </Terminals>
</RemoveTerminalsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Terminals" : [ {
    "Id" : "1811****",
    "Code" : 0,
    "Message" : "Success"
  }, {
    "Id" : "1811****",
    "Code" : 0,
    "Message" : "Success"
  } ]
}