云 PBX 提供 二次开发接口(API)。第三方服务器与 PBX 通过 API 对接,你可以在第三方服务器上查询和编辑 PBX 的设置、实现多种呼叫功能。PBX 还会主动发送系统报告和通话报告到第三方服务器。
使用云 PBX API 之前,你需要先启用 PBX 的 API 功能、了解云 PBX API 的通信方式、API 请求结构、响应消息和 API 报告。
查询当前外部来电的详细信息,如:主叫、被叫、通话状态、通过的中继等。
查询当前 IPPBX 系统分机通过外线呼出的所有通话的详细信息,如:主叫、被叫、通话状态、通过的中继、目的地等。
通过本接口可以让一个分机呼叫另一个分机,从而使两者能够建立通话。
通过本接口可以让分机向外线发起呼叫,从而使两者能够建立通话。(此接口只适用呼叫外线电话)。
通过本接口可以挂断指定分机的当前通话,返回挂断成功或失败的结果。
通过本接口可以指定挂断外线呼入到 PBX 系统的通话。
通过本接口可以指定挂断当前 IPPBX 系统分机通过外线呼出的通话。
通过本接口可将指定分机的当前通话保持。如需恢复通话,可使用通话接回接口。
通过本接口可将分机保持的通话重新恢复。
PBX 分机通话时,可利用该接口将分机静音。即分机的通话方不能听到分机的声音,而分机可以听到对方的声音。如需取消静音,请使用取消静音接口。通话结束后,分机也会自动取消静音。
通过被接口可将被静音的分机取消静音。
通过本接口可以实现一个分机监听另一个分机的当前通话。
通过本接口可让一个分机密语监听另一个分机的通话,即:监听方和被监听方两个分机之间可以互相通话,但是被监听分机的通话方不能和监听方通话。
通过本接口可让一个分机强制插入到另一个分机的通话中去,从而形成三方通话。
当 PBX 的分机正在通话时,可使用该接口将通话转移到其他号码,如分机、队列、响铃组、IVR、或外线号码。
通过该接口可以将外线的来电转移到其他号码,如分机、队列、响铃组、IVR、或外线号码。
通过本接口可将呼出到外线的电话转接给其他号码,如分机、IVR或外部号码。
通过 IVR 呼叫分机,向分机播放语音,如播放台风警报等语音。分机可根据 IVR 语音提示,执行相关的按键操作。
通过 IVR 拨打外线电话,向外部人员播放语音,如播放台风警报等语音。外部人员可根据 IVR 语音提示,执行相关的按键操作。
PBX 会自动拨打外线号码,当外线被接听后,PBX 会将这通电话转接到指定的队列。
PBX 会自动拨打外线号码,当外线被接听后,PBX 会将这通电话转接到指定的响铃组。
通过本接口可让 PBX 依次向外发起两路呼叫,并以 PBX 作为中间点建立连接,从而实现两个外部电话之间建立通话。
如果在 PBX 的 API 配置界面,启用了中继的 来电接听控制,系统将会预留10秒,让第三方服务器控制该中继的来电。
通过本接口可获取 PBX 中的全局录音文件。
下载指定分机或所有分机的通话记录。