channel-management-api-fixes

Author: saudsami

shared/common/_channel-management-api.mdx

@@ -76,13 +76,13 @@ Pass in the following parameters in the request body:
 
 | Parameter | Data type | Required/Optional | Description         |
 | :------ | :-----  |:----- | :---------------------- |
-| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link></li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>|
+| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link></li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul>|
 | `cname` | String | Optional |The channel name.              |
 | `uid` | Number | Optional |The user ID. Do not set it as `0`.              |
 | `ip` | String  | Optional |The IP address of the user. Do not set it as `0`.             |
-| `time` | Number | Required |The time duration (in minutes) to ban the user. The value range is [1,1440].<p> **Note**<li>If the set value is between `0` and `1`, Agora automatically sets the value to `1`.</li><li>If the set value is greater than `1440`, Agora automatically sets the value to `1440`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></p> |
-| `time_in_seconds` | Number | Required |The time duration (in seconds) to ban the user. The value range is [10,86430].<p>**Note**<li>If the set value is between `0` and `10`, Agora automatically sets the value to `10`.</li><li>If the set value is greater than `86430`, Agora automatically sets the value to `86430`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></p> |
-| `privileges` | Array | Required |The user privileges you want to block. You can choose the following values: <li> `join_channel`: String. Bans a user from joining a channel or kicks a user out of a channel.</li><li> `publish_audio`: String. Bans a user from publishing audio. </li><li> `publish_video`: Bans a user from publishing video. </li>You can pass in both `publish_audio` and `publish_video` to ban a user from publishing audio and video. |
+| `time` | Number | Required |The time duration (in minutes) to ban the user. The value range is [1,1440].<br/> <ul><li>If the set value is between `0` and `1`, Agora automatically sets the value to `1`.</li><li>If the set value is greater than `1440`, Agora automatically sets the value to `1440`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></ul> |
+| `time_in_seconds` | Number | Required |The time duration (in seconds) to ban the user. The value range is [10,86430].<br/><ul><li>If the set value is between `0` and `10`, Agora automatically sets the value to `10`.</li><li>If the set value is greater than `86430`, Agora automatically sets the value to `86430`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></ul> |
+| `privileges` | Array | Required |The user privileges you want to block. You can choose the following values: <ul><li> `join_channel`: String. Bans a user from joining a channel or kicks a user out of a channel.</li><li> `publish_audio`: String. Bans a user from publishing audio. </li><li> `publish_video`: Bans a user from publishing video. </li></ul> You can pass in both `publish_audio` and `publish_video` to ban a user from publishing audio and video. |
 
 ### Request examples
 

shared/common/channel-management-api/endpoints/ban-user-privileges/create-rules.mdx

@@ -29,7 +29,7 @@ The following parameters are required in the request body:
 
 | Parameter | Type   | Required/Optional | Description                                                  |
 | :------ | :-----  |:----- | :---------------------- |
-| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>|
+| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul>|
 | `id` | Number | Required | The ID of the rule that you want to delete. |
 
 ### Request examples

shared/common/channel-management-api/endpoints/ban-user-privileges/delete-rules.mdx

@@ -28,7 +28,7 @@ Pass the following query parameters in the request URL:
 
 | Parameter | Type           | Required/Optional |Description                            |
 | :------ | :---------------- |:------| :------------------------------ |
-| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li> |
+| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul> |
 
 **Request header**
 

shared/common/channel-management-api/endpoints/ban-user-privileges/get-rule-list.mdx

@@ -30,10 +30,10 @@ Pass in the following parameters in the request body:
 
 | Parameter     | Type |Required/Optional  | Description                     |
 | :---------------- | :-----|:-----  | :--------------------------------------- |
-| `appid`           | String | Required | The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>          |
+| `appid`           | String | Required | The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul> |
 | `id`              | Number | Required |The ID of the rule that you want to update.                                |
