Loading...

    根据云会议室号查看当前会议全体成员的会议状态

    功能说明

    与会成员的实时信息查询接口，服务器端将返回当前与会成员列表及状态。

    注意： 如需定时轮询获取参会人员状态变更情况，建议使用事件回调中的ConferenceRosterInfo事件监听会议状态，否则可能会触发限流。

    默认接口请求频率限制【相同云会议室】：1次/2秒。

    实现方法

    REST URL 

    GET https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{callNumber}/meetingStatus?enterpriseId=XXX&signature=XXX

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    version

    String

    Path

    是

    无

    v1


    enterpriseId

    String

    Query

    是

    无

    企业ID，通过管理平台-云视讯API获得


    signature

    String

    Query

    签名鉴权1.0（旧）：是

    签名鉴权2.0：否

    无

    API签名，参见签名规则


    callNumber

    String

    Path

    是

    无

    当前会议的云会议号

    3.9

    示例代码

    返回结果示例：

    成功时返回结果数据，失败时返回小鱼RESTAPI错误码 

    {
        "meetingRoomNumber": "9100637037",
        "meetingName": "小毛的会议室",
        "meetingId": "101-bj1-prdSig1-113314433680",
        "mode": null,
        "mainVenue": null,
        "mainImage": {
            "id": 131122,
            "type": 1,
            "externalUserId": null,
            "participantNumber": "13137387788"
        },
        "deviceStatusList": [
            {
                "name": "大毛的客户端",
                "muteStatus": 0,
                "vedioStatus": 0,
                "watingState":1,
                "participantVideoStatus":1,
                "hideEndpointVideo":"hidden",
                "device": {
                    "id": 122133,
                    "type": 1,
                    "participantId": "12332",
                    "externalUserId": "maomao",
                    "participantNumber": "13137388877",
                    "hardDevice": false,
                    "softDevice": false,
                    "deskDevice": false
                }
            }
        ],
        "handUpList": [
            {
                "id": 123321,
                "type": 5
            }
        ],
        "recordingDevice": {
            "id": 122133,
            "type": 1,
            "externalUserId": "maomao",
            "participantNumber": "13137388877"
        },
        "contentDevice": {
            "id": 122133,
            "type": 1,
            "externalUserId": "maomao",
            "participantNumber": "13137388877"
        },
        "whiteBoardDevice": {
            "id": 122133,
            "type": 1,
            "externalUserId": "maomao",
            "participantNumber": "13137388877"
        },
        "forceMute": false,
        "locked": false,
        "superviseMode": false,
        "unReceiveAudioDeviceList": null,
        "dialogueMode": false,
        "focusMode": false,
        "waitingRoom": false,
        "multiImageBroadcastDevice": {
            "id": 7,
            "type": 8,
            "participantId": null,
            "externalUserId": null,
            "participantNumber": null
        }
    }

    返回参数说明

    参数名称

    说明

    初始平台

    meetingRoomNumber

    云会议号或终端号

    all

    meetingId

    当前会议id

    all

    meetingName

    云会议室名称

    all

    mode

    会议模式，1 主席模式，0 讨论模式

    all

    mainVenue

    丢弃不用的属性值

    all

    mainImage

    主席模式时，设为主会场的设备

    all

    deviceStatusList

    设备及状态列表

    all

    name

    参会方显示名称

    all

    muteStatus

    参会方静音状态，1表示设备被静音，0表示非静音状态

    all

    vedioStatus

    参会方摄像头状态，1表示设备摄像头关闭，0表示设备摄像头打开(分区云5.2环境暂不支持)

    all

    watingState

    设备等候状态，1(在等待中),0(已进入)

    分区云20240329

    participantVideoStatus

    1:关闭视频 2:开启视频

    分区云20241018

    hideEndpointVideo

    为空 则表示不支持该功能

    为 “hidden”表示已经隐藏

    为“open”表示当前没有隐藏

    分区云20241018

    device

    表示参会方设备，含两个字段id,type

    all

    id

    参会方设备id(对于type=1、type=5，此处的id对应小鱼体系的UserId；对于type=7，对应终端号，其他类型终端，则对应小鱼体系的deviceId)

    all

    type

    设备类型

    all

    participantId

    当前会议的用户唯一标识，Android/iOS SDK入会后回调函数中的participantId

    all

    externalUserId

    集成sdk的app，在注册时传入的第三方用户ID

    all

    participantNumber

    对于用户为呼叫号码，对于硬件设备为终端号

    all

    handUpList

    举手列表------举手设备的列表，由一个或多个设备构成

    all

    recordingDevice

    开启录制的设备

    all

    contentDevice

    开启屏幕分享的设备

    all

    whiteBoardDevice

    开启白板的设备

    all

    forceMute

    是否强制静音 （true\\false）

    all

    locked

    会议是否锁定（true\\false）

    all

    superviseMode

    是否开启督导模式（true\\false）

    all

    unReceiveAudioDeviceList

    未闭音设备列表（只有在开启督导模式下才可能存在该列表）

    all

    hardDevice

    是否为硬件设备（true\\false）（弃用的属性值）

    all

    softDevice

    是否为app设备（true\\false）（弃用的属性值）

    all

    deskDevice

    是否为桌面端设备（true\\false）（弃用的属性值）

    all

    dialogueMode

    是否开启对话模式（true\\false）

    分区云20241018

    focusMode

    是否开启焦点模式（true\\false）

    分区云20241018

    waitingRoom

    是否开启等候室（true\\false）

    分区云20241018

    multiImageBroadcastDevice

    多画面广播设备

    分区云20241108（20241018hotfix）

    事件回调

    触发条件

    1. 参会人加入会议，触发ConferenceRosterInfo事件回调。
    2. 参会人一直在会中，每隔一分钟会定时发一次ConferenceRosterInfo事件回调。
    2024-10-23 15:14:43
    导出PDF文档
    意见反馈