opensaucesystems / simwoodapi
一种简单面向对象的与simwood.com API交互的方法
v0.3.0
2021-03-05 11:18 UTC
Requires
- php: ^7.4.3
- nategood/httpful: ^0.3.2
Requires (Dev)
- pestphp/pest: ^1.0
- vimeo/psalm: ^4.6
README
这个php composer包提供了一种简单面向对象的方式来与simwood.com API交互。
安装
通过Composer
composer require opensaucesystems/lxd
用法
初始化API客户端类
$simwood = new \Opensaucesystems\Simwood\SimwoodClient(
'APIUSER', //<-- get from simwood
'APIKEY' //<-- get from simwood
);
我选择不在类构造函数中包含$account_id,因此如果需要,必须在每次方法调用时传递它,这是因为API有多个账户层级。
与API交互就像调用类方法或属性一样简单,当遍历到端点时,端点会动态加载。
文档
查看以下文档以获取每个端点的详细信息。
[ ] Todo
[-] Partially done
[X] Done
[!] Broken
[X] 工具
- [X] [我的IP](./docs/Tools/My%20IP.md)
- [X] [时间](./docs/Tools/Time.md)
[X] 账户
- [X] 信用
- [X] [发票](./docs/Account/Credit/Invoices.md)
- [X] 全部
- [X] 未支付
- [X] 已支付
- [X] PDF
- [X] [发票](./docs/Account/Credit/Invoices.md)
- [X] 预付
- [X] [余额](./docs/Account/Prepay/Balance.md)
- [X] [低余额警报](./docs/Account/Prepay/Low%20Balance%20Alerts.md)
- [X] [锁定](./docs/Account/Prepay/Locking.md)
- [X] [摘要](./docs/Account/Prepay/Summary.md)
- [X] [预付款](./docs/Account/Prepay/Pre-payments.md)
- [X] 全部
- [X] 最新
- [X] [转账](./docs/Account/Prepay/Transfers.md)
- [X] 全部
- [X] 最新
- [X] 费率
- [X] [拆分](./docs/Account/Rates/Breakouts.md)
- [X] 日期
- [X] 未来
- [X] [代码](./docs/Account/Rates/Codes.md)
- [X] 日期
- [X] 未来
- [X] [CSV](./docs/Account/Rates/CSV.md)
- [X] [查找](./docs/Account/Rates/Lookup.md)
- [X] [拆分](./docs/Account/Rates/Breakouts.md)
- [X] 报告
- [X] 语音
- [X] [摘要](./docs/Account/Reports/Voice/Summary.md)
- [X] [CDR](./docs/Account/Reports/Voice/CDR.md)
- [X] 日
- [X] 最新
- [X] SMS
- [X] [CDR](./docs/Account/Reports/SMS/CDR.md)
- [X] 日
- [X] 最新
- [X] [CDR](./docs/Account/Reports/SMS/CDR.md)
- [X] 管理员
- [X] [CDR](./docs/Account/Reports/Admin/CDR.md)
- [X] 日
- [X] [CDR](./docs/Account/Reports/Admin/CDR.md)
- [X] 语音
- [X] [摘要](./docs/Account/Summary.md)
- [X] 入
- [X] 出
- [X] 按destid
- [X] 按iso
- [X] 按codec
- [X] 按tag
- [X] 按trunk
- [X] [通知](./docs/Account/Notifications.md)
- [X] 可用
- [X] 类型
- [X] 方法
- [X] Hash
- [X] 历史
- [X] 信用
[-] 语音
- [X] [限制](./docs/Voice/Limits.md)
- [X] [通道](./docs/Voice/Channels.md)
- [X] [当前](./docs/Voice/Channels.md)
- [X] [历史](./docs/Voice/History.md)
- [X] [进行中](./docs/Voice/In-progress.md)
- [ ] 出站 - 中继管理
- [ ] 出站 - 余额
- [ ] 出站 - 进行中
- [ ] 出站 - ACL
- [ ] 出站 - ACL/IP
- [ ] 出站 - 密码重置
- [ ] 目的地ACL
- [ ] IDA
[X] [内联CDR](./docs/Inline%20CDR.md)
- [X] CDR
- [X] {YYYY-MM-DD}
- [X] {YYYY-MM-DD}/{REFERENCE}
- [X] CDR
[-] 号码
- [X] [范围](./docs/Numbers/Ranges.md)
- [X] [可用](./docs/Numbers/Available.md)
- [X] [连续](./docs/Numbers/Consecutive.md)
- [X] [已分配](./docs/Numbers/Allocated.md)
- [X] 全部
- [X] 10|100|100|1000
- [-] 号码
- [X] [配置](./docs/Numbers/Number/Config.md)
- [ ] SMS
- [X] [999](./docs/Numbers/Number/999.md)
- [X] [默认配置](./docs/Numbers/Number/Default%20Config.md)
- [X] [管理](./docs/browse/Numbers/Number/Manage.md)
- [X] 信息
- [X] 分配
- [X] 删除/去配置
[ ] 移植
- [ ] 端口
[ ] 传真
- [ ] 入站
- [ ] 散列
[ ] 消息
- [ ] SMS
- [ ] 传真
[X] [异步报告文件](./docs/Files.md)