调用GetStandardRoomJumpUrl获取低代码服务跳转链接。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用加粗字体表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imp:GetStandardRoomJumpUrl | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。 | 7m***q |
UserId | string | 是 | 用户UserId,在AppId下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度32个字符。 | as****hs |
AppKey | string | 是 | 终端设备类型,通过控制台创建和查询。小写英文和数字,长度32个字符。 | 06***9c |
Platform | string | 是 | 选择获取链接的平台类型。取值:
| web |
BizType | string | 是 | 业务场景类型。取值:
| live |
BizId | string | 是 | 资源ID。根据业务场景类型来定:
| b7f2-****-ebb3 |
UserNick | string | 是 | 用户用于显示的昵称,英文大小写字母、汉字、数字、下划线(_)、短横线(-)、小数点(.)和@组成。长度为1到36个字符。 | James |
返回参数
示例
请求示例
http(s)://[Endpoint]/?Action=GetStandardRoomJumpUrl
&AppId=7m***q
&UserId=as****hs
&AppKey=06***9c
&Platform=web
&BizType=live
&BizId=b7f2-****-ebb3
&UserNick=James
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"StandardRoomJumpUrl": "http://xxx.com/standard_live?appId=l***u&userId=jm6&userAuthSession=0c179505-6d14-**-88a888d849ec&roomId=b807bd2a-**-96e1-c5753f13a5eb&appKey=63***3d&callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession"
}
}
XML
格式
<GetStandardRoomJumpUrlResponse>
<RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
<Result>
<StandardRoomJumpUrl>http://xxx.com/standard_live?appId=l***u&userId=jm6&userAuthSession=0c179505-6d14-**-88a888d849ec&roomId=b807bd2a-**-96e1-c5753f13a5eb&appKey=63***3d&callback=https%3A%2F%2Fxxx.com%2Fapi%2Flogin%2FcheckUserAuthSession</StandardRoomJumpUrl>
</Result>
</GetStandardRoomJumpUrlResponse>
错误码
Http code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.StandardRoom.LowCodeDomainNotConfig | This app is not configured with a low-code domain name. | 该应用没有配置低代码域名。 |
400 | InvalidAppId.StandardRoom.CnameNotConfig | The low-code integration service does not have a CNAME configured. | 低代码集成服务没有配置CNAME。 |
400 | InvalidParameter.StandardRoom.AppKeyNotMatch | The parameter AppId and the parameter AppKey do not match. | 传入参数AppId和AppKey不匹配。 |
访问错误中心查看更多错误码。