PBX API 网页设置

二次开发接口- 基本设置

使用 API 功能，你必须启用 API 并做好基本设置。

登录 PBX 网页，进入配置 > PBX > 常规设置 > 二次开发接口，启用并更改 API 基本设置。

启用：是否启用 API 功能。
报告发送方法：选择发送事件报告的方式。关于两种事件报告发送形式的说明，请参见API 事件推送。
- HTTP：PBX 采用 TCP 短连接的方式发送 HTTP 事件报告。
- TCP：PBX 采用 TCP 长连接的方式发送 TCP 事件报告。
用户名：填写自定义的用户名。
密码：填写自定义的密码。
注：此处的用户名和密码是应用服务器对接到 PBX 时要用到的用户名及密码。
- 请求获取 API token 带的 password 参数为MD5 加密后的32位小写字符串。
- 发送 TCP login 数据包带的 password 参数为此处填写的明文密码。

如果你需要在应用服务器监控分机和外线的状态或操控外线来电，你需要在高级设置里开启相应的开关。

登录 PBX 网页，进入配置 > PBX > 常规设置 > 二次开发接口，更改 API 高级设置。

分机: 选择是否监控分机的状态。; 当该分机状态有变更时（如：分机状态从忙变为空闲），PBX 会主动向应用服务器发送ExtensionStatus (分机状态变更事件)。

中继

选择是否控制中继的来电、是否监控中继的通话状态。

来电接听控制：勾选来电接听控制之后，当外线来电通过该中继呼入时，PBX 将发送Invite（来电呼叫请求）到应用服务器，并预留 10 秒时间让应用服务选择接受或拒绝来电。

注：如果应用服务器没有在 10 秒内作出操作，PBX 将接受该来电，并将该来电引导到呼入路由的目的地。
- 接受：应用服务器调用 call/accept_inbound 来接受来电。
  
  来电会进入对应呼入路由目的地。
- 拒绝：应用服务器调用 call/refuse_inbound 来拒绝来电。
  
  来电会被挂断，且不会到达 PBX。PBX 不会生成相关的通话记录。
呼入目的地控制：勾选呼入目的地控制后，当外线来电通过该中继呼入且已被 PBX 接受时，PBX 将发送Incoming（来电呼入）到应用服务器，且预留 10 秒时间让应用服务器操控该来电的目的地。
注：
- 应用服务器调用 call/transfer 来操控来电的目的地。
- 如果应用服务器没有在 10 秒内作出操作，PBX 会将来电引导到呼入路由的目的地。
状态监控：勾选中继的状态监控后，PBX 会发送该中继的CallStatus（通话状态变更事件）到应用服务器。

如果某个 IP 在短时间内，多次尝试登陆 API 接口失败，PBX 会将该 IP 拉入禁止名单，并将该 IP 类型标记为“API-IP”。如果该 IP 为受信任的 IP，你可以将这个 IP 从禁止名单列表中删除。