文档

GetConference - 查询连麦详情

更新时间:

调用GetConference查询指定连麦信息,包含连麦标题和连麦状态。也可查询连麦结束后的录制地址。

调试

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

调试

授权信息

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

请求参数

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

连麦唯一标识。由字母、数字和短横线(-)组成,长度为36个字符。

fb0f-****-4cb1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

返回结果。

ConferenceIdstring

连麦唯一标识,由调用CreateConference返回。由字母、数字和短横线(-)组成,长度为36个字符。

fb0f-****-4cb1
Titlestring

会议标题,支持中英文,最大长度128个字符。

This is a Title
Statusstring

状态。取值:

  • Init:未开始。
  • Start:连麦中。
  • End:连麦结束。
Init
RoomIdstring

房间唯一标识,最大长度36个字符。

AE35-****-T95F
UserIdstring

创建连麦的用户,在AppId下单独唯一。英文字母、数字、下划线(_)、短横线(-)、小数点(.)和@组成。长度为1到36个字符。

as****hs
AppIdstring

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

7m***q
CreateTimeLong

连麦创建时间戳,单位:毫秒。

1624589848000
PlaybackUrlstring

录制回放地址,m3u8格式,连麦结束后10秒才会生成。

http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3

示例

请求示例

http(s)://[Endpoint]/?Action=GetConference
&ConferenceId=fb0f-****-4cb1
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "ConferenceId": "fb0f-****-4cb1",
        "Title": "This is a Title",
        "Status": "Init",
        "RoomId": "AE35-****-T95F",
        "UserId": "as****hs",
        "AppId": "7m***q",
        "CreateTime": 1624589848000,
        "PlaybackUrl": "http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3"
    }
}

XML格式

<GetConferenceResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <ConferenceId>fb0f-****-4cb1</ConferenceId>
        <Title>This is a Title</Title>
        <Status>Init</Status>
        <RoomId>AE35-****-T95F</RoomId>
        <UserId>as****hs</UserId>
        <AppId>7m***q</AppId>
        <CreateTime>1624589848000</CreateTime>
        <PlaybackUrl>http://xxxx.com/b7f29c02-****-40fd-****-e8d06a8aebb3_merged.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrl>
    </Result>
</GetConferenceResponse>

错误码

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

  • 本页导读 (1)