API版本更新记录
在使用API请求的时候,请求地址必须带上API版本号。本指南的API示例中,API版本号均使用{api version}变量替代。
API 简介
API(Application Processing Interface)为S系列IPPBX 提供给第三方应用的调用接口,通过本接口,第三方应用可以处理PBX的电话,如接听来电,挂断通话等。
通信方式
S系列IPPBX与应用服务器通信有两种方式。
API Demo
朗视提供API demo软件,你可以通过API demo软件测试API接口。
启用 PBX 的 API 接口
配置API之前,先启用PBX的API接口功能。
删除黑名单中的API IP
某个IP在短时间内,多次尝试登陆API接口失败,PBX会将该IP拉入黑名单,并将该IP类型标记为“API-IP”。如果该IP为受信任的IP,你可以将这个IP从黑名单列表中删除。
API 接口示例
API接口配置示例。
API 验证
系统
分机
中继
IVR
队列
语音通话
播放语音
获取录音文件
通过本接口可获取PBX中的全局录音文件。
发送短信
通过GSM/3G/4G中继给外部号码发送短信。
酒店叫醒服务
酒店退房
通过本接口为酒店客人退房。
保存和应用配置
每次通过API接口配置PBX后,都要调用此接口,保存配置。
系统报告
PBX主动向第三方应用上报系统配置变更等事件。
系统启动报告
当PBX系统启动后,PBX会向应用服务器推送该报告。
配置变更报告
当PBX的配置发生变化时,PBX会向应用服务器发送配置变更报告,以便于应用服务器及时更新和同步PBX的相关配置。
分机状态变更报告
当分机状态发生变更时,PBX主动向应用服务器推送变更信息。
通话报告
PBX主动向第三方应用上报通话转移等事件。
响铃报告
当分机响铃时,PBX向应用服务器发送响铃报告。
回铃报告
通过 PBX 的外线通话或分机内部通话,PBX 会向第三方应用服务器推送回铃音事件报告。
‘通话应答’报告
当分机接听内部来电或外部来电时,PBX会向应用服务器发送“通话应答”报告。
‘通话被应答’报告
当分机呼出的通话被应答时,PBX会向应用服务器发送“通话被应答”报告。
‘通话结束’报告
当一路通话释放,即通话挂断时,PBX会向第三方应用服务器发送两个BYE报告。在第一个BYE报告中,先记录主动挂断电话的用户号码,后记录被挂断电话的用户号码。
‘呼叫转移’报告
当 PBX 分机用户转移通话时,PBX 向应用服务器发送 “呼叫转移” 报告。
‘呼叫失败’报告
当发起的呼叫失败时,PBX 会向应用服务器发送“呼叫失败”报告。
‘按键信息’报告
通话过程中,用户输入的按键信息。
‘通话记录’报告
当通话结束后,PBX 向应用服务器实时发送通话详细记录(CDR)。
‘来电呼叫请求’报告
在开启中继的 “来电接听控制” 的情况下,当来电通过该中继呼入时,PBX会向应用服务器推送 INVITE 事件。
‘来电呼入’报告
在开启中继的 “呼入目的地控制” 情况下,当来电通过该中继呼入时,在PBX应答该来电后,会向应用服务器推送INCOMING事件。
‘播放语音结束’报告
PBX 给分机号码或外线号码播放提示音结束后,会发送报告。
‘满意度调查结果’事件
进行满意度调查时,当收到用户的按键信息后,PBX 主动向应用服务器发送满意度调查的结果。
错误代码