Merge pull request #138 from jdcloud-apigateway/master

openjrtc v1.1.2

Author: jdcloud-apigateway

jdcloud_sdk/services/openjrtc/ChangeLog.md

@@ -1,8 +1,10 @@
 # 更新历史 #
-API版本：1.1.0
+API版本：1.1.1
 
 |发布时间|版本号|更新|说明|
 |---|---|---|---|
 |2020-11-30   |1.0.0   |初始版本       |* 音视频融合rtc openApi |
 |2021-01-28   |1.1.0   |增加接口       |* 查询应用appKey;<br>* 查询应用信息;<br>* 查询用户应用列表;<br>* 修改房间;<br>* 查询房间信息;<br>* 删除房间;<br>* 查询应用下的房间列表;<br> |
+|2021-02-19   |1.1.1   |增加接口       |* 移除房间内人员;<br>* 移除房间内所有人员;<br>* 发送自定义信令给房间内的人员;<br>* 发送自定义信令给房间 ;<br> |
+|2021-07-16   |1.1.2   |增加接口       |* 注册用户;<br>* 查询注册用户;<br>* 查询注册用户列表;<br>* 注册用户房间号;<br>* 查询注册房间号;<br>* 查询注册房间号列表;<br>* 修改房间;<br>* 查询房间内人员列表;<br>* 统计房间内人数;<br>* 移除房间内所有人员;<br>* 移除房间内指定人员;<br>* 发送自定义信令给房间内的人员;<br>* 发送自定义信令给房间;<br>* 生成token;<br> |
 

jdcloud_sdk/services/openjrtc/apis/CreateRoomRequest.py

@@ -39,6 +39,7 @@ def __init__(self, ):
 
         self.roomName = None
         self.appId = None
+        self.roomType = None
         self.peerId = None
 
     def setRoomName(self, roomName):
@@ -53,6 +54,12 @@ def setAppId(self, appId):
         """
         self.appId = appId
 
+    def setRoomType(self, roomType):
+        """
+        :param roomType: (Optional) 房间类型 1-小房间(音频单流订阅) 2-大房间(音频固定订阅)
+        """
+        self.roomType = roomType
+
     def setPeerId(self, peerId):
         """
         :param peerId: (Optional) 用户ID(创建者ID)

jdcloud_sdk/services/openjrtc/apis/CreateTokenRequest.py

@@ -0,0 +1,75 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class CreateTokenRequest(JDCloudRequest):
+    """
+    生成token-用户加入房间时携带token校验通过后方能加入
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(CreateTokenRequest, self).__init__(
+            '/createToken', 'POST', header, version)
+        self.parameters = parameters
+
+
+class CreateTokenParameters(object):
+
+    def __init__(self, ):
+        """
+        """
+
+        self.appId = None
+        self.appKey = None
+        self.userId = None
+        self.userRoomId = None
+        self.timestamp = None
+
+    def setAppId(self, appId):
+        """
+        :param appId: (Optional) appId
+        """
+        self.appId = appId
+
+    def setAppKey(self, appKey):
+        """
+        :param appKey: (Optional) appKey
+        """
+        self.appKey = appKey
+
+    def setUserId(self, userId):
+        """
+        :param userId: (Optional) 用户id
+        """
+        self.userId = userId
+
+    def setUserRoomId(self, userRoomId):
+        """
+        :param userRoomId: (Optional) 业务接入方定义的且在JRTC系统内注册过的房间号
+        """
+        self.userRoomId = userRoomId
+
+    def setTimestamp(self, timestamp):
+        """
+        :param timestamp: (Optional) 时间戳-毫秒
+        """
+        self.timestamp = timestamp
+

jdcloud_sdk/services/openjrtc/apis/DescribeRegisterUserRequest.py

@@ -0,0 +1,44 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class DescribeRegisterUserRequest(JDCloudRequest):
+    """
+    查询注册用户
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(DescribeRegisterUserRequest, self).__init__(
+            '/describeRegisterUser/{appId}', 'GET', header, version)
+        self.parameters = parameters
+
+
+class DescribeRegisterUserParameters(object):
+
+    def __init__(self, appId, userId):
+        """
+        :param appId: 应用ID
+        :param userId: 业务接入方用户体系定义的且在JRTC系统内注册过的userId
+        """
+
+        self.appId = appId
+        self.userId = userId
+

jdcloud_sdk/services/openjrtc/apis/DescribeRegisterUsersRequest.py

