Tinyphone 开源项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00808/article/details/141540239

Tinyphone 开源项目使用教程

tinyphoneMinimalist Windows / OSx / Linux SIP Softphone with API Control项目地址:https://gitcode.com/gh_mirrors/ti/tinyphone

1. 项目的目录结构及介绍

Tinyphone 项目的目录结构如下：

tinyphone/
├── bin/
├── distribution/
│   └── docker/
├── lib/
│   └── pjproject/
├── tinyphone-installer/
├── tinyphone-linux/
├── tinyphone-osx/
├── tinyphone/
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── appveyor.yml
└── config.json

目录介绍

bin/: 存放编译后的二进制文件。
distribution/docker/: 存放 Docker 相关的文件。
lib/pjproject/: 存放 PJSIP 库的源代码。
tinyphone-installer/: 存放安装程序的相关文件。
tinyphone-linux/: 存放 Linux 平台的相关文件。
tinyphone-osx/: 存放 macOS 平台的相关文件。
tinyphone/: 存放项目的主要源代码。
.gitignore: Git 忽略文件。
.gitmodules: Git 子模块配置文件。
LICENSE: 项目许可证文件。
README.md: 项目说明文档。
appveyor.yml: AppVeyor 持续集成配置文件。
config.json: 项目配置文件。

2. 项目的启动文件介绍

Tinyphone 项目的启动文件是 tinyphone/Debug/tinyphone.exe。这个文件是编译后的可执行文件，用于启动 Tinyphone 软电话应用程序。

3. 项目的配置文件介绍

Tinyphone 项目的配置文件是 config.json。这个文件位于项目根目录下，包含了 Tinyphone 应用程序的配置信息。配置文件的内容如下：

{
  "api_port": 6060,
  "resources": {
    "/": "GET",
    "/events": "WS",
    "/login": "POST",
    "/logout": "POST",
    "/accounts": "GET",
    "/accounts/[account_name]/logout": "GET",
    "/dial": "POST",
    "/calls/[call_id]/hangup": "POST",
    "/hangup_all": "POST",
    "/exit": "POST"
  }
}

配置文件介绍

api_port: API 服务的端口号，默认为 6060。
resources: 定义了 API 的资源路径和对应的方法。
- /: 返回应用程序的版本信息。
- /events: WebSocket 端点，用于实时事件。
- /login: 账户登录接口。
- /logout: 账户登出接口。
- /accounts: 获取已注册账户列表。
- /accounts/[account_name]/logout: 指定账户的登出接口。
- /dial: 拨打电话接口。
- /calls/[call_id]/hangup: 挂断指定通话接口。
- /hangup_all: 挂断所有通话接口。
- /exit: 退出应用程序接口。