获取入会链接
获取入会链接
1. 接口描述
接口名称:
/conference/launch/joinConference
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
Http Header
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | 接口调用鉴权参数 | 也可以放在http body中 |
Http Body
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
pcode | 是 | string | 会议密码 |
name | 否 | string | 姓名,可以为邮箱 |
new_name | 否 | string | 新姓名 |
conferenceId | 否 | string | 会议ID |
nick_name | 否 | string | 别名,替换入会者的名字(可以跟姓名一样) |
securityInfo | 否 | json string | 安全信息 |
securityInfo 参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
isSecurityLink | 否 | int | 是否需要安全连接, 1: 是, 0: 否, 默认为0 |
userId | 否 | int | 用户Id,当isSecurityLink=1,userId必填 |
timeout | 否 | int | 过期时间,单位分钟 默认5分钟 |
usableCount | 否 | int | 使用次数 默认6次 |
传参示例
{
"pcode":"201501000037383646",
"securityInfo":{
"isSecurityLink":1,
"timeout":1,
"usableCount":1,
"userId":87679779
}
}
3. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | string | 入会链接 |
返回示例
{
"status": 0,
"result": "http:\/\/mtest.qsh1.cn\/k\/NJPfc2GYR9k",
"msg": "conferenceserver-192.168.35.230-1599616466.259709136.932",
"request_id": "confopenapiserver-192.168.28.45-1599616466.156023296.887",
"timestamp": 1599616466156,
"callSeq": "",
"content_type": "application/json",
"request_duration": "497.316566ms"
}