XSwitch入门

简介

XSwitch 是一个高度可定制的综合实时音视频多媒体通信平台。


XSwitch 支持电话、传真、视频会议、呼叫中心等。支持主流的通信协议如 SIP、H323、WebRTC、RTMP 等,可以作为 IP-PBX、视频会议服务器、传真服务器、多协议网关、呼叫中心服务器等使用。XSwitch 提供 REST、Websocket 二次开发接口。XSwitch 基于开源技术构建,如 FreeSWITCH、PostgreSQL、Nginx 等。

XSwitch 是模块化,积木式按需叠加和无限伸缩扩容的通信产品,更可以通过定制支持集群部署,实现更强大的功能。XSwitch 的位置、组件和逻辑关系如下图所示:

其中,SIP 话机通过 SIP 协议接入 XSwitch,管理员可以通过 Web 浏览器进行系统管理和维护,也可以通过 WebRTC 打电话,静态 Web 页面都由 Web 服务器提供,动态 API 请求会由 Web 服务器转发到 XSwitch 端进行处理。

约定

本手册内容和排版遵循以下约定:

  • 章节号或重要的内容会以粗体或黑体表示,有的地方可能有**“重要”**或“提示”字样。
  • 系统中会用到一些标志符,它们通常以等宽字体表示,如:context-1
  • 菜单或按钮顺序以下列形式给出:【一级菜单】⇨【二级菜单】⇨【按钮】。
  • 有些内容会有(TLDR)标志,即(Too Long Didn't Read),这些内容在快速阅读时可以先忽略。

系统中用到的字符串值(通常是名称字段的约束)遵循以下约定:

  • 表达式:大小写字母、数字及“-_.”,不能有其它字符,如“$/\;@%'"[]{}()”等
  • 任意字符串:任意合法的 UTF-8 字符串,不包含控制字符(ASCII 码为0~31的字符)

系统中使用的按钮和动作使用以下约定:

  • 新建/New:弹出新建对话框,可以新建一条记录,成功后显示在列表页第一行
  • 添加/Add:有时候,有的页面上,资源是存在的,但是需要添加到某个列表时,比“新建”语义更明确一些
  • 删除/Delete:删除一行或多行
  • 导入/Import:弹出导入框
  • 导出/Export:导出 Excel 或 CSV 文件
  • 刷新/Refresh:在不刷新整个页面的情况下刷新数据
  • 保存/Save:保存当前修改
  • 重载/Reload:将当前数据应用到运行时的程序中
  • 上传/Upload:上传文件
  • 下载/Download:下载相关资源
  • 快速删除模式/Fast Delete Mode:可快速删除多条数据,而不需要确认

系统中的对象,有以下一些通用的字段和属性:

  • ID/ID:唯一标志
  • 名称/Name:最大 20 个汉字 (目前,并不是所有的名称字段都允许输入空格和中文。具体命名规则见各对象的使用说明。)
  • 描述/Description:最大 250 个汉字
  • 创建时间/Created At
  • 更新时间/Updated At
  • 删除时间/Deleted At
  • 启用/Enabled
  • 状态/Status
欢迎