@@ -0,0 +1,69 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class DescribeRegisterUsersRequest(JDCloudRequest):
+    """
+    查询注册用户列表
+允许通过条件过滤查询，支持的过滤字段如下：
+           - startTime[eq] 用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
+           - endTime[eq] 用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(DescribeRegisterUsersRequest, self).__init__(
+            '/describeRegisterUsers/{appId}', 'GET', header, version)
+        self.parameters = parameters
+
+
+class DescribeRegisterUsersParameters(object):
+
+    def __init__(self, appId, ):
+        """
+        :param appId: 应用ID
+        """
+
+        self.appId = appId
+        self.pageNumber = None
+        self.pageSize = None
+        self.filters = None
+
+    def setPageNumber(self, pageNumber):
+        """
+        :param pageNumber: (Optional) 页码；默认值为 1
+        """
+        self.pageNumber = pageNumber
+
+    def setPageSize(self, pageSize):
+        """
+        :param pageSize: (Optional) 分页大小；默认值为 10；取值范围 [10, 100]
+        """
+        self.pageSize = pageSize
+
+    def setFilters(self, filters):
+        """
+        :param filters: (Optional) 传参字段描述:
+  startTime[eq]:   用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
+  endTime[eq]:     用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
+
+        """
+        self.filters = filters
+

jdcloud_sdk/services/openjrtc/apis/DescribeRoomUsersNumRequest.py

@@ -0,0 +1,44 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class DescribeRoomUsersNumRequest(JDCloudRequest):
+    """
+    统计房间内人数
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(DescribeRoomUsersNumRequest, self).__init__(
+            '/describeRoomUsersNum/{appId}', 'GET', header, version)
+        self.parameters = parameters
+
+
+class DescribeRoomUsersNumParameters(object):
+
+    def __init__(self, appId, userRoomId):
+        """
+        :param appId: 应用ID
+        :param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号
+        """
+
+        self.appId = appId
+        self.userRoomId = userRoomId
+

jdcloud_sdk/services/openjrtc/apis/DescribeRoomUsersRequest.py

@@ -0,0 +1,73 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class DescribeRoomUsersRequest(JDCloudRequest):
+    """
+    查询房间内人员列表
+允许通过条件过滤查询，支持的过滤字段如下：
+           - status[eq] 在线状态 1-在线 2-离线
+           - startTime[eq] 用户加入时间段开始时间-UTC时间  startTime,endTime同时有值时生效
+           - endTime[eq] 用户加入时间段结束时间-UTC时间    startTime,endTime同时有值时生效
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(DescribeRoomUsersRequest, self).__init__(
+            '/describeRoomUsers/{appId}', 'GET', header, version)
+        self.parameters = parameters
+
+
+class DescribeRoomUsersParameters(object):
+
+    def __init__(self, appId, userRoomId, ):
+        """
+        :param appId: 应用ID
+        :param userRoomId: 业务接入方定义的且在JRTC系统内注册过的房间号
+        """
+
+        self.appId = appId
+        self.pageNumber = None
+        self.pageSize = None
+        self.userRoomId = userRoomId
+        self.filters = None
+
+    def setPageNumber(self, pageNumber):
+        """
+        :param pageNumber: (Optional) 页码；默认值为 1
+        """
+        self.pageNumber = pageNumber
+
+    def setPageSize(self, pageSize):
+        """
+        :param pageSize: (Optional) 分页大小；默认值为 10；取值范围 [10, 100]
+        """
+        self.pageSize = pageSize
+
+    def setFilters(self, filters):
+        """
+        :param filters: (Optional) 传参字段描述:
+- status[eq] 在线状态 1-在线 2-离线
+- startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效
+- endTime[eq] 用户加入时间段结束时间-UTC时间   startTime,endTime同时有值时生效
+
+        """
+        self.filters = filters
+

jdcloud_sdk/services/openjrtc/apis/DescribeUserByPeerRequest.py

@@ -0,0 +1,42 @@
+# coding=utf8
+
+# Copyright 2018 JDCLOUD.COM
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# NOTE: This class is auto generated by the jdcloud code generator program.
+
+from jdcloud_sdk.core.jdcloudrequest import JDCloudRequest
+
+
+class DescribeUserByPeerRequest(JDCloudRequest):
+    """
+    查询peer对应的用户信息
+
+    """
+
+    def __init__(self, parameters, header=None, version="v1"):
+        super(DescribeUserByPeerRequest, self).__init__(
+            '/describeUserByPeer', 'GET', header, version)
+        self.parameters = parameters
+
+
+class DescribeUserByPeerParameters(object):
+
+    def __init__(self, peerId):
+        """
+        :param peerId: peerId
+        """
+
+        self.peerId = peerId
+