API 接口概览

S系列IPPBX 提供 二次开发接口(API)。第三方服务器与 PBX 通过 API 对接,你可以在第三方服务器上查询和编辑 PBX 的设置、实现多种呼叫功能。PBX 还会主动发送系统报告和通话报告到第三方服务器。

PBX 版本要求

朗视 S50、S100、S300:固件版本30.5.0.30或更高版本

系统接口

功能 Endpoint
查询 PBX 信息 /api/v1.1.0/deviceinfo/query?token={token}

分机

功能 Endpoint
查询分机列表 /api/v1.1.0/extensionlist/query?token={token}
查询分机设置 /api/v1.1.0/extension/query?token={token}
编辑分机设置 /api/v1.1.0/extension/update?token={token}

中继

功能 Endpoint
查询中继列表 /api/v1.1.0/trunklist/query?token={token}
查询 SIP 中继 /api/v1.1.0/siptrunk/query?token={token}
添加 SIP 中继 /api/v1.1.0/siptrunk/add?token={token}
编辑 SIP 中继 /api/v1.1.0/siptrunk/update?token={token}
删除 SIP 中继 /api/v1.1.0/siptrunk/delete?token={token}

呼入路由

功能 Endpoint
查询呼入路由 /api/v1.1.0/inroute/query?token={token}
添加呼入路由 /api/v1.1.0/inroute/add?token={token}
编辑呼入路由 /api/v1.1.0/inroute/update?token={token}
删除呼入路由 /api/v1.1.0/inroute/delete?token={token}

呼出路由

功能 Endpoint
查询呼出路由 /api/v1.1.0/outroute/query?token={token}
添加呼出路由 /api/v1.1.0/outroute/add?token={token}
编辑呼出路由 /api/v1.1.0/outroute/update?token={token}
删除呼出路由 /api/v1.1.0/outroute/delete?token={token}

IVR

功能 Endpoint
查询 IVR 设置 /api/v1.1.0/ivr/query?token={token}
编辑 IVR 设置 /api/v1.1.0/ivr/update?token={token}

队列

功能 Endpoint
查询队列设置 /api/v1.1.0/queue/query?token={token}
编辑队列设置 /api/v1.1.0/queue/update?token={token}
查询队列状态 /api/v1.1.0/queuestatus/query?token={token}
签入队列 /api/v1.1.0/queue/add_dynamicagent?token={token}
签出队列 /api/v1.1.0/queue/del_dynamicagent?token={token}
暂停坐席服务 /api/v1.1.0/queue/pause_agent?token={token}
恢复坐席服务 /api/v1.1.0/queue/unpause_agent?token={token}

广播组

功能 Endpoint
查询广播组列表 /api/v1.1.0/paginggrouplist/query?token={token}
查询广播组 /api/v1.1.0/paginggroup/query?token={token}
添加广播组 /api/v1.1.0/paginggroup/add?token={token}
编辑广播组 /api/v1.1.0/paginggroup/update?token={token}
删除广播组 /api/v1.1.0/paginggroup/delete?token={token}
发起广播 /api/v1.1.0/extension/dial_number?token={token}
挂断广播音乐 /api/v1.1.0/paginggroup/hangup_music?token={token}

呼叫功能

功能 Endpoint
查询来电 /api/v1.1.0/inbound/query?token={token}
查询去电 /api/v1.1.0/outbound/query?token={token}
分机互拨 /api/v1.1.0/extension/dial_extension?token={token}
拨打外线号码 /api/v1.1.0/extension/dial_outbound?token={token}
挂断分机(强拆) /api/v1.1.0/extension/hangup?token={token}
挂断来电(强拆) /api/v1.1.0/inbound/hangup?token={token}
挂断去电(强拆) /api/v1.1.0/outbound/hangup?token={token}
通话保持 /api/v1.1.0/extension/hold?token={token}
恢复通话 /api/v1.1.0/extension/unhold?token={token}
通话静音 /api/v1.1.0/extension/mute?token={token}
取消静音 /api/v1.1.0/extension/unmute?token={token}
普通监听 /api/v1.1.0/extension/listen?token={token}
密语监听 /api/v1.1.0/extension/whisper?token={token}
强插监听 /api/v1.1.0/extension/barge?token={token}
通话转接 /api/v1.1.0/calltransfer?token={token}
外线来电转接 /api/v1.1.0/inbound/transfer_number?token={token}
外线去电转接 /api/v1.1.0/outbound/transfer_number?token={token}
通过 IVR 拨打分机 /api/v1.1.0/ivr/dial_extension?token={token}
通过 IVR 拨打外线 /api/v1.1.0/ivr/dial_outbound?token={token}
自动拨号(队列) /api/v1.1.0/queue/dial_outbound?token={token}
自动拨号(响铃组) /api/v1.1.0/ringgroup/dial_outbound?token={token}
双向外呼 /api/v1.1.0/outbound/dial_outbound?token={token}
接听来电 /api/v1.1.0/inbound/accept?token={token}
拒接来电 /api/v1.1.0/inbound/refuse?token={token}
发送短信 /api/v1.1.0/sms/send?token={token}

播放语音

功能 Endpoint
给分机播放语音 /api/v1.1.0/extension/playprompt?token={token}
给外线播放语音 /api/v1.1.0/outbound/playprompt?token={token}

语音留言

功能 Endpoint
查询语音留言 /api/v1.1.0/voicemail/query?token={token}
删除语音留言 /api/v1.1.0/voicemail/delete?token={token}
下载语音留言 /api/v1.1.0/voicemail/get_random?token={token}

通话记录和录音

功能 Endpoint
下载录音文件 /api/v1.1.0/recording/get_random?token={token}
下载通话记录 /api/v1.1.0/cdr/get_random?token={token}

酒店相关

功能 Endpoint
添加闹铃 /api/v1.1.0/wakeupcall/create?token={token}
查询闹铃 /api/v1.1.0/wakeupcall/query?token={token}
更改闹铃设置 /api/v1.1.0/wakeupcall/update?token={token}
删除闹铃 /api/v1.1.0/wakeupcall/delete?token={token}
酒店退房 POST /api/v1.1.0/hotel/checkout?token={token}

API 报告