API 接口 & 事件概览

本文提供 Yeastar P 系列 IPPBX API 接口列表和推送事件列表。

API 认证

1.
API endpoint 说明
get_token 获取 API 访问 token。
refresh_token 刷新 API 访问 token。
del_token 撤销 API 访问 token。

系统

2.
API endpoint 说明
system/information 查询 PBX 信息。
system/capacity 查询 PBX 容量,包括分机数和通话并发数。
system/get_menuoptions 在创建或更新功能时查询所需的菜单选项信息。
注: 此接口支持查询特定功能的选项信息 (ID、名称或类型),支持的功能包括 FXS 端口、分机、分机组、组织架构/部门、中继、用户角色、企业联系人群组、群语音邮箱、IVR、响铃组、队列和队列坐席、会议室以及 PIN 码列表。

分机

3.
API endpoint 说明
extension/list 查询分机列表。
extension/search 搜索特定分机。
extension/get 查询单个分机信息。
extension/query 查询多个分机信息。
extension/create 添加分机。
extension/send_welcome_email 发送 Linkus 欢迎邮件给指定分机。
extension/update 编辑分机。
extension/delete 删除分机。

组织架构/部门

4.
API endpoint 说明
organization/list 查询部门列表。
organization/search 搜索特定部门。
organization/get 查询单个部门信息。
organization/query 查询多个部门信息。
organization/create 添加部门。
organization/update 编辑部门。
organization/delete 删除部门。

中继

5.
API endpoint 说明
trunk/list 查询中继列表。
trunk/search 搜索特定中继。
trunk/get 查询单个中继的信息。
trunk/query 查询多个中继的信息。
trunk/itsp_list 查询 SIP 中继的 SIP 运营商列表。
trunk/create 添加 SIP 中继。
trunk/update 编辑 SIP 中继。
trunk/delete 删除 SIP 中继。

通讯录

6.
API endpoint 说明
company_contact/list 查询企业联系人列表。
company_contact/search 搜索特定企业联系人。
company_contact/get 查询单个企业联系人信息。
company_contact/query 查询多个企业联系人信息。
company_contact/create 添加企业联系人。
company_contact/update 编辑企业联系人。
company_contact/delete 删除企业联系人。

企业联系人群组

7.
API endpoint 说明
phonebook/list 查询企业联系人群组列表。
phonebook/search 搜索特定企业联系人群组。
phonebook/get 查询单个企业联系人群组信息。
phonebook/query 查询多个企业联系人群组信息。
phonebook/create 添加企业联系人群组。
phonebook/update 编辑企业联系人群组。
phonebook/delete 删除企业联系人群组。

呼入路由

8.
API endpoint 说明
inbound_route/list 查询呼入路由列表。
inbound_route/search 搜索特定呼入路由。
inbound_route/get 查询单个呼入路由信息。
inbound_route/query 查询多个呼入路由信息。
inbound_route/create 添加呼入路由。
inbound_route/update 编辑呼入路由。
inbound_route/delete 删除呼入路由。

呼出路由

9.
API endpoint 说明
outbound_route/list 查询呼出路由列表。
outbound_route/search 搜索特定呼出路由。
outbound_route/get 查询单个呼出路由信息。
outbound_route/query 查询多个呼出路由信息。
outbound_route/create 添加呼出路由。
outbound_route/update 编辑呼出路由。
outbound_route/delete 删除呼出路由。

录音

10.
API endpoint 说明
recording/list 查询录音列表。
recording/download 获取录音文件下载 URL,用于下载录音文件。

通话记录 (CDR)

11.
API endpoint 说明
cdr/list 获取通话记录列表。
cdr/search 搜索特定通话记录。
cdr/download 获取通话记录下载 URL,用于下载通话记录文件。

通话报告

12.
API endpoint 说明
call_report/list 查询即时通话报告列表。
call_report/download 获取下载 URL,用于下载即时通话报告。
call_schedule_report/list 查询预约通话报告列表。
call_schedule_report/download 获取下载 URL,用于下载预约通话报告。

呼叫操控接口

13.
API endpoint 说明
call/query 查询指定通话或指定类型的通话。
call/dial 发起呼叫。
call/accept_inbound 在呼入来电控制阶段,接听来电。
call/refuse_inbound 在呼入来电控制阶段,拒接来电。
call/listen 监听通话。
call/hold 保持通话。
call/unhold 恢复被保持的通话。
call/mute 通话静音。
call/unmute 取消通话静音。
call/park 停泊通话。
call/park_status 查询被停泊通话的信息。
call/transfer 呼叫转移,包括盲转和咨询转。
call/add_member 通话过程中,邀请新成员加入通话。
call/play_prompt 播放自定义提示音中的语音文件。
call/hangup 挂断通话。
call/record_start 开始通话录音。
call/record_pause 暂停通话录音。
call/record_unpause 恢复通话录音。

uaCSTA 呼叫操控接口

14.
API endpoint 说明
uacsta_call/accept 通过 uaCSTA 接听来电。
uacsta_call/refuse 通过 uaCSTA 拒接来电。
uacsta_call/hangup 通过 uaCSTA 挂断通话。

事件报告

15.
事件 说明
(30005) 组织架构/部门状态变更 表示组织架构/部门功能状态发生变更,并告知当前状态。
(30006) 组织架构/部门配置变更 表示组织架构/部门功能配置发生变更,并告知变更信息。
(30007) 分机注册状态变更 表示分机注册状态发生变更,并告知当前注册信息。
(30008) 分机通话状态变更 表示分机通话状态发生变更,并告知当前分机通话状态。
(30009) 分机出席状态变更 表示分机出席状态发生变更,并告知当前分机出席状态。
(30010) 中继注册状态变更 表示中继注册状态发生变更,并告知中继状态。
(30011) 通话状态变更 表示通话状态发生变更,并告知当前通话状态。
(30012) 新通话记录 表示生成新的通话记录,并告知通话信息详情。
(30013) 呼叫转移 表示发生呼叫转移事件,并告知通话信息详情。
(30014) 呼叫前转 表示发生呼叫前转事件,并告知通话信息详情。
(30015) 呼叫失败 表示发生呼叫失败事件,并告知通话信息详情。
(30016) 来电呼叫请求 表示监控的中继上有外线呼入,并告知通话信息详情。
(30017) DTMF 按键信息 表示通话过程中有按键事件,并告知通话信息和按键详情。
(30018) 语音播放结束 表示语音播放结束,并告知通话信息详情和播放的语音文件名。
(30019) 满意度调查 表示来电者完成满意度调查,并告知满意度调查结果。
(30020) uaCSTA 通话事件 表示注册在 IP 话机上的分机的通话状态发生变更,并告知详细的 uaCSTA 通话信息。
(30022) 分机配置变更 表示分机配置发生变更,并告知变更详情。
(30023) 中继配置变更 表示中继配置发生变更,并告知变更详情。