根据预约id查询预约会议

功能说明

根据预约会议的id查询某个现有的预约会议的详细信息。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET https://sdk.xylink.com/api/rest/external/{version}/conference/reminder/query?enterpriseId=XXX&reminderId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
reminderId	String	Query	是	无	预约会议id

示例代码

返回结果示例：

{
    "title": "txdev测试--请忽略",
    "startTime": 1691749809834,
    "endTime": 1691753409836,
    "participants": [
        {
            "type": "account",
            "value": "18712341212"
        },
        {
            "type": "externalUserId",
            "value": "sdk-user-txdev-01"
        },
        {
            "type": "email",
            "value": "jkl@xylink.com"
        },
        {
            "type": "deviceNumber",
            "value": "114148"
        },
        {
            "type": "callNumber",
            "value": "18716788761"
        },
        {
            "type": "h323Number",
            "value": "192.168.100.100"
        }
    ],
    "meetingHost": [
        {
            "type": "account",
            "value": "18712341212"
        }
    ],
    "address": "address--test",
    "details": "details--test",
    "autoInvite": 1,
    "password": "123456",
    "controlPassword": "456789",
    "callLimit": true,
    "meetingRoomNumber": "910004370833",
    "autoRecord": 0,
    "mainImage": null,
    "recordViewLayout": {
        "mainLayout": {
            "layout": {
                "screen": "landscape",
                "people": {
                    "maxCells": 1,
                    "view": "symTiling",
                    "mode": "auto",
                    "specified": [
                        {
                            "type": "account",
                            "value": "18712341212"
                        }
                    ]
                },
                "content": {
                    "prefer": false,
                    "view": "symTiling",
                    "mode": "auto"
                }
            },
            "osd": {
                "nameplate": {
                    "enabled": true
                }
            },
            "OSD": {
                "nameplate": {
                    "enabled": true
                }
            }
        },
        "extrasLayout": null
    },
    "enableOffLineRecord": 0,
    "offlineTranscodePriority": null,
    "lineRateMin": null,
    "lineRateMax": null,
    "meetingSponsor": {
        "type": "account",
        "value": "18712341212"
    },
    "reminderId": "962886fe89ce3b880189e380d959058e",
    "week": 6,
    "owner": 102571794,
    "createTime": 1691739019609,
    "updateTime": 1691739019609
}

返回参数说明

Key	说明
reminderId	会议id
startTime	会议开始时间，Unix毫秒时间戳
endTime	会议结束时间，Unix毫秒时间戳
title	会议标题
address	会议地址
details	会议描述
owner	会议创建人,企业管理员用户id
autoInvite	开会时，是否自动呼叫小鱼终端入会。默认为0，不自动；为1，自动。
meetingRoomNumber	虚拟云会议号
createTime	会议创建时间，Unix时间戳（毫秒数）
updateTime	会议修改时间，Unix时间戳（毫秒数），默认等于会议创建时间
password	会议密码
participants	参加会议的终端号集合，可选参数
week	每周的第几天（周日 -> 周一 ->周二 -> 周三 -> 周四 -> 周五 -> 周六）
meetingRoomType	会议类型，1 随机自动生成,2 指定云会议室号
autoRecord	自动录制，0 不自动录制，1 自动录制
mainImage	主画面可选参数
└mainLayout	会议主录制布局
└extrasLayout	会议多路录制布局
└└screen	横竖屏类型
└└maxCells	最大窗口数
└└specified	指定的画面终端列表
└└view	布局类型
└└mode	布局模式
└└prefer	指示是否content（第一分屏）幕显示
└└nameplate>enabled	是否叠加终端名称
meetingHost	会议主持人(预约会议的时候设置)
enableOffLineRecord	是否启用离线录制
offlineTranscodePriority	离线转码优先级（high，normal）
lineRateMin	云会议室会议速率选项，最低带宽
lineRateMax	云会议室会议速率选项，最高带宽
meetingSponsor	会议预约人

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

2024-03-29 22:32:07

导出PDF文档