2024/06/27 17:32:12

Widget 相关

删除指定 Widget。

灵动课堂会将这个变化同步到所有端，以此来实现你自己的扩展业务。

接口原型：

方法：DELETE
接入点：/{region}/edu/apps/{appId}/v2/rooms/{roomUuid}/widgets/{widgetUuid}

请求参数

URL 参数

参数	类型	是否必填	描述
`region`	String	必填	服务区域，可设为如下值： `cn`：中国大陆 `ap`：亚太 `na`：北美 `eu`：欧洲注意对于同一课堂，服务端接口调用的区域需要与客户端课堂创建的区域一致，否则会报告“房间不存在”的错误。
`appId`	String	必填	你在声网控制台创建的项目的 App ID，详见获取 App ID。
`roomUuid`	String	必填	课堂 UUID。这是课堂的唯一标识符，也是加入 RTC 和 RTM 时所使用的频道名。长度在 64 字符以内。若该房间需要使用页面录制，长度需在 50 字符内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`widgetUuid`	String	必填	Widget uuid。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`

请求包体参数

参数	类型	是否必填	描述
`cause`	Object	非必填	本次删除原因。

请求示例

Shell
curl -X DELETE 'https://api.sd-rtn.com/{region}/edu/apps/{yourAppId}/v2/rooms/test_class/widgets/test_widget' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: agora token={educationToken}' \
--data-raw '{
  "cause": {}
}'

响应参数

参数类型描述

参数	类型	描述
`code`	Integer	响应状态码： `0`: 请求成功。非 `0`: 请求失败。详见响应状态码。
`msg`	String	接口响应的文字信息。
`ts`	Number	当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

code

Integer

响应状态码：

0: 请求成功。
非 0: 请求失败。详见响应状态码。

msg

String

接口响应的文字信息。

ts

Number

当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

响应示例

JSON
{
  "msg": "Success",
  "code": 0,
  "ts": 1610167740309
}

设置指定 Widget 的房间属性。

你可以对 Widget 设置任意房间属性，灵动课堂会将这个属性的变更同步到所有端，以此来实现你自己的扩展业务。详见如何设置自定义用户属性和课堂属性？。

接口原型：

方法：PUT
请求路径：/{region}/edu/apps/{appId}/v2/rooms/{roomUuid}/widgets/{widgetUuid}

请求参数

URL 参数

参数	类型	是否必填	描述
`region`	String	必填	服务区域，可设为如下值： `cn`：中国大陆 `ap`：亚太 `na`：北美 `eu`：欧洲注意对于同一课堂，服务端接口调用的区域需要与客户端课堂创建的区域一致，否则会报告“房间不存在”的错误。
`appId`	String	必填	你在声网控制台创建的项目的 App ID，详见获取 App ID。
`roomUuid`	String	必填	课堂 UUID。这是课堂的唯一标识符，也是加入 RTC 和 RTM 时所使用的频道名。长度在 64 字符以内。若该房间需要使用页面录制，长度需在 50 字符内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`widgetUuid`	String	必填	Widget uuid。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`

请求包体参数

参数	类型	是否必填	描述
`extra`	Object	非必填	Widget 属性。
`cause`	Object	非必填	更新原因。
`state`	Integer	非必填	Widget 的活跃状态： `0`：关闭 `1`：开启
`ownerUserUuid`	String	非必填	Widget 所属用户。如果填写了该参数，在 widget 所属用户离线后，widget 会被自动删除。

请求示例

Shell
curl -X PUT 'https://api.sd-rtn.com/{region}/edu/apps/{yourAppId}/v2/rooms/test_class/widgets/test_widget' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: agora token={educationToken}' \
--data-raw '{
  "properties": {
    "key1": "value1",
    "key2": "value2"
  },
  "cause": {}
}'

响应参数

参数类型描述

参数	类型	描述
`code`	Integer	响应状态码： `0`: 请求成功。非 `0`: 请求失败。详见响应状态码。
`msg`	String	接口响应的文字信息。
`ts`	Number	当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

code

Integer

响应状态码：

0: 请求成功。
非 0: 请求失败。详见响应状态码。

msg

String

