没有合适的资源？快使用搜索试试~ 我知道了~

文库首页行业研究行业报告如何启用API进行指令交互以及接收通话记录等PBX事件2.0

如何启用API进行指令交互以及接收通话记录等PBX事件2.0

需积分: 5 0 下载量 2 浏览量 2023-10-28 19:31:16 上传评论收藏 663KB PDF 举报

温馨提示

试读

15页

如何启用API进行指令交互以及接收通话记录等PBX事件2.0

资源推荐

资源详情

资源评论

一.帮助文档的获取：

1.API 在线说明：

S 系列 API: https://help.yeastar.com/zh-cn/s-series-developer-v2

云的 API：https://help.yeastar.com/zh-cn/s-series-developer-v2/api-v2/event-CallStatus.html

注意：云 PBX 的续活方式不一样，具体请查阅说明档

2.找代理或者星纵信息技术支持获取 PDF 说明档

二、PBX 启用 API 配置

启用 PBX 的 API 接口

在连接第三方应用服务器与 PBX 之前，你要先启用 PBX 的 API 接口，并做好相应的配置。

1. 登录 PBX 网页，进入配置→PBX→常规设置→二次开发接口。

2. 勾选启用。

3. 报告发送方法，默认使用 HTTP

4. 设置用户名和密码，点击保存和应用。

注: 此处的用户名和密码是第三方应用通过 API 连接到 IPPBX 时所要用到的用户名及密码。

5. 选择是否监控分机的状态。

当该分机状态有变更时（如：分机状态从忙变为空闲），API 会主动向第三方应用发送分机状态变更的事

件报告。

6. 选择是否开启中继状态监控。

7. 来电接听控制：勾选来电接听控制之后，当该条中继有来电时先交由第三方应用处理，第三方应用

可选择接受或者拒绝该来电。

a) 接受：如果第三方应用选择接受该来电，则该来电直接进入对应呼入路由目的地。

b) 拒绝：如果第三方应用选择拒绝该来电，则该来电将被直接挂断，而不会到达 PBX，PBX 上也

不会有该来电的通话记录。

PBX 将留有 10 秒给第三方应用处理的时间，超时则默认第三方应用接受该来电，进入对应呼入路由的目

的地。

8. 呼入目的地控制：勾选呼入目的地控制后，当该条中继有来电时将不会直接进入对应呼入路由的目

的

地，而是有 10 秒的时间等待第三方应用指定该通通话的目的地，如果 10 秒超时第三方应用未指定该通

话目的地，则默认进入对应呼入路由所设置的目的地。

注意：如果不需要这个呼入目的地控制，就不要开，否则每通呼入都会等 10 秒才进呼入路由

9. 状态监控：勾选中继的状态监控后，当该中继状态有变更时（如：中继状态从注册上变为注册失

败），API 会主动向第三方应用发送中继状态变更的事件报告。

10. 删除黑名单中的 API IP

某个 IP 在短时间内，多次尝试登陆 API 接口失败（比如密码多次错误），PBX 会将该 IP 拉入黑名

单，并将该 IP 类型标记为“API-IP”。如果该 IP 为受信任的 IP，你可以将这个 IP 从黑名单列表中删除。

进入 PBX→系统→安全中心→IP 自动防御→IP 黑名单

三.登录

1.访问端口

1）默认使用 https 访问，由于 PBX 默认开启 https 端口 8088，所以可以 login 请求发送至 https://ip

地址:8088

2）也可以使用 http 访问：

由于 S 系列默认有开启 80 端口重定向，所以如果要使用 http 可以把 login 请求发送到设备的 80 端口

默认如下图

注意：如果是远程访问的，国内的 80 口是无法开放的，需要提交备案信息，所以我们用其他端口（如下

图使用 8088，您也可以依据实际情况使用其他端口），这样改(示例使用 http 8088)：

2.S 系列 IPPBX API 采用用户名和密码的方式验证，只有用户名和密码验证通过的应用服务器，API 才会

处理其发送的请求。

注:

 你需要先将 API 的密码通过 MD5 加密（可以网络搜索在线 MD5 加密网站进行转换），获取 32 位

小写密码。使用加密过的密码进行 API 验证。

 如果密码连续错误五次，则该第三方应用的 IP 将会被锁 10 分钟。

请求地址（示例为 https）

https://{pbx ip}:{https port}/api/{api version}/login

注: 请求地址中的{api version}，必须在 API 版本号前加小写字母“v”，如：v2.0.0

请求参数

名称

是否必需

类型

描述

username

是

String

在 PBX ⼆次开发接⼝界⾯设置的⽤户名。

password

是

String

将 PBX⼆次开发接⼝界⾯设置的密码通过 MD5 加密。

填写加密后的 32 位小写密码。

port

是

String

端⼝号，此端⼝号为第三⽅应⽤⽤于监听 API 发送的事件报告的

端⼝号。（API 会主动向已经 login 了的第三方应用上报系统事

剩余14页未读，继续阅读

评论收藏

内容反馈

资源评论

资源反馈

评论星级较低，若资源使用遇到问题可联系上传者，3个工作日内问题未解决可申请退款~

xiaoli8748_软件开发

粉丝: 7122
资源: 1427

上传资源快速赚钱

我的内容管理展开

我的资源快来上传第一个资源

我的收益

登录查看自己的收益

我的积分登录查看自己的积分

我的C币登录后查看C币余额

我的收藏

我的下载

下载帮助

前往需求广场，查看用户热搜

如何启用API进行指令交互以及接收通话记录等PBX事件2.0

API进行指令交互以及接收通话记录等PBX事件

node-pbx-client:一个与Sipcentric PBX交互的Node.js客户端

企业级VoIP应用--从PBX迁移到IP-PBX

基于IP的终端设备与IP-PBX

松下pbx交换机介绍

PBX 框架源码演示

PBX电话交换机软件

语音交换机PBX入门

Avaya PBX Partition

PBX交换机常用命令

华为PBX配置指导书

pbx的数据库表设计（可实现回拨，飞线，电话卡等功能）

基于IP-PBX的VoIP系统解决方案

PBX培训资料.pptx

IP PBX培训材料（七）-网经IP PBX设备及操作介绍

pbx.rar_asterisk_pbx spo_pbx 源码

高科IP-PBX参数快速配置.doc

IP_PBX渠道售前培训-IP_PBX基础知识

asterisk ip pbx

相关实用应用程序（Windows可用）

免费可用的ChatGPT网页版.zip

ChatGPT使用总结：150个ChatGPT提示词模板（完整版）

chromedriver-win64.zip

李飞飞自传 我看见的世界 The World I see

全国计算机二级WPSoffice精选350道选择题题库（含答案）.pdf

哈尔滨工业大学-ChatGPT调研报告-2023.3.6-94页.pdf

农村公交与异构无人机协同配送优化

4个亲测好用的ChatGPT4渠道

学术海报模板+论文科研+研究生

最新资源

李飞飞自传我看见的世界 The World I see