API 接口&事件概览
本文提供千量级 IPPBX API 接口列表和推送事件列表。
API 认证
| API Endpoint | 描述 |
|---|---|
| login | 获取 API 调用凭证 token。 |
| token/refresh | 刷新 API 调用凭证 token。 |
| heartbeat | 延长 API 调用凭证 token 时效。 |
系统
| API Endpoint | 描述 |
|---|---|
| deviceinfo/query | 查询 PBX 信息。 |
| logout | 断开 API 连接。 |
通讯录接口
| API Endpoint | 描述 |
|---|---|
| companycontacts/query | 查询单个企业联系人、多个企业联系人或所有企业联系人的信息。 |
| companycontacts/add | 添加企业联系人。 |
| companycontacts/update | 修改企业联系人信息。 |
| companycontacts/delete | 删除企业联系人。 |
分机接口
| API Endpoint | 描述 |
|---|---|
| extension/list | 查询分机列表。 |
| extension/query | 查询单个分机、多个分机或所有分机的详细配置。 |
| extension/query_call | 查询单个分机、多个分机或所有分机的通话状态。 |
| extension/add | 添加分机。 |
| extension/update | 修改分机设置。 |
| extension/delete | 删除分机。 |
分机组接口
| API Endpoint | 描述 |
|---|---|
| extensiongroup/query | 查询单个分机组、多个分机组或所有分机组的详细配置。 |
| extensiongroup/add | 添加分机组。 |
| extensiongroup/update | 修改分机组配置。 |
| extensiongroup/delete | 删除分机组。 |
中继接口
| API Endpoint | 描述 |
|---|---|
| trunk/list | 查询中继列表。 |
| trunk/query_siptrunk | 查询单个 SIP 中继、多个 SIP 中继或所有 SIP 中继的详细配置。 |
| trunk/add_siptrunk | 添加 SIP 中继。 |
| trunk/update_siptrunk | 修改 SIP 中继配置。 |
| trunk/delete_siptrunk | 删除 SIP 中继。 |
呼入路由接口
| API Endpoint | 描述 |
|---|---|
| inroute/query | 查询单个呼入路由、多个呼入路由或所有呼入路由的详细配置。 |
| inroute/add | 添加呼入路由。 |
| inroute/update | 修改呼入路由配置。 |
| inroute/delete | 删除呼入路由。 |
呼出路由接口
| API Endpoint | 描述 |
|---|---|
| outroute/query | 查询单个呼出路由、多个呼出路由或所有呼出路由的详细配置。 |
| outroute/add | 添加呼出路由。 |
| outroute/update | 修改呼出路由配置。 |
| outroute/delete | 删除呼出路由。 |
IVR 接口
| API Endpoint | 描述 |
|---|---|
| ivr/query | 查询单个 IVR、多个 IVR 或所有 IVR 的详细配置。 |
| ivr/update | 修改 IVR 配置。 |
队列接口
| API Endpoint | 描述 |
|---|---|
| queue/query | 查询单个队列、多个队列或所有队列的详细配置。 |
| queue/update | 修改队列配置。 |
| queue/query_status | 查询队列坐席状态。 |
| queue/add_dynamicagent | 动态坐席签入队列。 |
| queue/delete_dynamicagent | 动态坐席签出队列。 |
| queue/pause_agent | 暂停坐席服务。 |
| queue/unpause_agent | 恢复坐席服务。 |
会议室接口
| API Endpoint | 描述 |
|---|---|
| conference/query | 查询固定会议室详情。 |
| instant_conference/query | 查询临时会议室详情。 |
| conference/query_in_session | 查询会话中的会议室详情。 |
| instant_conference/start | 添加临时会议室。 |
| conference/update | 修改固定会议室配置。 |
| conference/add_member | 邀请会议室成员。 |
| conference/kick_member | 踢除与会人员。 |
| conference/mute_member | 对与会成员进行静音。 |
| conference/unmute_member | 对与会成员进行静音解除。 |
广播组接口
| API Endpoint | 描述 |
|---|---|
| paginggrouplist/query | 查询广播组列表。 |
| paginggroup/query | 查询单个广播组、多个广播组或所有广播组的详细配置。 |
| paginggroup/add | 添加广播组。 |
| paginggroup/update | 修改广播组配置。 |
| paginggroup/delete | 删除广播组。 |
语音留言接口
| API Endpoint | 描述 |
|---|---|
| voicemail/query | 查询单个分机、多个分机或所有分机的语音留言。 |
| voicemail/delete | 删除分机的语音留言。 |
| voicemail/get_random | 获取语音留言下载随机串。 |
通话记录和录音接口
| API Endpoint | 描述 |
|---|---|
| recording/get_random | 获取录音下载随机串。 |
| cdr/get_random | 获取通话记录下载随机串。 |
酒店应用接口
| API Endpoint | 描述 |
|---|---|
| wakeupcall/create | 添加酒店叫醒闹铃。 |
| wakeupcall/query | 查询酒店叫醒闹铃。 |
| wakeupcall/update | 修改酒店叫醒闹铃。 |
| wakeupcall/delete | 删除酒店叫醒闹铃。 |
呼叫操控接口
| API Endpoint | 描述 |
|---|---|
| call/query | 查询指定通话或指定类型的通话。 |
| call/dial | 发起呼叫。 |
| call/accept_inbound | 在呼入来电控制阶段，接听来电。 |
| call/refuse_inbound | 在呼入来电控制阶段，拒接来电。 |
| call/listen | 监听通话。 |
| call/hold | 保持通话。 |
| call/unhold | 恢复通话。 |
| call/mute | 通话静音。 |
| call/unmute | 取消通话静音。 |
| call/callpark | 停泊通话。 |
| call/callpark_status | 查询通话停泊状态。 |
| call/transfer | 呼叫转移（盲转）。 |
| call/attended_transfer | 呼叫转移（咨询转）。 |
| call/add_member | 通话过程中，邀请新成员加入通话。 |
| call/playprompt | 播放语音文件。 |
| paginggroup/hangup/music | 挂断广播语音。 |
uaCSTA 呼叫操控接口
| API Endpoint | 描述 |
|---|---|
| uacstacall/accept_inbound | 通过 uaCSTA 接听来电。 |
| uacstacall/refuse_inbound | 通过 uaCSTA 拒接来电。 |
| uacstacall/hangup | 通过 uaCSTA 挂断通话。 |
事件报告类型
| 事件 | 描述 |
|---|---|
| BootUp | 系统启动事件。 |
| ConfigChange | 配置变更事件。 |
| Invite | 启用来电接听控制后，当有外部来电时，PBX 向应用服务器推送 Invite 事件，并预留 10 秒时间，让应用服务器选择接听或拒接来电。 |
| Incoming | 启用来电接听控制后，当 PBX 接受外部来电时，PBX 向应用服务器推送 Incoming 事件，并预留 10 秒时间，让应用服务器选择来电目的地。 注： 应用服务器使用 call/transfer 接口来控制来电目的地。
|
| ExtensionStatus | 分机状态变更事件。 |
| CallStatus | 通话状态变更事件。 |
| NewCdr | 新的通话记录事件。 |
| CallTransfer | 呼叫转移事件。 |
| CallForward | 呼叫前转事件。 |
| CallFailed | 呼叫失败事件。 |
| DTMF | 按键信息事件。 |
| PlayPromptEnd | 语音播放结束事件。 |
| satisfaction | 满意度评价事件。 |
| sms-send | 语音发送状态事件。 |
| ConferenceStatus | 与会成员变更事件。 |
| uacstacall | uaCSTA 通话事件。 |