接口响应的文字信息。

ts

Number

当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

响应示例

JSON
{
  "msg": "Success",
  "code": 0,
  "ts": 1610167740309
}

删除指定 Widget 的属性。

你可以删除任意 Widget 属性，灵动课堂会将这个属性的变更同步到所有端，以此来实现你自己的扩展业务。设置方式同课堂属性和用户属性，详见如何设置自定义用户属性和课堂属性？

接口原型：

方法：DELETE
接入点：/{region}/edu/apps/{appId}/v2/rooms/{roomUuid}/widgets/{widgetUuid}/extra

请求参数

URL 参数

参数	类型	是否必填	描述
`region`	String	必填	服务区域，可设为如下值： `cn`：中国大陆 `ap`：亚太 `na`：北美 `eu`：欧洲注意对于同一课堂，服务端接口调用的区域需要与客户端课堂创建的区域一致，否则会报告“房间不存在”的错误。
`appId`	String	必填	你在声网控制台创建的项目的 App ID，详见获取 App ID。
`roomUuid`	String	必填	课堂 UUID。这是课堂的唯一标识符，也是加入 RTC 和 RTM 时所使用的频道名。长度在 64 字符以内。若该房间需要使用页面录制，长度需在 50 字符内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`widgetUuid`	String	必填	Widget uuid。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`

请求包体参数

参数	类型	是否必填	描述
`properties`	String []	必填	需删除的 widget 属性数组，即 `extra` 字段的值。
`cause`	Object	非必填	删除原因。

请求示例

Shell
curl -X DELETE 'https://api.sd-rtn.com/{region}/edu/apps/{yourAppId}/v2/rooms/test_class/widgets/test_widget/extra' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: agora token={educationToken}' \
--data-raw '{
  "properties": ["key-path1", "key-path2"],
  "cause": {}
}'

响应参数

参数类型描述

参数	类型	描述
`code`	Integer	响应状态码： `0`: 请求成功。非 `0`: 请求失败。详见响应状态码。
`msg`	String	接口响应的文字信息。
`ts`	Number	当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

code

Integer

响应状态码：

0: 请求成功。
非 0: 请求失败。详见响应状态码。

msg

String

接口响应的文字信息。

ts

Number

当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

响应示例

JSON
{
  "msg": "Success",
  "code": 0,
  "ts": 1610167740309
}

设置指定 Widget 的用户属性。

你可以对 widget 设置用户属性，灵动课堂会将这个属性的变更同步到所有端，以此来实现你自己的扩展业务。设置方式同课堂属性和用户属性，详见如何设置自定义用户属性和课堂属性？

接口原型：

方法：PUT
请求路径：/{region}/edu/apps/{appId}/v2/rooms/{roomUuid}/widgets/{widgetUuid}/users/{userUuid}

请求参数

URL 参数

参数	类型	是否必填	描述
`region`	String	必填	服务区域，可设为如下值： `cn`：中国大陆 `ap`：亚太 `na`：北美 `eu`：欧洲注意对于同一课堂，服务端接口调用的区域需要与客户端课堂创建的区域一致，否则会报告“房间不存在”的错误。
`appId`	String	必填	你在声网控制台创建的项目的 App ID，详见获取 App ID。
`roomUuid`	String	必填	课堂 UUID。这是课堂的唯一标识符，也是加入 RTC 和 RTM 时所使用的频道名。长度在 64 字符以内。若该房间需要使用页面录制，长度需在 50 字符内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`widgetUuid`	String	必填	Widget uuid。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`userUuid`	String	必填	用户 UUID。这是用户的唯一标识符，也是登录 RTM 系统时所使用的用户 ID。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`

请求包体参数

参数	类型	是否必填	描述
`properties`	Object	必填	需设置的 Widget 用户属性。
`cause`	Object	非必填	更新原因。

请求示例

Shell
curl -X PUT 'https://api.sd-rtn.com/{region}/edu/apps/{yourAppId}/v2/rooms/test_class/widgets/test_widget/users/test_user' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: agora token={educationToken}' \
--data-raw '{
  "properties": {
    "key1": "value1",
    "key2": "value2"
  },
  "cause": {}
}'

