文档

CreateSignature - 创建 mrtc 签名

更新时间:

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

质检应用 ID

5bbfb884-1186-4d48-906b-88d586770f6b
ExpireTimeLong

过期时间,单位秒,默认时间 300s

300
Uidstring

rtc 用户 ID

550070734466****
ClientVersionstring

客户端版本

1.0.001
ClientBaseParamstring

客户端基础参数,记录 SDK 版本号等信息

{"version":"1.0.0"}

返回参数

名称类型描述示例值
object

ApiResult

RequestIdstring

requestId

A1899517-BB99-5D3E-A71B-97524DCB0942
Codestring

code

OK
Messagestring

提示

Dataobject

数据

RtcAppIdstring

mrtc 应用 ID

124325213125435
RtcWorkspaceIdstring

mrtc 工作空间

my_workspace
RtcBizNamestring

mrtc 业务名

音视频biz
RtcSignstring

mrtc 签名

字符串签名token
ExpireTimestring

过期时间(单位:毫秒)

300
Successboolean

给 pop 使用的

True
HttpCodeinteger

HTTP 状态码

200
Errorsarray

错误列表

object

错误列表

Fieldstring

错误 ID

A1899517-BB99-5D3E-A71B-97524DCB0942
Messagestring

错误消息

示例

正常返回示例

JSON格式

{
  "RequestId": "A1899517-BB99-5D3E-A71B-97524DCB0942",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "RtcAppId": "124325213125435",
    "RtcWorkspaceId": "my_workspace",
    "RtcBizName": "音视频biz",
    "RtcSign": "字符串签名token",
    "ExpireTime": "300"
  },
  "Success": true,
  "HttpCode": 200,
  "Errors": [
    {
      "Field": "A1899517-BB99-5D3E-A71B-97524DCB0942",
      "Message": "无"
    }
  ]
}

错误码

Http code错误码错误信息描述
400InvalidRequestThe request is invalid.无效的请求
401UnauthorizedThe request requires user authentication.该请求需要进行身份认证
403ForbiddenAccess to this resource on the server is denied.没有权限访问该资源
404ResourceNotFoundThe specified resource does not exist.找不到指定的资源
500InternalServerErrorAn internal server error occurred.服务器内部出错

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-02-21OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ClientBaseParam
2022-01-24OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
    删除错误码:403
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ClientVersion
2022-01-06OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:401
    删除错误码:403
    删除错误码:404
    删除错误码:500
2022-01-05新增 OpenAPI