查询固定会议室

查询 PBX 网页已创建的会议室配置详情。支持查询单个、多个或所有会议室。

请求地址

{base_url}/{api_path}/conference/query?token={token}

请求参数

参数 是否必选 类型 说明
number String 固定会议室号码。

取值范围

  • 单个会议室号码:查询指定会议室。

    例如:"number":"6400"

  • 多个会议室号码:查询多个固定会议室。多个会议室号码用半角逗号(,)隔开。

    例如:"number":"6400,6401"

  • all:查询所有固定会议室。

响应参数

参数 类型 说明
status String 请求结果。
  • Success:成功。
  • Failed:失败。
conferences Array <ConferenceInfo> 会议室信息列表。
ConferenceInfo
参数 类型 说明
number String 会议室号码。
name String 会议室名称。
participantepassword String 与会者密码。
moderatorpassword String 主持人密码。
waitformoderator String 是否等候主持人进入后才开始会议。
  • yes:是。
  • no:否。
allowinvite String 是否允许与会者邀请其他成员。
  • yes:是。
  • no:否。
moderators Integer 会议室主持人。
musiconhold String 是否启用等待音乐。
  • yes:是。
  • no:否。
mute String 是否在会议室普通成员进入会议室时静音成员。
  • yes:是。
  • no:否。
prompt String 成员进入、退出会议室的提示音。
  • default:默认。成员进入或退出会议室时,所有与会者会听到一声短“嘟”提示音。
  • exten:分机号码。成员进入或退出会议室时,所有与会者会听到主叫号码。
  • none:禁用。成员进入或退出会议时,所有与会者都不会听到任何提示音。

示例

请求示例

查询固定会议室6401的配置详情。

POST /api/v2.0.0/conference/query?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6401"
}

响应示例

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success", 
    "conferences": [
        {
            "number": "6401", 
            "name": "PM", 
            "participantepassword": "3201", 
            "moderatorpassword": "", 
            "waitformoderator": "no", 
            "allowinvite": "yes", 
            "moderators": "", 
            "musiconhold": "yes", 
            "mute": "no", 
            "prompt": "default"
        }
    ]
}