响应参数

参数类型描述

参数	类型	描述
`code`	Integer	响应状态码： `0`: 请求成功。非 `0`: 请求失败。详见响应状态码。
`msg`	String	接口响应的文字信息。
`ts`	Number	当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

code

Integer

响应状态码：

0: 请求成功。
非 0: 请求失败。详见响应状态码。

msg

String

接口响应的文字信息。

ts

Number

当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

响应示例

JSON
{
  "msg": "Success",
  "code": 0,
  "ts": 1610167740309
}

删除指定 Widget 的用户属性。

你可以删除 widget 的用户属性，灵动课堂会将这个属性的变更同步到所有端，以此来实现你自己的扩展业务。设置方式同课堂属性和用户属性，详见如何设置自定义用户属性和课堂属性？

接口原型：

方法：DELETE
接入点：/{region}/edu/apps/{appId}/v2/rooms/{roomUuid}/widgets/{widgetUuid}/users/{userUuid}

请求参数

URL 参数

参数	类型	是否必填	描述
`region`	String	必填	服务区域，可设为如下值： `cn`：中国大陆 `ap`：亚太 `na`：北美 `eu`：欧洲注意对于同一课堂，服务端接口调用的区域需要与客户端课堂创建的区域一致，否则会报告“房间不存在”的错误。
`appId`	String	必填	你在声网控制台创建的项目的 App ID，详见获取 App ID。
`roomUuid`	String	必填	课堂 UUID。这是课堂的唯一标识符，也是加入 RTC 和 RTM 时所使用的频道名。长度在 64 字符以内。若该房间需要使用页面录制，长度需在 50 字符内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`widgetUuid`	String	必填	Widget uuid。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`
`userUuid`	String	必填	用户 UUID。这是用户的唯一标识符，也是登录 RTM 系统时所使用的用户 ID。长度在 64 字符以内。以下为支持的字符集范围（共 89 个字符）: 26 个小写英文字母 a-Z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `-`, `:`, `;`, `<`, `=`, `.`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `}`, `\|`, `~`, `,`

请求包体参数

参数	类型	是否必填	描述
`properties`	String []	必填	需删除的 Widget 用户属性。
`cause`	Object	非必填	删除原因。

请求示例

Shell
curl -X DELETE 'https://api.sd-rtn.com/{region}/edu/apps/{yourAppId}/v2/rooms/test_class/widgets/test_widget/users/test_user' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: agora token={educationToken}' \
--data-raw '{
  "properties": ["key1","key2"],
  "cause": {}
}'

响应参数

参数类型描述

参数	类型	描述
`code`	Integer	响应状态码： `0`: 请求成功。非 `0`: 请求失败。详见响应状态码。
`msg`	String	接口响应的文字信息。
`ts`	Number	当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

code

Integer

响应状态码：

0: 请求成功。
非 0: 请求失败。详见响应状态码。

msg

String

接口响应的文字信息。

ts

Number

当前服务端的 Unix 时间戳，UTC 时间，单位为毫秒。

响应示例

JSON
{
  "msg": "Success",
  "code": 0,
  "ts": 1610167740309
}

Widget 相关

删除 Widget

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

设置 Widget 房间属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

删除 Widget 房间属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

设置 Widget 用户属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

删除 Widget 用户属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

删除 Widget​

请求参数​

URL 参数​

请求包体参数​

请求示例​

响应参数​

响应示例​

设置 Widget 房间属性​

请求参数​

URL 参数​

请求包体参数​

请求示例​

响应参数​

响应示例​

删除 Widget 房间属性​

请求参数​

URL 参数​

请求包体参数​

请求示例​

响应参数​

响应示例​

设置 Widget 用户属性​

请求参数​

URL 参数​

请求包体参数​

请求示例​

响应参数​

响应示例​

删除 Widget 用户属性​

请求参数​

URL 参数​

请求包体参数​

请求示例​

响应参数​

响应示例​

删除 Widget

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

设置 Widget 房间属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

删除 Widget 房间属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

设置 Widget 用户属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例

删除 Widget 用户属性

请求参数

URL 参数

请求包体参数

请求示例

响应参数

响应示例