-| `time`            | Number | Required | The time duration (in minutes) to ban the user. The value range is [1,1440].<p> **Note**<li>If the set value is between `0` and `1`, Agora automatically sets the value to `1`.</li><li>If the set value is greater than `1440`, Agora automatically sets the value to `1440`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></p>|
-| `time_in_seconds` | Number | Required | The time duration (in seconds) to ban the user. The value range is [10,86430].<p>**Note**<li>If the set value is between `0` and `10`, Agora automatically sets the value to `10`.</li><li>If the set value is greater than `86430`, Agora automatically sets the value to `86430`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></p> |
+| `time`            | Number | Required | The time duration (in minutes) to ban the user. The value range is [1,1440].<br/> <ul><li>If the set value is between `0` and `1`, Agora automatically sets the value to `1`.</li><li>If the set value is greater than `1440`, Agora automatically sets the value to `1440`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></ul>|
+| `time_in_seconds` | Number | Required | The time duration (in seconds) to ban the user. The value range is [10,86430].<ul><li>If the set value is between `0` and `10`, Agora automatically sets the value to `10`.</li><li>If the set value is greater than `86430`, Agora automatically sets the value to `86430`.</li><li>If the set value is `0`, the banning rule does not take effect. The server sets all users that conform to the rule offline, and users can log in again to rejoin the channel.</li><li>Use either `time` or `time_in_seconds`. If you set both parameters, the `time_in_seconds` parameter takes effect; if you set neither of these parameters, the Agora server automatically sets the banning time duration to 60 minutes, that is, 3600 seconds.</li></ul> |
 
 ### Request examples
 Test this request in [Postman](https://documenter.getpostman.com/view/6319646/SVSLr9AM#ed57bf68-671c-4a1d-93ed-e545d9901745) or use one of the following code examples:
@@ -107,7 +107,7 @@ If the status code is `200`, the request succeeds, and the response body include
 | Parameter | Type   | Description                                                  |
 | :-------- | :----- | :----------------------------------------------------------- |
 | `status`  | String | The status of this request. `success` means the request succeeds. |
-| `result`  | Object | The result of the update:<li>`id`: String. The rule ID.</li><li>`ts`: String. The UTC time when the rule expires.</li> |
+| `result`  | Object | The result of the update:<ul><li>`id`: String. The rule ID.</li><li>`ts`: String. The UTC time when the rule expires.</li></ul> |
 
 ### Response example
 

shared/common/channel-management-api/endpoints/ban-user-privileges/update-expiration-time.mdx

@@ -22,15 +22,15 @@ Pass the following path parameters in the request URL:
 
 | Parameter   | Type   | Required/Optional | Description                                                  |
 | :------ | :-----  |:----- | :---------------------- |
-| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>|
+| `appid` | String | Required | The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul>|
 
 **Query parameters**
 
 Pass the following query parameters in the request URL:
 
 | Parameter   | Type   | Required/Optional | Description                                                  |
 | :------ | :-----  |:----- | :---------------------- |
-| `page_no` | Number | Optional | The page number that you want to query. The default value is 0, that is, the first page. <p>**Note**: The value of `page_no` cannot exceed (the total number of channels/the value of `page_size` - 1); otherwise, the specified page does not contain any channel.</p> |
+| `page_no` | Number | Optional | The page number that you want to query. The default value is 0, that is, the first page. **Note**: The value of `page_no` cannot exceed (the total number of channels/the value of `page_size` - 1); otherwise, the specified page does not contain any channel. |
 | `page_size` | Number | Optional | The number of channels on a page. The value range is [1,500], and the default value is 100. |
 
 **Request header**
@@ -98,7 +98,7 @@ If the status code is `200`, the request succeeds, and the response body include
 
 | Parameter | Type    | Description                                                  |
 | :-------- | :------ | :----------------------------------------------------------- |
-| `success` | Boolean | The state of this request: <li>`true`: Success. </li><li>`false`: Reserved for future use.</li> |
+| `success` | Boolean | The state of this request: <ul><li>`true`: Success. </li><li>`false`: Reserved for future use.</li></ul> |
 | `data`    | Object  | Channel statistics, including the following fields: <ul><li>`channels`: Array. The list of channels. This array contains multiple objects. Each object shows the information on a channel and includes the following fields:<ul><li>`channel_name`: String. The channel name. </li><li>`user_count`: Number. The total number of users in the channel. </li></ul>**Note**: If the specified page does not contain any channel, this field is empty.</li><li>`total_size`: Number. The total number of channels under the specified project.</li></ul> |
 
 ### Response example

shared/common/channel-management-api/endpoints/query-channel-information/query-channel-list.mdx

@@ -22,7 +22,7 @@ Pass the following path parameters in the request URL:
 
 | Parameter     | Type   | Required/Optional | Description                                                  |
 | :------ | :-----  |:----- | :---------------------- |
-| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>|
+| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul> |
 | `channelName` | String | Required | The channel name. |
 
 **Request header**
@@ -89,7 +89,7 @@ If the status code is `200`, the request succeeds, and the response body include
 
 | Parameter | Type    | Description                                                  |
 | :-------- | :------ | :----------------------------------------------------------- |
-| `success` | Boolean | The state of this request:<li>`true`: Success.</li><li>`false`: Reserved for future use.</li> |
+| `success` | Boolean | The state of this request:<ul><li>`true`: Success.</li><li>`false`: Reserved for future use.</li></ul> |
 | `data`    | Object  | User information, including the following fields: <ul><li>`channel_exist`: Boolean. Whether the specified channel exists:<ul><li>`true`: The channel exists.</li><li>`false`: The channel does not exist.</li></ul>**Note**: All other fields are not returned when the value of `channel_exist` is `false`.</li><li>`mode`: Number. The channel profile:<ul><li>`1`：The `COMMUNICATION` profile.</li><li>`2`: The `LIVE_BROADCASTING` profile.</li></ul></li><li>`broadcasters`：Array. User IDs of all hosts in the channel. This field is returned only when `mode` is `2`.</li></ul> |
 
 ### Response example

shared/common/channel-management-api/endpoints/query-channel-information/query-host-list.mdx

@@ -25,7 +25,7 @@ Pass the following path parameters in the request URL:
 
 | Parameter     | Type   | Required/Optional | Description                                                  |
 | :------ | :-----  |:----- | :---------------------- |
-| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li>|
+| `appid` | String | Required |The App ID of the project. You can get it through one of the following methods:<ul><li>Copy from the <Link to="{{Global.AGORA_CONSOLE_URL}}"><Vg k="CONSOLE" /></Link>.</li><li> Call the [Get all projects](/interactive-live-streaming/reference/agora-console-rest-api#get-all-projects) API, and read the value of the `vendor_key` field in the response body.</li></ul>|
 | `channelName` | String | Required | The channel name. |
 | `hosts_only` | String |Optional|If you fill in this parameter, only the host list in the live broadcast use-case will be returned.|